Interface CfnLocationObjectStorageProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLocationObjectStorageProps.Jsii$Proxy
CfnLocationObjectStorage.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.datasync.*;
CfnLocationObjectStorageProps cfnLocationObjectStorageProps = CfnLocationObjectStorageProps.builder()
.agentArns(List.of("agentArns"))
// the properties below are optional
.accessKey("accessKey")
.bucketName("bucketName")
.secretKey("secretKey")
.serverCertificate("serverCertificate")
.serverHostname("serverHostname")
.serverPort(123)
.serverProtocol("serverProtocol")
.subdirectory("subdirectory")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnLocationObjectStoragePropsstatic final classAn implementation forCfnLocationObjectStorageProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringSpecifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.default StringSpecifies the name of the object storage bucket involved in the transfer.default StringSpecifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.default StringSpecifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).default StringSpecifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.default NumberSpecifies the port that your object storage server accepts inbound network traffic on (for example, port 443).default StringSpecifies the protocol that your object storage server uses to communicate.default StringSpecifies the object prefix for your object storage server.getTags()Specifies the key-value pair that represents a tag that you want to add to the resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAgentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.- See Also:
-
getAccessKey
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.- See Also:
-
getBucketName
Specifies the name of the object storage bucket involved in the transfer.- See Also:
-
getSecretKey
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.- See Also:
-
getServerCertificate
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
.pemfile 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
.pemfile (which can be up to 32768 bytes before base64 encoding). The following examplecatcommand creates anobject_storage_certificates.pemfile that includes three certificates:cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pemTo use this parameter, configure
ServerProtocoltoHTTPS.- See Also:
-
getServerHostname
Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.- See Also:
-
getServerPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).- See Also:
-
getServerProtocol
Specifies the protocol that your object storage server uses to communicate.- See Also:
-
getSubdirectory
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.
- See Also:
-
getTags
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.
- See Also:
-
builder
-