Class CfnLocationObjectStorageProps.Builder
java.lang.Object
software.amazon.awscdk.services.datasync.CfnLocationObjectStorageProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnLocationObjectStorageProps>
- Enclosing interface:
- CfnLocationObjectStorageProps
@Stability(Stable)
public static final class CfnLocationObjectStorageProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLocationObjectStorageProps>
A builder for
CfnLocationObjectStorageProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnLocationObjectStorageProps.getAccessKey()Sets the value ofCfnLocationObjectStorageProps.getAgentArns()bucketName(String bucketName) Sets the value ofCfnLocationObjectStorageProps.getBucketName()build()Builds the configured instance.Sets the value ofCfnLocationObjectStorageProps.getSecretKey()serverCertificate(String serverCertificate) Sets the value ofCfnLocationObjectStorageProps.getServerCertificate()serverHostname(String serverHostname) Sets the value ofCfnLocationObjectStorageProps.getServerHostname()serverPort(Number serverPort) Sets the value ofCfnLocationObjectStorageProps.getServerPort()serverProtocol(String serverProtocol) Sets the value ofCfnLocationObjectStorageProps.getServerProtocol()subdirectory(String subdirectory) Sets the value ofCfnLocationObjectStorageProps.getSubdirectory()Sets the value ofCfnLocationObjectStorageProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
agentArns
Sets the value ofCfnLocationObjectStorageProps.getAgentArns()- Parameters:
agentArns- Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location. This parameter is required.- Returns:
this
-
accessKey
Sets the value ofCfnLocationObjectStorageProps.getAccessKey()- Parameters:
accessKey- Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.- Returns:
this
-
bucketName
Sets the value ofCfnLocationObjectStorageProps.getBucketName()- Parameters:
bucketName- Specifies the name of the object storage bucket involved in the transfer.- Returns:
this
-
secretKey
Sets the value ofCfnLocationObjectStorageProps.getSecretKey()- Parameters:
secretKey- Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.- Returns:
this
-
serverCertificate
@Stability(Stable) public CfnLocationObjectStorageProps.Builder serverCertificate(String serverCertificate) Sets the value ofCfnLocationObjectStorageProps.getServerCertificate()- Parameters:
serverCertificate- 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
.pemextension
The file can be up to 32768 bytes (before base64 encoding).
To use this parameter, configure
ServerProtocoltoHTTPS.- Returns:
this
-
serverHostname
@Stability(Stable) public CfnLocationObjectStorageProps.Builder serverHostname(String serverHostname) Sets the value ofCfnLocationObjectStorageProps.getServerHostname()- Parameters:
serverHostname- 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.- Returns:
this
-
serverPort
Sets the value ofCfnLocationObjectStorageProps.getServerPort()- Parameters:
serverPort- Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).- Returns:
this
-
serverProtocol
@Stability(Stable) public CfnLocationObjectStorageProps.Builder serverProtocol(String serverProtocol) Sets the value ofCfnLocationObjectStorageProps.getServerProtocol()- Parameters:
serverProtocol- Specifies the protocol that your object storage server uses to communicate.- Returns:
this
-
subdirectory
Sets the value ofCfnLocationObjectStorageProps.getSubdirectory()- Parameters:
subdirectory- 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.- Returns:
this
-
tags
Sets the value ofCfnLocationObjectStorageProps.getTags()- Parameters:
tags- 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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnLocationObjectStorageProps>- Returns:
- a new instance of
CfnLocationObjectStorageProps - Throws:
NullPointerException- if any required attribute was not provided
-