software.amazon.awscdk.services.elasticache

Class CfnCacheCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticache.CfnCacheCluster

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:08.188Z")
 @Stability(value=Stable)
public class CfnCacheCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::CacheCluster`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCacheCluster.Builder A fluent builder for CfnCacheCluster.
static interface	CfnCacheCluster.CloudWatchLogsDestinationDetailsProperty
static interface	CfnCacheCluster.DestinationDetailsProperty
static interface	CfnCacheCluster.KinesisFirehoseDestinationDetailsProperty
static interface	CfnCacheCluster.LogDeliveryConfigurationRequestProperty

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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
	CfnCacheCluster(software.constructs.Construct scope, String id, CfnCacheClusterProps props) Create a new `AWS::ElastiCache::CacheCluster`.
protected	CfnCacheCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCacheCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrConfigurationEndpointAddress()
String	getAttrConfigurationEndpointPort()
String	getAttrRedisEndpointAddress()
String	getAttrRedisEndpointPort()
Object	getAutoMinorVersionUpgrade() `AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade`.
String	getAzMode() `AWS::ElastiCache::CacheCluster.AZMode`.
String	getCacheNodeType() `AWS::ElastiCache::CacheCluster.CacheNodeType`.
String	getCacheParameterGroupName() `AWS::ElastiCache::CacheCluster.CacheParameterGroupName`.
List<String>	getCacheSecurityGroupNames() `AWS::ElastiCache::CacheCluster.CacheSecurityGroupNames`.
String	getCacheSubnetGroupName() `AWS::ElastiCache::CacheCluster.CacheSubnetGroupName`.
protected Map<String,Object>	getCfnProperties()
String	getClusterName() `AWS::ElastiCache::CacheCluster.ClusterName`.
String	getEngine() `AWS::ElastiCache::CacheCluster.Engine`.
String	getEngineVersion() `AWS::ElastiCache::CacheCluster.EngineVersion`.
Object	getLogDeliveryConfigurations() `AWS::ElastiCache::CacheCluster.LogDeliveryConfigurations`.
String	getNotificationTopicArn() `AWS::ElastiCache::CacheCluster.NotificationTopicArn`.
Number	getNumCacheNodes() `AWS::ElastiCache::CacheCluster.NumCacheNodes`.
Number	getPort() `AWS::ElastiCache::CacheCluster.Port`.
String	getPreferredAvailabilityZone() `AWS::ElastiCache::CacheCluster.PreferredAvailabilityZone`.
List<String>	getPreferredAvailabilityZones() `AWS::ElastiCache::CacheCluster.PreferredAvailabilityZones`.
String	getPreferredMaintenanceWindow() `AWS::ElastiCache::CacheCluster.PreferredMaintenanceWindow`.
List<String>	getSnapshotArns() `AWS::ElastiCache::CacheCluster.SnapshotArns`.
String	getSnapshotName() `AWS::ElastiCache::CacheCluster.SnapshotName`.
Number	getSnapshotRetentionLimit() `AWS::ElastiCache::CacheCluster.SnapshotRetentionLimit`.
String	getSnapshotWindow() `AWS::ElastiCache::CacheCluster.SnapshotWindow`.
TagManager	getTags() `AWS::ElastiCache::CacheCluster.Tags`.
List<String>	getVpcSecurityGroupIds() `AWS::ElastiCache::CacheCluster.VpcSecurityGroupIds`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoMinorVersionUpgrade(Boolean value) `AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade`.
void	setAutoMinorVersionUpgrade(IResolvable value) `AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade`.
void	setAzMode(String value) `AWS::ElastiCache::CacheCluster.AZMode`.
void	setCacheNodeType(String value) `AWS::ElastiCache::CacheCluster.CacheNodeType`.
void	setCacheParameterGroupName(String value) `AWS::ElastiCache::CacheCluster.CacheParameterGroupName`.
void	setCacheSecurityGroupNames(List<String> value) `AWS::ElastiCache::CacheCluster.CacheSecurityGroupNames`.
void	setCacheSubnetGroupName(String value) `AWS::ElastiCache::CacheCluster.CacheSubnetGroupName`.
void	setClusterName(String value) `AWS::ElastiCache::CacheCluster.ClusterName`.
void	setEngine(String value) `AWS::ElastiCache::CacheCluster.Engine`.
void	setEngineVersion(String value) `AWS::ElastiCache::CacheCluster.EngineVersion`.
void	setLogDeliveryConfigurations(IResolvable value) `AWS::ElastiCache::CacheCluster.LogDeliveryConfigurations`.
void	setLogDeliveryConfigurations(List<Object> value) `AWS::ElastiCache::CacheCluster.LogDeliveryConfigurations`.
void	setNotificationTopicArn(String value) `AWS::ElastiCache::CacheCluster.NotificationTopicArn`.
void	setNumCacheNodes(Number value) `AWS::ElastiCache::CacheCluster.NumCacheNodes`.
void	setPort(Number value) `AWS::ElastiCache::CacheCluster.Port`.
void	setPreferredAvailabilityZone(String value) `AWS::ElastiCache::CacheCluster.PreferredAvailabilityZone`.
void	setPreferredAvailabilityZones(List<String> value) `AWS::ElastiCache::CacheCluster.PreferredAvailabilityZones`.
void	setPreferredMaintenanceWindow(String value) `AWS::ElastiCache::CacheCluster.PreferredMaintenanceWindow`.
void	setSnapshotArns(List<String> value) `AWS::ElastiCache::CacheCluster.SnapshotArns`.
void	setSnapshotName(String value) `AWS::ElastiCache::CacheCluster.SnapshotName`.
void	setSnapshotRetentionLimit(Number value) `AWS::ElastiCache::CacheCluster.SnapshotRetentionLimit`.
void	setSnapshotWindow(String value) `AWS::ElastiCache::CacheCluster.SnapshotWindow`.
void	setVpcSecurityGroupIds(List<String> value) `AWS::ElastiCache::CacheCluster.VpcSecurityGroupIds`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

CfnCacheCluster

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

CfnCacheCluster

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

CfnCacheCluster

@Stability(value=Stable)
public CfnCacheCluster(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnCacheClusterProps props)

Create a new `AWS::ElastiCache::CacheCluster`.

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.

getAttrConfigurationEndpointAddress

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

getAttrConfigurationEndpointPort

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

getAttrRedisEndpointAddress

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

getAttrRedisEndpointPort

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

getCacheNodeType

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

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

setCacheNodeType

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

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

getEngine

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

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

setEngine

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

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

getNumCacheNodes

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

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

setNumCacheNodes

@Stability(value=Stable)
public void setNumCacheNodes(@NotNull
                                                      Number value)

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

getAutoMinorVersionUpgrade

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

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

setAutoMinorVersionUpgrade

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

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

setAutoMinorVersionUpgrade

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

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

getAzMode

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

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

setAzMode

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

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

getCacheParameterGroupName

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

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

setCacheParameterGroupName

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

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

getCacheSecurityGroupNames

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

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

setCacheSecurityGroupNames

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

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

getCacheSubnetGroupName

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

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

setCacheSubnetGroupName

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

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

getClusterName

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

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

setClusterName

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

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

getEngineVersion

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

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

setEngineVersion

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

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

getLogDeliveryConfigurations

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

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

setLogDeliveryConfigurations

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

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

setLogDeliveryConfigurations

@Stability(value=Stable)
public void setLogDeliveryConfigurations(@Nullable
                                                                  List<Object> value)

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

getNotificationTopicArn

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

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

setNotificationTopicArn

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

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

getPort

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

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

setPort

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

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

getPreferredAvailabilityZone

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

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

setPreferredAvailabilityZone

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

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

getPreferredAvailabilityZones

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

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

setPreferredAvailabilityZones

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

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

getPreferredMaintenanceWindow

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

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

setPreferredMaintenanceWindow

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

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

getSnapshotArns

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

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

setSnapshotArns

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

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

getSnapshotName

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

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

setSnapshotName

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

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

getSnapshotRetentionLimit

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

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

setSnapshotRetentionLimit

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

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

getSnapshotWindow

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

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

setSnapshotWindow

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

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

getVpcSecurityGroupIds

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

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

setVpcSecurityGroupIds

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

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