Interface RestoreClusterFromSnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<RestoreClusterFromSnapshotRequest.Builder,
,RestoreClusterFromSnapshotRequest> DocDbElasticRequest.Builder
,SdkBuilder<RestoreClusterFromSnapshotRequest.Builder,
,RestoreClusterFromSnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
RestoreClusterFromSnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionclusterName
(String clusterName) The name of the Elastic DocumentDB cluster.The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.snapshotArn
(String snapshotArn) The arn of the Elastic DocumentDB snapshot.The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.subnetIds
(Collection<String> subnetIds) The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.vpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.vpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the Elastic DocumentDB 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.docdbelastic.model.DocDbElasticRequest.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
-
clusterName
The name of the Elastic DocumentDB cluster.
- Parameters:
clusterName
- The name of the Elastic DocumentDB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
- Parameters:
kmsKeyId
- The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotArn
The arn of the Elastic DocumentDB snapshot.
- Parameters:
snapshotArn
- The arn of the Elastic DocumentDB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
- Parameters:
subnetIds
- The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
- Parameters:
subnetIds
- The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
- Parameters:
tags
- A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
RestoreClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.
- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.
- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
RestoreClusterFromSnapshotRequest.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
RestoreClusterFromSnapshotRequest.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.
-