CreateLocationObjectStorageCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, CreateLocationObjectStorageCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, CreateLocationObjectStorageCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // CreateLocationObjectStorageRequest
  ServerHostname: "STRING_VALUE", // required
  ServerPort: Number("int"),
  ServerProtocol: "HTTPS" || "HTTP",
  Subdirectory: "STRING_VALUE",
  BucketName: "STRING_VALUE", // required
  AccessKey: "STRING_VALUE",
  SecretKey: "STRING_VALUE",
  AgentArns: [ // AgentArnList // required
    "STRING_VALUE",
  ],
  Tags: [ // InputTagList
    { // TagListEntry
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE",
    },
  ],
  ServerCertificate: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
};
const command = new CreateLocationObjectStorageCommand(input);
const response = await client.send(command);
// { // CreateLocationObjectStorageResponse
//   LocationArn: "STRING_VALUE",
// };

CreateLocationObjectStorageCommand Input

See CreateLocationObjectStorageCommandInput for more details

Parameter
Type
Description
AgentArns
Required
string[] | undefined

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

BucketName
Required
string | undefined

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

ServerHostname
Required
string | undefined

Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.

AccessKey
string | undefined

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

SecretKey
string | undefined

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

ServerCertificate
Uint8Array | undefined

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.

ServerPort
number | undefined

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

ServerProtocol
ObjectStorageServerProtocol | undefined

Specifies the protocol that your object storage server uses to communicate.

Subdirectory
string | undefined

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.

Tags
TagListEntry[] | undefined

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.

CreateLocationObjectStorageCommand Output

See CreateLocationObjectStorageCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LocationArn
string | undefined

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

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.