software.amazon.awscdk.services.elasticache

Interface CfnCacheClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCacheClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.472Z")
 @Stability(value=Stable)
public interface CfnCacheClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ElastiCache::CacheCluster`.

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.elasticache.*;
 CfnCacheClusterProps cfnCacheClusterProps = CfnCacheClusterProps.builder()
         .cacheNodeType("cacheNodeType")
         .engine("engine")
         .numCacheNodes(123)
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .azMode("azMode")
         .cacheParameterGroupName("cacheParameterGroupName")
         .cacheSecurityGroupNames(List.of("cacheSecurityGroupNames"))
         .cacheSubnetGroupName("cacheSubnetGroupName")
         .clusterName("clusterName")
         .engineVersion("engineVersion")
         .logDeliveryConfigurations(List.of(LogDeliveryConfigurationRequestProperty.builder()
                 .destinationDetails(DestinationDetailsProperty.builder()
                         .cloudWatchLogsDetails(CloudWatchLogsDestinationDetailsProperty.builder()
                                 .logGroup("logGroup")
                                 .build())
                         .kinesisFirehoseDetails(KinesisFirehoseDestinationDetailsProperty.builder()
                                 .deliveryStream("deliveryStream")
                                 .build())
                         .build())
                 .destinationType("destinationType")
                 .logFormat("logFormat")
                 .logType("logType")
                 .build()))
         .notificationTopicArn("notificationTopicArn")
         .port(123)
         .preferredAvailabilityZone("preferredAvailabilityZone")
         .preferredAvailabilityZones(List.of("preferredAvailabilityZones"))
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .snapshotArns(List.of("snapshotArns"))
         .snapshotName("snapshotName")
         .snapshotRetentionLimit(123)
         .snapshotWindow("snapshotWindow")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCacheClusterProps.Builder	builder()
default Object	getAutoMinorVersionUpgrade() `AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade`.
default String	getAzMode() `AWS::ElastiCache::CacheCluster.AZMode`.
String	getCacheNodeType() `AWS::ElastiCache::CacheCluster.CacheNodeType`.
default String	getCacheParameterGroupName() `AWS::ElastiCache::CacheCluster.CacheParameterGroupName`.
default List<String>	getCacheSecurityGroupNames() `AWS::ElastiCache::CacheCluster.CacheSecurityGroupNames`.
default String	getCacheSubnetGroupName() `AWS::ElastiCache::CacheCluster.CacheSubnetGroupName`.
default String	getClusterName() `AWS::ElastiCache::CacheCluster.ClusterName`.
String	getEngine() `AWS::ElastiCache::CacheCluster.Engine`.
default String	getEngineVersion() `AWS::ElastiCache::CacheCluster.EngineVersion`.
default Object	getLogDeliveryConfigurations() `AWS::ElastiCache::CacheCluster.LogDeliveryConfigurations`.
default String	getNotificationTopicArn() `AWS::ElastiCache::CacheCluster.NotificationTopicArn`.
Number	getNumCacheNodes() `AWS::ElastiCache::CacheCluster.NumCacheNodes`.
default Number	getPort() `AWS::ElastiCache::CacheCluster.Port`.
default String	getPreferredAvailabilityZone() `AWS::ElastiCache::CacheCluster.PreferredAvailabilityZone`.
default List<String>	getPreferredAvailabilityZones() `AWS::ElastiCache::CacheCluster.PreferredAvailabilityZones`.
default String	getPreferredMaintenanceWindow() `AWS::ElastiCache::CacheCluster.PreferredMaintenanceWindow`.
default List<String>	getSnapshotArns() `AWS::ElastiCache::CacheCluster.SnapshotArns`.
default String	getSnapshotName() `AWS::ElastiCache::CacheCluster.SnapshotName`.
default Number	getSnapshotRetentionLimit() `AWS::ElastiCache::CacheCluster.SnapshotRetentionLimit`.
default String	getSnapshotWindow() `AWS::ElastiCache::CacheCluster.SnapshotWindow`.
default List<CfnTag>	getTags() `AWS::ElastiCache::CacheCluster.Tags`.
default List<String>	getVpcSecurityGroupIds() `AWS::ElastiCache::CacheCluster.VpcSecurityGroupIds`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoMinorVersionUpgrade

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

`AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade`.

getAzMode

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

`AWS::ElastiCache::CacheCluster.AZMode`.

getCacheNodeType

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

`AWS::ElastiCache::CacheCluster.CacheNodeType`.

getCacheParameterGroupName

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

`AWS::ElastiCache::CacheCluster.CacheParameterGroupName`.

getCacheSecurityGroupNames

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

`AWS::ElastiCache::CacheCluster.CacheSecurityGroupNames`.

getCacheSubnetGroupName

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

`AWS::ElastiCache::CacheCluster.CacheSubnetGroupName`.

getClusterName

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

`AWS::ElastiCache::CacheCluster.ClusterName`.

getEngine

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

`AWS::ElastiCache::CacheCluster.Engine`.

getEngineVersion

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

`AWS::ElastiCache::CacheCluster.EngineVersion`.

getLogDeliveryConfigurations

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

`AWS::ElastiCache::CacheCluster.LogDeliveryConfigurations`.

getNotificationTopicArn

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

`AWS::ElastiCache::CacheCluster.NotificationTopicArn`.

getNumCacheNodes

@Stability(value=Stable)
 @NotNull
Number getNumCacheNodes()

`AWS::ElastiCache::CacheCluster.NumCacheNodes`.

getPort

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

`AWS::ElastiCache::CacheCluster.Port`.

getPreferredAvailabilityZone

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

`AWS::ElastiCache::CacheCluster.PreferredAvailabilityZone`.

getPreferredAvailabilityZones

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

`AWS::ElastiCache::CacheCluster.PreferredAvailabilityZones`.

getPreferredMaintenanceWindow

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

`AWS::ElastiCache::CacheCluster.PreferredMaintenanceWindow`.

getSnapshotArns

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

`AWS::ElastiCache::CacheCluster.SnapshotArns`.

getSnapshotName

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

`AWS::ElastiCache::CacheCluster.SnapshotName`.

getSnapshotRetentionLimit

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

`AWS::ElastiCache::CacheCluster.SnapshotRetentionLimit`.

getSnapshotWindow

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

`AWS::ElastiCache::CacheCluster.SnapshotWindow`.

getTags

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

`AWS::ElastiCache::CacheCluster.Tags`.

getVpcSecurityGroupIds

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

`AWS::ElastiCache::CacheCluster.VpcSecurityGroupIds`.

builder

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

Returns:

a CfnCacheClusterProps.Builder of CfnCacheClusterProps