Interface CreateClusterRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> MemoryDbRequest.Builder
,SdkBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateClusterRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the Access Control List to associate with the cluster.autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) When set to true, the cluster will automatically receive minor engine version upgrades after launch.clusterName
(String clusterName) The name of the cluster.dataTiering
(Boolean dataTiering) Enables data tiering.description
(String description) An optional description of the cluster.engineVersion
(String engineVersion) The version number of the Redis engine to be used for the cluster.The ID of the KMS key used to encrypt the cluster.maintenanceWindow
(String maintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.The compute and memory capacity of the nodes in the cluster.numReplicasPerShard
(Integer numReplicasPerShard) The number of replicas to apply to each shard.The number of shards the cluster will contain.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameterGroupName
(String parameterGroupName) The name of the parameter group associated with the cluster.The port number on which each of the nodes accepts connections.securityGroupIds
(String... securityGroupIds) A list of security group names to associate with this cluster.securityGroupIds
(Collection<String> securityGroupIds) A list of security group names to associate with this cluster.snapshotArns
(String... snapshotArns) A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.snapshotArns
(Collection<String> snapshotArns) A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.snapshotName
(String snapshotName) The name of a snapshot from which to restore data into the new cluster.snapshotRetentionLimit
(Integer snapshotRetentionLimit) The number of days for which MemoryDB retains automatic snapshots before deleting them.snapshotWindow
(String snapshotWindow) The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.snsTopicArn
(String snsTopicArn) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.subnetGroupName
(String subnetGroupName) The name of the subnet group to be used for the cluster.tags
(Collection<Tag> tags) A list of tags to be added to this resource.tags
(Consumer<Tag.Builder>... tags) A list of tags to be added to this resource.A list of tags to be added to this resource.tlsEnabled
(Boolean tlsEnabled) A flag to enable in-transit encryption on the 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.memorydb.model.MemoryDbRequest.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 cluster. This value must be unique as it also serves as the cluster identifier.
- Parameters:
clusterName
- The name of the cluster. This value must be unique as it also serves as the cluster identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeType
The compute and memory capacity of the nodes in the cluster.
- Parameters:
nodeType
- The compute and memory capacity of the nodes in the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameterGroupName
The name of the parameter group associated with the cluster.
- Parameters:
parameterGroupName
- The name of the parameter group associated with the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
An optional description of the cluster.
- Parameters:
description
- An optional description of the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numShards
The number of shards the cluster will contain. The default value is 1.
- Parameters:
numShards
- The number of shards the cluster will contain. The default value is 1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numReplicasPerShard
The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
- Parameters:
numReplicasPerShard
- The number of replicas to apply to each shard. The default value is 1. The maximum is 5.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetGroupName
The name of the subnet group to be used for the cluster.
- Parameters:
subnetGroupName
- The name of the subnet group to be used for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
A list of security group names to associate with this cluster.
- Parameters:
securityGroupIds
- A list of security group names to associate with this cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
A list of security group names to associate with this cluster.
- Parameters:
securityGroupIds
- A list of security group names to associate with this cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maintenanceWindow
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for
ddd
are:-
sun
-
mon
-
tue
-
wed
-
thu
-
fri
-
sat
Example:
sun:23:00-mon:01:30
- Parameters:
maintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.Valid values for
ddd
are:-
sun
-
mon
-
tue
-
wed
-
thu
-
fri
-
sat
Example:
sun:23:00-mon:01:30
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
port
The port number on which each of the nodes accepts connections.
- Parameters:
port
- The port number on which each of the nodes accepts connections.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- Parameters:
snsTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tlsEnabled
A flag to enable in-transit encryption on the cluster.
- Parameters:
tlsEnabled
- A flag to enable in-transit encryption on the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The ID of the KMS key used to encrypt the cluster.
- Parameters:
kmsKeyId
- The ID of the KMS key used to encrypt the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotArns
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
- Parameters:
snapshotArns
- A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotArns
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
- Parameters:
snapshotArns
- A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotName
The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
- Parameters:
snapshotName
- The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotRetentionLimit
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
- Parameters:
snapshotRetentionLimit
- The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
- Parameters:
tags
- A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
- Parameters:
tags
- A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
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:
-
snapshotWindow
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
- Parameters:
snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aclName
The name of the Access Control List to associate with the cluster.
- Parameters:
aclName
- The name of the Access Control List to associate with the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
The version number of the Redis engine to be used for the cluster.
- Parameters:
engineVersion
- The version number of the Redis engine to be used for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoMinorVersionUpgrade
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
- Parameters:
autoMinorVersionUpgrade
- When set to true, the cluster will automatically receive minor engine version upgrades after launch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataTiering
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
- Parameters:
dataTiering
- Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-