software.amazon.awscdk.services.memorydb

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-04-20T17:18:02.062Z")
 @Stability(value=Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnClusterProps.Builder A builder for CfnClusterProps
static class	CfnClusterProps.Jsii$Proxy An implementation for CfnClusterProps

Method Summary

Modifier and Type	Method and Description
static CfnClusterProps.Builder	builder()
String	getAclName() The name of the Access Control List to associate with the cluster .
default Object	getAutoMinorVersionUpgrade() When set to true, the cluster will automatically receive minor engine version upgrades after launch.
default Object	getClusterEndpoint() The cluster 's configuration endpoint.
String	getClusterName() The name of the cluster .
default String	getDataTiering() Enables data tiering.
default String	getDescription() A description of the cluster .
default String	getEngineVersion() The Redis engine version used by the cluster .
default String	getFinalSnapshotName() The user-supplied name of a final cluster snapshot.
default String	getKmsKeyId() The ID of the KMS key used to encrypt the cluster .
default String	getMaintenanceWindow() Specifies the weekly time range during which maintenance on the cluster is performed.
String	getNodeType() The cluster 's node type.
default Number	getNumReplicasPerShard() The number of replicas to apply to each shard.
default Number	getNumShards() The number of shards in the cluster .
default String	getParameterGroupName() The name of the parameter group used by the cluster .
default Number	getPort() The port used by the cluster .
default List<String>	getSecurityGroupIds() A list of security group names to associate with this cluster .
default List<String>	getSnapshotArns() A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
default String	getSnapshotName() The name of a snapshot from which to restore data into the new cluster .
default Number	getSnapshotRetentionLimit() The number of days for which MemoryDB retains automatic snapshots before deleting them.
default String	getSnapshotWindow() The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
default String	getSnsTopicArn() When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.
default String	getSnsTopicStatus() The SNS topic must be in Active status to receive notifications.
default String	getSubnetGroupName() The name of the subnet group used by the cluster .
default List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.
default Object	getTlsEnabled() A flag to indicate if In-transit encryption is enabled.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAclName

@Stability(value=Stable)
 @NotNull
String getAclName()

The name of the Access Control List to associate with the cluster .

getClusterName

@Stability(value=Stable)
 @NotNull
String getClusterName()

The name of the cluster .

getNodeType

@Stability(value=Stable)
 @NotNull
String getNodeType()

The cluster 's node type.

getAutoMinorVersionUpgrade

@Stability(value=Stable)
 @Nullable
default Object getAutoMinorVersionUpgrade()

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

getClusterEndpoint

@Stability(value=Stable)
 @Nullable
default Object getClusterEndpoint()

The cluster 's configuration endpoint.

getDataTiering

@Stability(value=Stable)
 @Nullable
default String 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 .

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the cluster .

getEngineVersion

@Stability(value=Stable)
 @Nullable
default String getEngineVersion()

The Redis engine version used by the cluster .

getFinalSnapshotName

@Stability(value=Stable)
 @Nullable
default String 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.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

The ID of the KMS key used to encrypt the cluster .

getMaintenanceWindow

@Stability(value=Stable)
 @Nullable
default String 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

getNumReplicasPerShard

@Stability(value=Stable)
 @Nullable
default Number getNumReplicasPerShard()

The number of replicas to apply to each shard.

Default value : 1

Maximum value : 5

getNumShards

@Stability(value=Stable)
 @Nullable
default Number getNumShards()

The number of shards in the cluster .

getParameterGroupName

@Stability(value=Stable)
 @Nullable
default String getParameterGroupName()

The name of the parameter group used by the cluster .

getPort

@Stability(value=Stable)
 @Nullable
default Number getPort()

The port used by the cluster .

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroupIds()

A list of security group names to associate with this cluster .

getSnapshotArns

@Stability(value=Stable)
 @Nullable
default List<String> 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.

getSnapshotName

@Stability(value=Stable)
 @Nullable
default String 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.

getSnapshotRetentionLimit

@Stability(value=Stable)
 @Nullable
default Number 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.

getSnapshotWindow

@Stability(value=Stable)
 @Nullable
default String 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.

getSnsTopicArn

@Stability(value=Stable)
 @Nullable
default String getSnsTopicArn()

When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.

getSnsTopicStatus

@Stability(value=Stable)
 @Nullable
default String getSnsTopicStatus()

The SNS topic must be in Active status to receive notifications.

getSubnetGroupName

@Stability(value=Stable)
 @Nullable
default String getSubnetGroupName()

The name of the subnet group used by the cluster .

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getTlsEnabled

@Stability(value=Stable)
 @Nullable
default Object getTlsEnabled()

A flag to indicate if In-transit encryption is enabled.

builder

@Stability(value=Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps