software.amazon.awscdk.services.memorydb

Class CfnCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.memorydb.CfnCluster

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-04-20T17:18:02.049Z")
 @Stability(value=Stable)
public class CfnCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MemoryDB::Cluster`.

Specifies a cluster . All nodes in the cluster run the same protocol-compliant engine software.

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.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .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	Class and Description
static class	CfnCluster.Builder A fluent builder for CfnCluster.
static interface	CfnCluster.EndpointProperty Represents the information required for client programs to connect to the cluster and its nodes.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCluster(Construct scope, String id, CfnClusterProps props) Create a new `AWS::MemoryDB::Cluster`.
protected	CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAclName() The name of the Access Control List to associate with the cluster .
String	getAttrArn() When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the cluster , such as `arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster`.
String	getAttrClusterEndpointAddress() The address of the cluster 's configuration endpoint.
Number	getAttrClusterEndpointPort() The port used by the cluster configuration endpoint.
String	getAttrParameterGroupStatus() The status of the parameter group used by the cluster , for example `active` or `applying` .
String	getAttrStatus() The status of the cluster.
Object	getAutoMinorVersionUpgrade() When set to true, the cluster will automatically receive minor engine version upgrades after launch.
protected Map<String,Object>	getCfnProperties()
Object	getClusterEndpoint() The cluster 's configuration endpoint.
String	getClusterName() The name of the cluster .
String	getDataTiering() Enables data tiering.
String	getDescription() A description of the cluster .
String	getEngineVersion() The Redis engine version used by the cluster .
String	getFinalSnapshotName() The user-supplied name of a final cluster snapshot.
String	getKmsKeyId() The ID of the KMS key used to encrypt the cluster .
String	getMaintenanceWindow() Specifies the weekly time range during which maintenance on the cluster is performed.
String	getNodeType() The cluster 's node type.
Number	getNumReplicasPerShard() The number of replicas to apply to each shard.
Number	getNumShards() The number of shards in the cluster .
String	getParameterGroupName() The name of the parameter group used by the cluster .
Number	getPort() The port used by the cluster .
List<String>	getSecurityGroupIds() A list of security group names to associate with this cluster .
List<String>	getSnapshotArns() A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
String	getSnapshotName() The name of a snapshot from which to restore data into the new cluster .
Number	getSnapshotRetentionLimit() The number of days for which MemoryDB retains automatic snapshots before deleting them.
String	getSnapshotWindow() The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
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`.
String	getSnsTopicStatus() The SNS topic must be in Active status to receive notifications.
String	getSubnetGroupName() The name of the subnet group used by the cluster .
TagManager	getTags() An array of key-value pairs to apply to this resource.
Object	getTlsEnabled() A flag to indicate if In-transit encryption is enabled.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAclName(String value) The name of the Access Control List to associate with the cluster .
void	setAutoMinorVersionUpgrade(Boolean value) When set to true, the cluster will automatically receive minor engine version upgrades after launch.
void	setAutoMinorVersionUpgrade(IResolvable value) When set to true, the cluster will automatically receive minor engine version upgrades after launch.
void	setClusterEndpoint(CfnCluster.EndpointProperty value) The cluster 's configuration endpoint.
void	setClusterEndpoint(IResolvable value) The cluster 's configuration endpoint.
void	setClusterName(String value) The name of the cluster .
void	setDataTiering(String value) Enables data tiering.
void	setDescription(String value) A description of the cluster .
void	setEngineVersion(String value) The Redis engine version used by the cluster .
void	setFinalSnapshotName(String value) The user-supplied name of a final cluster snapshot.
void	setKmsKeyId(String value) The ID of the KMS key used to encrypt the cluster .
void	setMaintenanceWindow(String value) Specifies the weekly time range during which maintenance on the cluster is performed.
void	setNodeType(String value) The cluster 's node type.
void	setNumReplicasPerShard(Number value) The number of replicas to apply to each shard.
void	setNumShards(Number value) The number of shards in the cluster .
void	setParameterGroupName(String value) The name of the parameter group used by the cluster .
void	setPort(Number value) The port used by the cluster .
void	setSecurityGroupIds(List<String> value) A list of security group names to associate with this cluster .
void	setSnapshotArns(List<String> value) A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
void	setSnapshotName(String value) The name of a snapshot from which to restore data into the new cluster .
void	setSnapshotRetentionLimit(Number value) The number of days for which MemoryDB retains automatic snapshots before deleting them.
void	setSnapshotWindow(String value) The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
void	setSnsTopicArn(String value) 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`.
void	setSnsTopicStatus(String value) The SNS topic must be in Active status to receive notifications.
void	setSubnetGroupName(String value) The name of the subnet group used by the cluster .
void	setTlsEnabled(Boolean value) A flag to indicate if In-transit encryption is enabled.
void	setTlsEnabled(IResolvable value) A flag to indicate if In-transit encryption is enabled.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCluster

@Stability(value=Stable)
public CfnCluster(@NotNull
                                           Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnClusterProps props)

Create a new `AWS::MemoryDB::Cluster`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getAttrClusterEndpointAddress

@Stability(value=Stable)
 @NotNull
public String getAttrClusterEndpointAddress()

The address of the cluster 's configuration endpoint.

getAttrClusterEndpointPort

@Stability(value=Stable)
 @NotNull
public Number getAttrClusterEndpointPort()

The port used by the cluster configuration endpoint.

getAttrParameterGroupStatus

@Stability(value=Stable)
 @NotNull
public String getAttrParameterGroupStatus()

The status of the parameter group used by the cluster , for example `active` or `applying` .

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The status of the cluster.

For example, 'available', 'updating' or 'creating'.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getAclName

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

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

setAclName

@Stability(value=Stable)
public void setAclName(@NotNull
                                                String value)

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

getClusterName

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

The name of the cluster .

setClusterName

@Stability(value=Stable)
public void setClusterName(@NotNull
                                                    String value)

The name of the cluster .

getNodeType

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

The cluster 's node type.

setNodeType

@Stability(value=Stable)
public void setNodeType(@NotNull
                                                 String value)

The cluster 's node type.

getAutoMinorVersionUpgrade

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

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

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                Boolean value)

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

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                IResolvable value)

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

getClusterEndpoint

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

The cluster 's configuration endpoint.

setClusterEndpoint

@Stability(value=Stable)
public void setClusterEndpoint(@Nullable
                                                        IResolvable value)

The cluster 's configuration endpoint.

setClusterEndpoint

@Stability(value=Stable)
public void setClusterEndpoint(@Nullable
                                                        CfnCluster.EndpointProperty value)

The cluster 's configuration endpoint.

getDataTiering

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

setDataTiering

@Stability(value=Stable)
public void setDataTiering(@Nullable
                                                    String value)

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
public String getDescription()

A description of the cluster .

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the cluster .

getEngineVersion

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

The Redis engine version used by the cluster .

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

The Redis engine version used by the cluster .

getFinalSnapshotName

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

setFinalSnapshotName

@Stability(value=Stable)
public void setFinalSnapshotName(@Nullable
                                                          String value)

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
public String getKmsKeyId()

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getMaintenanceWindow

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

setMaintenanceWindow

@Stability(value=Stable)
public void setMaintenanceWindow(@Nullable
                                                          String value)

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
public Number getNumReplicasPerShard()

The number of replicas to apply to each shard.

Default value : 1

Maximum value : 5

setNumReplicasPerShard

@Stability(value=Stable)
public void setNumReplicasPerShard(@Nullable
                                                            Number value)

The number of replicas to apply to each shard.

Default value : 1

Maximum value : 5

getNumShards

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

The number of shards in the cluster .

setNumShards

@Stability(value=Stable)
public void setNumShards(@Nullable
                                                  Number value)

The number of shards in the cluster .

getParameterGroupName

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

The name of the parameter group used by the cluster .

setParameterGroupName

@Stability(value=Stable)
public void setParameterGroupName(@Nullable
                                                           String value)

The name of the parameter group used by the cluster .

getPort

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

The port used by the cluster .

setPort

@Stability(value=Stable)
public void setPort(@Nullable
                                             Number value)

The port used by the cluster .

getSecurityGroupIds

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

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

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)

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

getSnapshotArns

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

setSnapshotArns

@Stability(value=Stable)
public void setSnapshotArns(@Nullable
                                                     List<String> value)

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
public 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.

setSnapshotName

@Stability(value=Stable)
public void setSnapshotName(@Nullable
                                                     String value)

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
public 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.

setSnapshotRetentionLimit

@Stability(value=Stable)
public void setSnapshotRetentionLimit(@Nullable
                                                               Number value)

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
public 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.

setSnapshotWindow

@Stability(value=Stable)
public void setSnapshotWindow(@Nullable
                                                       String value)

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
public 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`.

setSnsTopicArn

@Stability(value=Stable)
public void setSnsTopicArn(@Nullable
                                                    String value)

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
public String getSnsTopicStatus()

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

setSnsTopicStatus

@Stability(value=Stable)
public void setSnsTopicStatus(@Nullable
                                                       String value)

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

getSubnetGroupName

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

The name of the subnet group used by the cluster .

setSubnetGroupName

@Stability(value=Stable)
public void setSubnetGroupName(@Nullable
                                                        String value)

The name of the subnet group used by the cluster .

getTlsEnabled

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

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

setTlsEnabled

@Stability(value=Stable)
public void setTlsEnabled(@Nullable
                                                   Boolean value)

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

setTlsEnabled

@Stability(value=Stable)
public void setTlsEnabled(@Nullable
                                                   IResolvable value)

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