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")
.engine("engine")
.engineVersion("engineVersion")
.finalSnapshotName("finalSnapshotName")
.ipDiscovery("ipDiscovery")
.kmsKeyId("kmsKeyId")
.maintenanceWindow("maintenanceWindow")
.multiRegionClusterName("multiRegionClusterName")
.networkType("networkType")
.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 classA builder forCfnClusterPropsstatic final classAn implementation forCfnClusterProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builderbuilder()The name of the Access Control List to associate with the cluster .default ObjectWhen set to true, the cluster will automatically receive minor engine version upgrades after launch.default ObjectThe cluster 's configuration endpoint.The name of the cluster .default StringEnables data tiering.default StringA description of the cluster .default StringThe name of the engine used by the cluster.default StringThe Redis engine version used by the cluster .default StringThe user-supplied name of a final cluster snapshot.default StringThe mechanism that the cluster uses to discover IP addresses.default StringThe ID of the KMS key used to encrypt the cluster .default StringSpecifies the weekly time range during which maintenance on the cluster is performed.default StringThe name of the multi-Region cluster that this cluster belongs to.default StringThe IP address type for the cluster.The cluster 's node type.default NumberThe number of replicas to apply to each shard.default NumberThe number of shards in the cluster .default StringThe name of the parameter group used by the cluster .default NumbergetPort()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 StringThe name of a snapshot from which to restore data into the new cluster .default NumberThe number of days for which MemoryDB retains automatic snapshots before deleting them.default StringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.default StringWhen you pass the logical ID of this resource to the intrinsicReffunction, Ref returns the ARN of the SNS topic, such asarn:aws:memorydb:us-east-1:123456789012:mySNSTopic.default StringThe SNS topic must be in Active status to receive notifications.default StringThe name of the subnet group used by the cluster .getTags()An array of key-value pairs to apply to this resource.default ObjectA 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.Returns union: either
BooleanorIResolvable- See Also:
-
getClusterEndpoint
The cluster 's configuration endpoint.Returns union: either
IResolvableorCfnCluster.EndpointProperty- See Also:
-
getDataTiering
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 .
- See Also:
-
getDescription
A description of the cluster .- See Also:
-
getEngine
The name of the engine used by 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:
-
getIpDiscovery
The mechanism that the cluster uses to discover IP addresses.Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.
- 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:
-
getMultiRegionClusterName
The name of the multi-Region cluster that this cluster belongs to.- See Also:
-
getNetworkType
The IP address type for the cluster.Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.
- See Also:
-
getNumReplicasPerShard
The number of replicas to apply to each shard.Default value :
1Maximum 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 intrinsicReffunction, 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.Returns union: either
BooleanorIResolvable- See Also:
-
builder
- Returns:
- a
CfnClusterProps.BuilderofCfnClusterProps
-