DataSync / Client / create_location_object_storage

create_location_object_storage

DataSync.Client.create_location_object_storage(**kwargs)

Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.

See also: AWS API Documentation

Request Syntax

response = client.create_location_object_storage(
    ServerHostname='string',
    ServerPort=123,
    ServerProtocol='HTTPS'|'HTTP',
    Subdirectory='string',
    BucketName='string',
    AccessKey='string',
    SecretKey='string',
    AgentArns=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ServerCertificate=b'bytes'
)

Parameters:

• ServerHostname (string) –

  [REQUIRED]

  Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

• ServerPort (integer) – Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

• ServerProtocol (string) – Specifies the protocol that your object storage server uses to communicate.

• Subdirectory (string) – Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

• BucketName (string) –

  [REQUIRED]

  Specifies the name of the object storage bucket involved in the transfer.

• AccessKey (string) – Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

• SecretKey (string) – Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

• AgentArns (list) –

  [REQUIRED]

  Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

  • (string) –

• Tags (list) –

  Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

  • (dict) –

    A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

    • Key (string) – [REQUIRED]

      The key for an Amazon Web Services resource tag.

    • Value (string) –

      The value for an Amazon Web Services resource tag.

• ServerCertificate (bytes) –

  Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

  The certificate chain might include:

  • The object storage system’s certificate

  • All intermediate certificates (if there are any)

  • The root certificate of the signing CA

  You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

  cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

  To use this parameter, configure ServerProtocol to HTTPS.

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

• (dict) –

  CreateLocationObjectStorageResponse

  • LocationArn (string) –

    Specifies the ARN of the object storage system location that you create.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException

• DataSync.Client.exceptions.InternalException