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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.592Z")
 @Stability(value=Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::MemoryDB::Cluster`.

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)
         .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() `AWS::MemoryDB::Cluster.ACLName`.
default Object	getAutoMinorVersionUpgrade() `AWS::MemoryDB::Cluster.AutoMinorVersionUpgrade`.
String	getClusterName() `AWS::MemoryDB::Cluster.ClusterName`.
default String	getDescription() `AWS::MemoryDB::Cluster.Description`.
default String	getEngineVersion() `AWS::MemoryDB::Cluster.EngineVersion`.
default String	getFinalSnapshotName() `AWS::MemoryDB::Cluster.FinalSnapshotName`.
default String	getKmsKeyId() `AWS::MemoryDB::Cluster.KmsKeyId`.
default String	getMaintenanceWindow() `AWS::MemoryDB::Cluster.MaintenanceWindow`.
String	getNodeType() `AWS::MemoryDB::Cluster.NodeType`.
default Number	getNumReplicasPerShard() `AWS::MemoryDB::Cluster.NumReplicasPerShard`.
default Number	getNumShards() `AWS::MemoryDB::Cluster.NumShards`.
default String	getParameterGroupName() `AWS::MemoryDB::Cluster.ParameterGroupName`.
default Number	getPort() `AWS::MemoryDB::Cluster.Port`.
default List<String>	getSecurityGroupIds() `AWS::MemoryDB::Cluster.SecurityGroupIds`.
default List<String>	getSnapshotArns() `AWS::MemoryDB::Cluster.SnapshotArns`.
default String	getSnapshotName() `AWS::MemoryDB::Cluster.SnapshotName`.
default Number	getSnapshotRetentionLimit() `AWS::MemoryDB::Cluster.SnapshotRetentionLimit`.
default String	getSnapshotWindow() `AWS::MemoryDB::Cluster.SnapshotWindow`.
default String	getSnsTopicArn() `AWS::MemoryDB::Cluster.SnsTopicArn`.
default String	getSnsTopicStatus() `AWS::MemoryDB::Cluster.SnsTopicStatus`.
default String	getSubnetGroupName() `AWS::MemoryDB::Cluster.SubnetGroupName`.
default List<CfnTag>	getTags() `AWS::MemoryDB::Cluster.Tags`.
default Object	getTlsEnabled() `AWS::MemoryDB::Cluster.TLSEnabled`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAclName

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

`AWS::MemoryDB::Cluster.ACLName`.

getAutoMinorVersionUpgrade

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

`AWS::MemoryDB::Cluster.AutoMinorVersionUpgrade`.

getClusterName

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

`AWS::MemoryDB::Cluster.ClusterName`.

getDescription

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

`AWS::MemoryDB::Cluster.Description`.

getEngineVersion

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

`AWS::MemoryDB::Cluster.EngineVersion`.

getFinalSnapshotName

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

`AWS::MemoryDB::Cluster.FinalSnapshotName`.

getKmsKeyId

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

`AWS::MemoryDB::Cluster.KmsKeyId`.

getMaintenanceWindow

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

`AWS::MemoryDB::Cluster.MaintenanceWindow`.

getNodeType

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

`AWS::MemoryDB::Cluster.NodeType`.

getNumReplicasPerShard

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

`AWS::MemoryDB::Cluster.NumReplicasPerShard`.

getNumShards

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

`AWS::MemoryDB::Cluster.NumShards`.

getParameterGroupName

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

`AWS::MemoryDB::Cluster.ParameterGroupName`.

getPort

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

`AWS::MemoryDB::Cluster.Port`.

getSecurityGroupIds

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

`AWS::MemoryDB::Cluster.SecurityGroupIds`.

getSnapshotArns

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

`AWS::MemoryDB::Cluster.SnapshotArns`.

getSnapshotName

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

`AWS::MemoryDB::Cluster.SnapshotName`.

getSnapshotRetentionLimit

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

`AWS::MemoryDB::Cluster.SnapshotRetentionLimit`.

getSnapshotWindow

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

`AWS::MemoryDB::Cluster.SnapshotWindow`.

getSnsTopicArn

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

`AWS::MemoryDB::Cluster.SnsTopicArn`.

getSnsTopicStatus

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

`AWS::MemoryDB::Cluster.SnsTopicStatus`.

getSubnetGroupName

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

`AWS::MemoryDB::Cluster.SubnetGroupName`.

getTags

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

`AWS::MemoryDB::Cluster.Tags`.

getTlsEnabled

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

`AWS::MemoryDB::Cluster.TLSEnabled`.

builder

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

Returns:

a CfnClusterProps.Builder of CfnClusterProps