Interface CfnClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy
CfnCluster
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.memorydb.*; CfnClusterProps cfnClusterProps = CfnClusterProps.builder() .aclName("aclName") .clusterName("clusterName") .nodeType("nodeType") // the properties below are optional .autoMinorVersionUpgrade(false) .clusterEndpoint(EndpointProperty.builder() .address("address") .port(123) .build()) .dataTiering("dataTiering") .description("description") .engineVersion("engineVersion") .finalSnapshotName("finalSnapshotName") .kmsKeyId("kmsKeyId") .maintenanceWindow("maintenanceWindow") .numReplicasPerShard(123) .numShards(123) .parameterGroupName("parameterGroupName") .port(123) .securityGroupIds(List.of("securityGroupIds")) .snapshotArns(List.of("snapshotArns")) .snapshotName("snapshotName") .snapshotRetentionLimit(123) .snapshotWindow("snapshotWindow") .snsTopicArn("snsTopicArn") .snsTopicStatus("snsTopicStatus") .subnetGroupName("subnetGroupName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .tlsEnabled(false) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnClusterProps
static final class
An implementation forCfnClusterProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builder
builder()
The name of the Access Control List to associate with the cluster .default Object
When set to true, the cluster will automatically receive minor engine version upgrades after launch.default Object
The cluster 's configuration endpoint.The name of the cluster .default String
Enables data tiering.default String
A description of the cluster .default String
The Redis engine version used by the cluster .default String
The user-supplied name of a final cluster snapshot.default String
The ID of the KMS key used to encrypt the cluster .default String
Specifies the weekly time range during which maintenance on the cluster is performed.The cluster 's node type.default Number
The number of replicas to apply to each shard.default Number
The number of shards in the cluster .default String
The name of the parameter group used by the cluster .default Number
getPort()
The port used by the cluster .A list of security group names to associate with this cluster .A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.default String
The name of a snapshot from which to restore data into the new cluster .default Number
The number of days for which MemoryDB retains automatic snapshots before deleting them.default String
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.default String
When you pass the logical ID of this resource to the intrinsicRef
function, Ref returns the ARN of the SNS topic, such asarn:aws:memorydb:us-east-1:123456789012:mySNSTopic
.default String
The SNS topic must be in Active status to receive notifications.default String
The name of the subnet group used by the cluster .getTags()
An array of key-value pairs to apply to this resource.default Object
A flag to indicate if In-transit encryption is enabled.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAclName
The name of the Access Control List to associate with the cluster .- See Also:
-
getClusterName
The name of the cluster .- See Also:
-
getNodeType
The cluster 's node type.- See Also:
-
getAutoMinorVersionUpgrade
When set to true, the cluster will automatically receive minor engine version upgrades after launch.- See Also:
-
getClusterEndpoint
The cluster 's configuration endpoint.- See Also:
-
getDataTiering
Enables data tiering.Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering .
- See Also:
-
getDescription
A description of the cluster .- See Also:
-
getEngineVersion
The Redis engine version used by the cluster .- See Also:
-
getFinalSnapshotName
The user-supplied name of a final cluster snapshot.This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
- See Also:
-
getKmsKeyId
The ID of the KMS key used to encrypt the cluster .- See Also:
-
getMaintenanceWindow
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.Pattern :
ddd:hh24:mi-ddd:hh24:mi
- See Also:
-
getNumReplicasPerShard
The number of replicas to apply to each shard.Default value :
1
Maximum value :
5
- See Also:
-
getNumShards
The number of shards in the cluster .- See Also:
-
getParameterGroupName
The name of the parameter group used by the cluster .- See Also:
-
getPort
The port used by the cluster .- See Also:
-
getSecurityGroupIds
A list of security group names to associate with this cluster .- See Also:
-
getSnapshotArns
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.
- See Also:
-
getSnapshotName
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.
- See Also:
-
getSnapshotRetentionLimit
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.
- See Also:
-
getSnapshotWindow
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.
- See Also:
-
getSnsTopicArn
When you pass the logical ID of this resource to the intrinsicRef
function, Ref returns the ARN of the SNS topic, such asarn:aws:memorydb:us-east-1:123456789012:mySNSTopic
.- See Also:
-
getSnsTopicStatus
The SNS topic must be in Active status to receive notifications.- See Also:
-
getSubnetGroupName
The name of the subnet group used by the cluster .- See Also:
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
- See Also:
-
getTlsEnabled
A flag to indicate if In-transit encryption is enabled.- See Also:
-
builder
- Returns:
- a
CfnClusterProps.Builder
ofCfnClusterProps
-