Interface CreateClusterRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> DsqlRequest.Builder
,SdkBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateClusterRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.deletionProtectionEnabled
(Boolean deletionProtectionEnabled) If enabled, you can't delete your cluster.kmsEncryptionKey
(String kmsEncryptionKey) The KMS key that encrypts and protects the data on your cluster.default CreateClusterRequest.Builder
multiRegionProperties
(Consumer<MultiRegionProperties.Builder> multiRegionProperties) The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.multiRegionProperties
(MultiRegionProperties multiRegionProperties) The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.A map of key and value pairs to use to tag your cluster.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.dsql.model.DsqlRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
deletionProtectionEnabled
If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.
- Parameters:
deletionProtectionEnabled
- If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsEncryptionKey
The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
- Parameters:
kmsEncryptionKey
- The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A map of key and value pairs to use to tag your cluster.
- Parameters:
tags
- A map of key and value pairs to use to tag your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
- Parameters:
clientToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiRegionProperties
The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.
- Parameters:
multiRegionProperties
- The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiRegionProperties
default CreateClusterRequest.Builder multiRegionProperties(Consumer<MultiRegionProperties.Builder> multiRegionProperties) The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.
This is a convenience method that creates an instance of theMultiRegionProperties.Builder
avoiding the need to create one manually viaMultiRegionProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomultiRegionProperties(MultiRegionProperties)
.- Parameters:
multiRegionProperties
- a consumer that will call methods onMultiRegionProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateClusterRequest.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
CreateClusterRequest.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.
-