CfnCluster

java.lang.Object
- 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:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.854Z")
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 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 java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnCluster(Construct scope, java.lang.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

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

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnCluster(Construct scope,
                  java.lang.String id,
                  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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.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
```
public java.lang.String getAttrClusterEndpointAddress()
```
    The address of the cluster 's configuration endpoint.
  - getAttrClusterEndpointPort
```
public java.lang.Number getAttrClusterEndpointPort()
```
    The port used by the cluster configuration endpoint.
  - getAttrParameterGroupStatus
```
public java.lang.String getAttrParameterGroupStatus()
```
    The status of the parameter group used by the cluster , for example `active` or `applying` .
  - getAttrStatus
```
public java.lang.String getAttrStatus()
```
    The status of the cluster.
    For example, 'available', 'updating' or 'creating'.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of key-value pairs to apply to this resource.
    For more information, see Tag .
  - getAclName
```
public java.lang.String getAclName()
```
    The name of the Access Control List to associate with the cluster .
  - setAclName
```
public void setAclName(java.lang.String value)
```
    The name of the Access Control List to associate with the cluster .
  - getClusterName
```
public java.lang.String getClusterName()
```
    The name of the cluster .
  - setClusterName
```
public void setClusterName(java.lang.String value)
```
    The name of the cluster .
  - getNodeType
```
public java.lang.String getNodeType()
```
    The cluster 's node type.
  - setNodeType
```
public void setNodeType(java.lang.String value)
```
    The cluster 's node type.
  - getAutoMinorVersionUpgrade
```
public java.lang.Object getAutoMinorVersionUpgrade()
```
    When set to true, the cluster will automatically receive minor engine version upgrades after launch.
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(java.lang.Boolean value)
```
    When set to true, the cluster will automatically receive minor engine version upgrades after launch.
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(IResolvable value)
```
    When set to true, the cluster will automatically receive minor engine version upgrades after launch.
  - getClusterEndpoint
```
public java.lang.Object getClusterEndpoint()
```
    The cluster 's configuration endpoint.
  - setClusterEndpoint
```
public void setClusterEndpoint(IResolvable value)
```
    The cluster 's configuration endpoint.
  - setClusterEndpoint
```
public void setClusterEndpoint(CfnCluster.EndpointProperty value)
```
    The cluster 's configuration endpoint.
  - getDataTiering
```
public java.lang.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
```
public void setDataTiering(java.lang.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
```
public java.lang.String getDescription()
```
    A description of the cluster .
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description of the cluster .
  - getEngineVersion
```
public java.lang.String getEngineVersion()
```
    The Redis engine version used by the cluster .
  - setEngineVersion
```
public void setEngineVersion(java.lang.String value)
```
    The Redis engine version used by the cluster .
  - getFinalSnapshotName
```
public java.lang.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
```
public void setFinalSnapshotName(java.lang.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
```
public java.lang.String getKmsKeyId()
```
    The ID of the KMS key used to encrypt the cluster .
  - setKmsKeyId
```
public void setKmsKeyId(java.lang.String value)
```
    The ID of the KMS key used to encrypt the cluster .
  - getMaintenanceWindow
```
public java.lang.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
```
public void setMaintenanceWindow(java.lang.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
```
public java.lang.Number getNumReplicasPerShard()
```
    The number of replicas to apply to each shard.
    Default value : 1
    Maximum value : 5
  - setNumReplicasPerShard
```
public void setNumReplicasPerShard(java.lang.Number value)
```
    The number of replicas to apply to each shard.
    Default value : 1
    Maximum value : 5
  - getNumShards
```
public java.lang.Number getNumShards()
```
    The number of shards in the cluster .
  - setNumShards
```
public void setNumShards(java.lang.Number value)
```
    The number of shards in the cluster .
  - getParameterGroupName
```
public java.lang.String getParameterGroupName()
```
    The name of the parameter group used by the cluster .
  - setParameterGroupName
```
public void setParameterGroupName(java.lang.String value)
```
    The name of the parameter group used by the cluster .
  - getPort
```
public java.lang.Number getPort()
```
    The port used by the cluster .
  - setPort
```
public void setPort(java.lang.Number value)
```
    The port used by the cluster .
  - getSecurityGroupIds
```
public java.util.List<java.lang.String> getSecurityGroupIds()
```
    A list of security group names to associate with this cluster .
  - setSecurityGroupIds
```
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
```
    A list of security group names to associate with this cluster .
  - getSnapshotArns
```
public java.util.List<java.lang.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
```
public void setSnapshotArns(java.util.List<java.lang.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
```
public java.lang.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
```
public void setSnapshotName(java.lang.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
```
public java.lang.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
```
public void setSnapshotRetentionLimit(java.lang.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
```
public java.lang.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
```
public void setSnapshotWindow(java.lang.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
```
public java.lang.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
```
public void setSnsTopicArn(java.lang.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
```
public java.lang.String getSnsTopicStatus()
```
    The SNS topic must be in Active status to receive notifications.
  - setSnsTopicStatus
```
public void setSnsTopicStatus(java.lang.String value)
```
    The SNS topic must be in Active status to receive notifications.
  - getSubnetGroupName
```
public java.lang.String getSubnetGroupName()
```
    The name of the subnet group used by the cluster .
  - setSubnetGroupName
```
public void setSubnetGroupName(java.lang.String value)
```
    The name of the subnet group used by the cluster .
  - getTlsEnabled
```
public java.lang.Object getTlsEnabled()
```
    A flag to indicate if In-transit encryption is enabled.
  - setTlsEnabled
```
public void setTlsEnabled(java.lang.Boolean value)
```
    A flag to indicate if In-transit encryption is enabled.
  - setTlsEnabled
```
public void setTlsEnabled(IResolvable value)
```
    A flag to indicate if In-transit encryption is enabled.

Class CfnCluster

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnCluster

CfnCluster

CfnCluster

Method Detail

inspect

renderProperties

getAttrArn

getAttrClusterEndpointAddress

getAttrClusterEndpointPort

getAttrParameterGroupStatus

getAttrStatus

getCfnProperties

getTags

getAclName

setAclName

getClusterName

setClusterName

getNodeType

setNodeType

getAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

getClusterEndpoint

setClusterEndpoint

setClusterEndpoint

getDataTiering

setDataTiering

getDescription

setDescription

getEngineVersion

setEngineVersion

getFinalSnapshotName

setFinalSnapshotName

getKmsKeyId

setKmsKeyId

getMaintenanceWindow

setMaintenanceWindow

getNumReplicasPerShard

setNumReplicasPerShard

getNumShards

setNumShards

getParameterGroupName

setParameterGroupName

getPort

setPort

getSecurityGroupIds

setSecurityGroupIds

getSnapshotArns

setSnapshotArns

getSnapshotName

setSnapshotName

getSnapshotRetentionLimit

setSnapshotRetentionLimit

getSnapshotWindow

setSnapshotWindow

getSnsTopicArn

setSnsTopicArn

getSnsTopicStatus

setSnsTopicStatus

getSubnetGroupName

setSubnetGroupName

getTlsEnabled

setTlsEnabled

setTlsEnabled