interface CfnLocationObjectStorageProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DataSync.CfnLocationObjectStorageProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnLocationObjectStorageProps |
![]() | software.amazon.awscdk.services.datasync.CfnLocationObjectStorageProps |
![]() | aws_cdk.aws_datasync.CfnLocationObjectStorageProps |
![]() | 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 = {
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
Name | Type | Description |
---|---|---|
agent | string[] | Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. |
access | string | Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server. |
bucket | string | Specifies the name of the object storage bucket involved in the transfer. |
secret | string | Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. |
server | 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). |
server | string | Specifies the domain name or IP address of the object storage server. |
server | number | Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443). |
server | string | Specifies the protocol that your object storage server uses to communicate. |
subdirectory? | string | Specifies the object prefix for your object storage server. |
tags? | Cfn [] | 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 connect with your object storage system.
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 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 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:
Cfn
[]
(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.