Interface RestoreDbClusterFromSnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,
,RestoreDbClusterFromSnapshotRequest> DocDbRequest.Builder
,SdkBuilder<RestoreDbClusterFromSnapshotRequest.Builder,
,RestoreDbClusterFromSnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
RestoreDbClusterFromSnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionavailabilityZones
(String... availabilityZones) Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.availabilityZones
(Collection<String> availabilityZones) Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.dbClusterIdentifier
(String dbClusterIdentifier) The name of the cluster to create from the snapshot or cluster snapshot.dbClusterParameterGroupName
(String dbClusterParameterGroupName) The name of the DB cluster parameter group to associate with this DB cluster.dbSubnetGroupName
(String dbSubnetGroupName) The name of the subnet group to use for the new cluster.deletionProtection
(Boolean deletionProtection) Specifies whether this cluster can be deleted.enableCloudwatchLogsExports
(String... enableCloudwatchLogsExports) A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.enableCloudwatchLogsExports
(Collection<String> enableCloudwatchLogsExports) A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.The database engine to use for the new cluster.engineVersion
(String engineVersion) The version of the database engine to use for the new cluster.The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The port number on which the new cluster accepts connections.snapshotIdentifier
(String snapshotIdentifier) The identifier for the snapshot or cluster snapshot to restore from.storageType
(String storageType) The storage type to associate with the DB cluster.tags
(Collection<Tag> tags) The tags to be assigned to the restored cluster.tags
(Consumer<Tag.Builder>... tags) The tags to be assigned to the restored cluster.The tags to be assigned to the restored cluster.vpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups that the new cluster will belong to.vpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups that the new cluster will belong to.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.docdb.model.DocDbRequest.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
-
availabilityZones
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
- Parameters:
availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZones
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
- Parameters:
availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterIdentifier
The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-snapshot-id
- Parameters:
dbClusterIdentifier
- The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-snapshot-id
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
snapshotIdentifier
The identifier for the snapshot or cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
-
Must match the identifier of an existing snapshot.
- Parameters:
snapshotIdentifier
- The identifier for the snapshot or cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
-
Must match the identifier of an existing snapshot.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
engine
The database engine to use for the new cluster.
Default: The same as source.
Constraint: Must be compatible with the engine of the source.
- Parameters:
engine
- The database engine to use for the new cluster.Default: The same as source.
Constraint: Must be compatible with the engine of the source.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
The version of the database engine to use for the new cluster.
- Parameters:
engineVersion
- The version of the database engine to use for the new cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
The port number on which the new cluster accepts connections.
Constraints: Must be a value from
1150
to65535
.Default: The same port as the original cluster.
- Parameters:
port
- The port number on which the new cluster accepts connections.Constraints: Must be a value from
1150
to65535
.Default: The same port as the original cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbSubnetGroupName
The name of the subnet group to use for the new cluster.
Constraints: If provided, must match the name of an existing
DBSubnetGroup
.Example:
mySubnetgroup
- Parameters:
dbSubnetGroupName
- The name of the subnet group to use for the new cluster.Constraints: If provided, must match the name of an existing
DBSubnetGroup
.Example:
mySubnetgroup
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
- Parameters:
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups that the new cluster will belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
- Parameters:
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups that the new cluster will belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to be assigned to the restored cluster.
- Parameters:
tags
- The tags to be assigned to the restored cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to be assigned to the restored cluster.
- Parameters:
tags
- The tags to be assigned to the restored cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to be assigned to the restored cluster.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kmsKeyId
The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following occurs:-
If the snapshot or cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot. -
If the snapshot or the cluster snapshot in
SnapshotIdentifier
is not encrypted, then the restored DB cluster is not encrypted.
- Parameters:
kmsKeyId
- The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following occurs:-
If the snapshot or cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot. -
If the snapshot or the cluster snapshot in
SnapshotIdentifier
is not encrypted, then the restored DB cluster is not encrypted.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
enableCloudwatchLogsExports
RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports) A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
- Parameters:
enableCloudwatchLogsExports
- A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableCloudwatchLogsExports
RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports) A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
- Parameters:
enableCloudwatchLogsExports
- A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deletionProtection
Specifies whether this cluster can be deleted. If
DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.- Parameters:
deletionProtection
- Specifies whether this cluster can be deleted. IfDeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterParameterGroupName
RestoreDbClusterFromSnapshotRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName) The name of the DB cluster parameter group to associate with this DB cluster.
Type: String. Required: No.
If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.
- Parameters:
dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster.Type: String. Required: No.
If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageType
The storage type to associate with the DB cluster.
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type -
standard | iopt1
Default value is
standard
- Parameters:
storageType
- The storage type to associate with the DB cluster.For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type -
standard | iopt1
Default value is
standard
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
RestoreDbClusterFromSnapshotRequest.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
RestoreDbClusterFromSnapshotRequest.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.
-