@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:38.854Z") public class CfnCluster extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCluster(Construct scope, java.lang.String id, CfnClusterProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrClusterEndpointAddress()
public java.lang.Number getAttrClusterEndpointPort()
public java.lang.String getAttrParameterGroupStatus()
public java.lang.String getAttrStatus()
For example, 'available', 'updating' or 'creating'.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getAclName()
public void setAclName(java.lang.String value)
public java.lang.String getClusterName()
public void setClusterName(java.lang.String value)
public java.lang.String getNodeType()
public void setNodeType(java.lang.String value)
public java.lang.Object getAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(java.lang.Boolean value)
public void setAutoMinorVersionUpgrade(IResolvable value)
public java.lang.Object getClusterEndpoint()
public void setClusterEndpoint(IResolvable value)
public void setClusterEndpoint(CfnCluster.EndpointProperty value)
public java.lang.String getDataTiering()
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 .
public void setDataTiering(java.lang.String value)
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 .
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getEngineVersion()
public void setEngineVersion(java.lang.String value)
public java.lang.String getFinalSnapshotName()
This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
public void setFinalSnapshotName(java.lang.String value)
This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
public java.lang.String getKmsKeyId()
public void setKmsKeyId(java.lang.String value)
public java.lang.String getMaintenanceWindow()
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
public void setMaintenanceWindow(java.lang.String value)
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
public java.lang.Number getNumReplicasPerShard()
Default value : 1
Maximum value : 5
public void setNumReplicasPerShard(java.lang.Number value)
Default value : 1
Maximum value : 5
public java.lang.Number getNumShards()
public void setNumShards(java.lang.Number value)
public java.lang.String getParameterGroupName()
public void setParameterGroupName(java.lang.String value)
public java.lang.Number getPort()
public void setPort(java.lang.Number value)
public java.util.List<java.lang.String> getSecurityGroupIds()
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
public java.util.List<java.lang.String> getSnapshotArns()
The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.
public void setSnapshotArns(java.util.List<java.lang.String> value)
The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.
public java.lang.String getSnapshotName()
The snapshot status changes to restoring while the new cluster is being created.
public void setSnapshotName(java.lang.String value)
The snapshot status changes to restoring while the new cluster is being created.
public java.lang.Number getSnapshotRetentionLimit()
For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
public void setSnapshotRetentionLimit(java.lang.Number value)
For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
public java.lang.String getSnapshotWindow()
Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
public void setSnapshotWindow(java.lang.String value)
Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
public java.lang.String getSnsTopicArn()
public void setSnsTopicArn(java.lang.String value)
public java.lang.String getSnsTopicStatus()
public void setSnsTopicStatus(java.lang.String value)
public java.lang.String getSubnetGroupName()
public void setSubnetGroupName(java.lang.String value)
public java.lang.Object getTlsEnabled()
public void setTlsEnabled(java.lang.Boolean value)
public void setTlsEnabled(IResolvable value)