Interface CreateLocationObjectStorageRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateLocationObjectStorageRequest.Builder,
,CreateLocationObjectStorageRequest> DataSyncRequest.Builder
,SdkBuilder<CreateLocationObjectStorageRequest.Builder,
,CreateLocationObjectStorageRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateLocationObjectStorageRequest
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies 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 securely connect with your location.agentArns
(Collection<String> agentArns) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.bucketName
(String bucketName) Specifies the name of the object storage bucket involved in the transfer.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.serverCertificate
(SdkBytes serverCertificate) 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 serverHostname) Specifies the domain name or IP address of the object storage server.serverPort
(Integer serverPort) Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).serverProtocol
(String serverProtocol) Specifies the protocol that your object storage server uses to communicate.serverProtocol
(ObjectStorageServerProtocol serverProtocol) Specifies the protocol that your object storage server uses to communicate.subdirectory
(String subdirectory) Specifies the object prefix for your object storage server.tags
(Collection<TagListEntry> tags) Specifies the key-value pair that represents a tag that you want to add to the resource.tags
(Consumer<TagListEntry.Builder>... tags) Specifies the key-value pair that represents a tag that you want to add to the resource.tags
(TagListEntry... tags) Specifies the key-value pair that represents a tag that you want to add to the resource.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
serverPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
- Parameters:
serverPort
- Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverProtocol
Specifies the protocol that your object storage server uses to communicate.
- Parameters:
serverProtocol
- Specifies the protocol that your object storage server uses to communicate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serverProtocol
CreateLocationObjectStorageRequest.Builder serverProtocol(ObjectStorageServerProtocol serverProtocol) Specifies the protocol that your object storage server uses to communicate.
- Parameters:
serverProtocol
- Specifies the protocol that your object storage server uses to communicate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
bucketName
Specifies the name of the object storage bucket involved in the transfer.
- Parameters:
bucketName
- Specifies the name of the object storage bucket involved in the transfer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessKey
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
- Parameters:
accessKey
- Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secretKey
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
- Parameters:
secretKey
- Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
agentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
- Parameters:
agentArns
- Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
agentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
- Parameters:
agentArns
- Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theTagListEntry.Builder
avoiding the need to create one manually viaTagListEntry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<TagListEntry>)
.- Parameters:
tags
- a consumer that will call methods onTagListEntry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serverCertificate
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 examplecat
command creates anobject_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
toHTTPS
.- Parameters:
serverCertificate
- 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 examplecat
command creates anobject_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
toHTTPS
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
CreateLocationObjectStorageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateLocationObjectStorageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-