CfnCacheClusterProps

class aws_cdk.aws_elasticache.CfnCacheClusterProps(*, auto_minor_version_upgrade=None, az_mode=None, cache_node_type, cache_parameter_group_name=None, cache_security_group_names=None, cache_subnet_group_name=None, cluster_name=None, engine, engine_version=None, log_delivery_configurations=None, notification_topic_arn=None, num_cache_nodes, port=None, preferred_availability_zone=None, preferred_availability_zones=None, preferred_maintenance_window=None, snapshot_arns=None, snapshot_name=None, snapshot_retention_limit=None, snapshot_window=None, tags=None, vpc_security_group_ids=None)

Bases: object

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

Parameters
  • auto_minor_version_upgrade (Union[bool, IResolvable, None]) – AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade.

  • az_mode (Optional[str]) – AWS::ElastiCache::CacheCluster.AZMode.

  • cache_node_type (str) – AWS::ElastiCache::CacheCluster.CacheNodeType.

  • cache_parameter_group_name (Optional[str]) – AWS::ElastiCache::CacheCluster.CacheParameterGroupName.

  • cache_security_group_names (Optional[Sequence[str]]) – AWS::ElastiCache::CacheCluster.CacheSecurityGroupNames.

  • cache_subnet_group_name (Optional[str]) – AWS::ElastiCache::CacheCluster.CacheSubnetGroupName.

  • cluster_name (Optional[str]) – AWS::ElastiCache::CacheCluster.ClusterName.

  • engine (str) – AWS::ElastiCache::CacheCluster.Engine.

  • engine_version (Optional[str]) – AWS::ElastiCache::CacheCluster.EngineVersion.

  • log_delivery_configurations (Union[IResolvable, Sequence[Union[IResolvable, LogDeliveryConfigurationRequestProperty]], None]) – AWS::ElastiCache::CacheCluster.LogDeliveryConfigurations.

  • notification_topic_arn (Optional[str]) – AWS::ElastiCache::CacheCluster.NotificationTopicArn.

  • num_cache_nodes (Union[int, float]) – AWS::ElastiCache::CacheCluster.NumCacheNodes.

  • port (Union[int, float, None]) – AWS::ElastiCache::CacheCluster.Port.

  • preferred_availability_zone (Optional[str]) – AWS::ElastiCache::CacheCluster.PreferredAvailabilityZone.

  • preferred_availability_zones (Optional[Sequence[str]]) – AWS::ElastiCache::CacheCluster.PreferredAvailabilityZones.

  • preferred_maintenance_window (Optional[str]) – AWS::ElastiCache::CacheCluster.PreferredMaintenanceWindow.

  • snapshot_arns (Optional[Sequence[str]]) – AWS::ElastiCache::CacheCluster.SnapshotArns.

  • snapshot_name (Optional[str]) – AWS::ElastiCache::CacheCluster.SnapshotName.

  • snapshot_retention_limit (Union[int, float, None]) – AWS::ElastiCache::CacheCluster.SnapshotRetentionLimit.

  • snapshot_window (Optional[str]) – AWS::ElastiCache::CacheCluster.SnapshotWindow.

  • tags (Optional[Sequence[CfnTag]]) – AWS::ElastiCache::CacheCluster.Tags.

  • vpc_security_group_ids (Optional[Sequence[str]]) – AWS::ElastiCache::CacheCluster.VpcSecurityGroupIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticache as elasticache

cfn_cache_cluster_props = elasticache.CfnCacheClusterProps(
    cache_node_type="cacheNodeType",
    engine="engine",
    num_cache_nodes=123,

    # the properties below are optional
    auto_minor_version_upgrade=False,
    az_mode="azMode",
    cache_parameter_group_name="cacheParameterGroupName",
    cache_security_group_names=["cacheSecurityGroupNames"],
    cache_subnet_group_name="cacheSubnetGroupName",
    cluster_name="clusterName",
    engine_version="engineVersion",
    log_delivery_configurations=[elasticache.CfnCacheCluster.LogDeliveryConfigurationRequestProperty(
        destination_details=elasticache.CfnCacheCluster.DestinationDetailsProperty(
            cloud_watch_logs_details=elasticache.CfnCacheCluster.CloudWatchLogsDestinationDetailsProperty(
                log_group="logGroup"
            ),
            kinesis_firehose_details=elasticache.CfnCacheCluster.KinesisFirehoseDestinationDetailsProperty(
                delivery_stream="deliveryStream"
            )
        ),
        destination_type="destinationType",
        log_format="logFormat",
        log_type="logType"
    )],
    notification_topic_arn="notificationTopicArn",
    port=123,
    preferred_availability_zone="preferredAvailabilityZone",
    preferred_availability_zones=["preferredAvailabilityZones"],
    preferred_maintenance_window="preferredMaintenanceWindow",
    snapshot_arns=["snapshotArns"],
    snapshot_name="snapshotName",
    snapshot_retention_limit=123,
    snapshot_window="snapshotWindow",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Attributes

auto_minor_version_upgrade

AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-autominorversionupgrade

Return type

Union[bool, IResolvable, None]

az_mode

AWS::ElastiCache::CacheCluster.AZMode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-azmode

Return type

Optional[str]

cache_node_type

AWS::ElastiCache::CacheCluster.CacheNodeType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachenodetype

Return type

str

cache_parameter_group_name

AWS::ElastiCache::CacheCluster.CacheParameterGroupName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cacheparametergroupname

Return type

Optional[str]

cache_security_group_names

AWS::ElastiCache::CacheCluster.CacheSecurityGroupNames.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesecuritygroupnames

Return type

Optional[List[str]]

cache_subnet_group_name

AWS::ElastiCache::CacheCluster.CacheSubnetGroupName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesubnetgroupname

Return type

Optional[str]

cluster_name

AWS::ElastiCache::CacheCluster.ClusterName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-clustername

Return type

Optional[str]

engine

AWS::ElastiCache::CacheCluster.Engine.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engine

Return type

str

engine_version

AWS::ElastiCache::CacheCluster.EngineVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engineversion

Return type

Optional[str]

log_delivery_configurations

AWS::ElastiCache::CacheCluster.LogDeliveryConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-logdeliveryconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, LogDeliveryConfigurationRequestProperty]], None]

notification_topic_arn

AWS::ElastiCache::CacheCluster.NotificationTopicArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-notificationtopicarn

Return type

Optional[str]

num_cache_nodes

AWS::ElastiCache::CacheCluster.NumCacheNodes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-numcachenodes

Return type

Union[int, float]

port

AWS::ElastiCache::CacheCluster.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-port

Return type

Union[int, float, None]

preferred_availability_zone

AWS::ElastiCache::CacheCluster.PreferredAvailabilityZone.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzone

Return type

Optional[str]

preferred_availability_zones

AWS::ElastiCache::CacheCluster.PreferredAvailabilityZones.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzones

Return type

Optional[List[str]]

preferred_maintenance_window

AWS::ElastiCache::CacheCluster.PreferredMaintenanceWindow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredmaintenancewindow

Return type

Optional[str]

snapshot_arns

AWS::ElastiCache::CacheCluster.SnapshotArns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotarns

Return type

Optional[List[str]]

snapshot_name

AWS::ElastiCache::CacheCluster.SnapshotName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotname

Return type

Optional[str]

snapshot_retention_limit

AWS::ElastiCache::CacheCluster.SnapshotRetentionLimit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotretentionlimit

Return type

Union[int, float, None]

snapshot_window

AWS::ElastiCache::CacheCluster.SnapshotWindow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotwindow

Return type

Optional[str]

tags

AWS::ElastiCache::CacheCluster.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-tags

Return type

Optional[List[CfnTag]]

vpc_security_group_ids

AWS::ElastiCache::CacheCluster.VpcSecurityGroupIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-vpcsecuritygroupids

Return type

Optional[List[str]]