1.204.0

interface CfnLocationObjectStorageProps

LanguageType name
.NETAmazon.CDK.AWS.DataSync.CfnLocationObjectStorageProps
Javasoftware.amazon.awscdk.services.datasync.CfnLocationObjectStorageProps
Pythonaws_cdk.aws_datasync.CfnLocationObjectStorageProps
TypeScript @aws-cdk/aws-datasync » CfnLocationObjectStorageProps

Properties for defining a CfnLocationObjectStorage.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as datasync from '@aws-cdk/aws-datasync';
const cfnLocationObjectStorageProps: datasync.CfnLocationObjectStorageProps = {
  agentArns: ['agentArns'],

  // the properties below are optional
  accessKey: 'accessKey',
  bucketName: 'bucketName',
  secretKey: 'secretKey',
  serverCertificate: 'serverCertificate',
  serverHostname: 'serverHostname',
  serverPort: 123,
  serverProtocol: 'serverProtocol',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
agentArnsstring[]Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
accessKey?stringSpecifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
bucketName?stringSpecifies the name of the object storage bucket involved in the transfer.
secretKey?stringSpecifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
serverCertificate?stringSpecifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem ). The file you specify must include the following:.
serverHostname?stringSpecifies the domain name or IP address of the object storage server.
serverPort?numberSpecifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
serverProtocol?stringSpecifies the protocol that your object storage server uses to communicate.
subdirectory?stringSpecifies the object prefix for your object storage server.
tags?CfnTag[]Specifies the key-value pair that represents a tag that you want to add to the resource.

agentArns

Type: string[]

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

accessKey?

Type: string (optional)

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

bucketName?

Type: string (optional)

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

secretKey?

Type: string (optional)

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

serverCertificate?

Type: string (optional)

Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem ). The file you specify must include the following:.

  • The certificate of the signing certificate authority (CA)
  • Any intermediate certificates
  • base64 encoding
  • A .pem extension

The file can be up to 32768 bytes (before base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS .

serverHostname?

Type: string (optional)

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?

Type: number (optional)

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

serverProtocol?

Type: string (optional)

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

subdirectory?

Type: string (optional)

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?

Type: CfnTag[] (optional)

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.

← PreviousNext →