interface CfnLocationObjectStorageProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataSync.CfnLocationObjectStorageProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnLocationObjectStorageProps`
Java	`software.amazon.awscdk.services.datasync.CfnLocationObjectStorageProps`
Python	`aws_cdk.aws_datasync.CfnLocationObjectStorageProps`
TypeScript	`aws-cdk-lib` » `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 { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnLocationObjectStorageProps: datasync.CfnLocationObjectStorageProps = {
  accessKey: 'accessKey',
  agentArns: ['agentArns'],
  bucketName: 'bucketName',
  cmkSecretConfig: {
    kmsKeyArn: 'kmsKeyArn',
    secretArn: 'secretArn',
  },
  customSecretConfig: {
    secretAccessRoleArn: 'secretAccessRoleArn',
    secretArn: 'secretArn',
  },
  secretKey: 'secretKey',
  serverCertificate: 'serverCertificate',
  serverHostname: 'serverHostname',
  serverPort: 123,
  serverProtocol: 'serverProtocol',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
accessKey?	`string`	Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
agentArns?	`string[]`	(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
bucketName?	`string`	Specifies the name of the object storage bucket involved in the transfer.
cmkSecretConfig?	`IResolvable` `\|` `CmkSecretConfigProperty`	Specifies configuration information for a DataSync-managed secret, which includes the `SecretKey` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .
customSecretConfig?	`IResolvable` `\|` `CustomSecretConfigProperty`	Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text.
secretKey?	`string`	Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
serverCertificate?	`string`	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).
serverHostname?	`string`	Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.
serverPort?	`number`	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.
tags?	`CfnTag[]`	Specifies the key-value pair that represents a tag that you want to add to the resource.

accessKey?

Type: string (optional)

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

agentArns?

Type: string[] (optional)

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

If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

bucketName?

Type: string (optional)

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

cmkSecretConfig?

Type: IResolvable | CmkSecretConfigProperty (optional)

Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

When you include this paramater as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

Make sure the DataSync has permission to access the KMS key that you specify.

You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

customSecretConfig?

Type: IResolvable | CustomSecretConfigProperty (optional)

Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text.

This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

secretKey?

Type: string (optional)

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

If you provide a secret using SecretKey , but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig , then DataSync stores the token using your AWS account's Secrets Manager secret.

serverCertificate?

Type: string (optional)

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 .

serverHostname?

Type: string (optional)

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

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.

If not specified, the default value is HTTPS .

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.