CfnCacheClusterPropsMixin

class aws_cdk.mixins_preview.aws_elasticache.mixins.CfnCacheClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html
CloudformationResource:: AWS::ElastiCache::CacheCluster
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_cache_cluster_props_mixin = elasticache_mixins.CfnCacheClusterPropsMixin(elasticache_mixins.CfnCacheClusterMixinProps(
    auto_minor_version_upgrade=False,
    az_mode="azMode",
    cache_node_type="cacheNodeType",
    cache_parameter_group_name="cacheParameterGroupName",
    cache_security_group_names=["cacheSecurityGroupNames"],
    cache_subnet_group_name="cacheSubnetGroupName",
    cluster_name="clusterName",
    engine="engine",
    engine_version="engineVersion",
    ip_discovery="ipDiscovery",
    log_delivery_configurations=[elasticache_mixins.CfnCacheClusterPropsMixin.LogDeliveryConfigurationRequestProperty(
        destination_details=elasticache_mixins.CfnCacheClusterPropsMixin.DestinationDetailsProperty(
            cloud_watch_logs_details=elasticache_mixins.CfnCacheClusterPropsMixin.CloudWatchLogsDestinationDetailsProperty(
                log_group="logGroup"
            ),
            kinesis_firehose_details=elasticache_mixins.CfnCacheClusterPropsMixin.KinesisFirehoseDestinationDetailsProperty(
                delivery_stream="deliveryStream"
            )
        ),
        destination_type="destinationType",
        log_format="logFormat",
        log_type="logType"
    )],
    network_type="networkType",
    notification_topic_arn="notificationTopicArn",
    num_cache_nodes=123,
    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"
    )],
    transit_encryption_enabled=False,
    vpc_security_group_ids=["vpcSecurityGroupIds"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ElastiCache::CacheCluster.

Parameters:

props (Union[CfnCacheClusterMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['autoMinorVersionUpgrade', 'azMode', 'cacheNodeType', 'cacheParameterGroupName', 'cacheSecurityGroupNames', 'cacheSubnetGroupName', 'clusterName', 'engine', 'engineVersion', 'ipDiscovery', 'logDeliveryConfigurations', 'networkType', 'notificationTopicArn', 'numCacheNodes', 'port', 'preferredAvailabilityZone', 'preferredAvailabilityZones', 'preferredMaintenanceWindow', 'snapshotArns', 'snapshotName', 'snapshotRetentionLimit', 'snapshotWindow', 'tags', 'transitEncryptionEnabled', 'vpcSecurityGroupIds']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CloudWatchLogsDestinationDetailsProperty

class CfnCacheClusterPropsMixin.CloudWatchLogsDestinationDetailsProperty(*, log_group=None)

Bases: object

Configuration details of a CloudWatch Logs destination.

Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.

Parameters:: log_group (Optional[str]) – The name of the CloudWatch Logs log group.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html
ExampleMetadata:: fixture=_generated

Example:

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

cloud_watch_logs_destination_details_property = elasticache_mixins.CfnCacheClusterPropsMixin.CloudWatchLogsDestinationDetailsProperty(
    log_group="logGroup"
)

Attributes

log_group

The name of the CloudWatch Logs log group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html#cfn-elasticache-cachecluster-cloudwatchlogsdestinationdetails-loggroup

DestinationDetailsProperty

class CfnCacheClusterPropsMixin.DestinationDetailsProperty(*, cloud_watch_logs_details=None, kinesis_firehose_details=None)

Bases: object

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

Parameters:

cloud_watch_logs_details (Union[IResolvable, CloudWatchLogsDestinationDetailsProperty, Dict[str, Any], None]) – The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
kinesis_firehose_details (Union[IResolvable, KinesisFirehoseDestinationDetailsProperty, Dict[str, Any], None]) – The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html

ExampleMetadata:

fixture=_generated

Example:

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

destination_details_property = elasticache_mixins.CfnCacheClusterPropsMixin.DestinationDetailsProperty(
    cloud_watch_logs_details=elasticache_mixins.CfnCacheClusterPropsMixin.CloudWatchLogsDestinationDetailsProperty(
        log_group="logGroup"
    ),
    kinesis_firehose_details=elasticache_mixins.CfnCacheClusterPropsMixin.KinesisFirehoseDestinationDetailsProperty(
        delivery_stream="deliveryStream"
    )
)

Attributes

cloud_watch_logs_details

The configuration details of the CloudWatch Logs destination.

Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-cloudwatchlogsdetails

kinesis_firehose_details

The configuration details of the Kinesis Data Firehose destination.

Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-kinesisfirehosedetails

KinesisFirehoseDestinationDetailsProperty

class CfnCacheClusterPropsMixin.KinesisFirehoseDestinationDetailsProperty(*, delivery_stream=None)

Bases: object

The configuration details of the Kinesis Data Firehose destination.

Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.

Parameters:: delivery_stream (Optional[str]) – The name of the Kinesis Data Firehose delivery stream.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html
ExampleMetadata:: fixture=_generated

Example:

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

kinesis_firehose_destination_details_property = elasticache_mixins.CfnCacheClusterPropsMixin.KinesisFirehoseDestinationDetailsProperty(
    delivery_stream="deliveryStream"
)

Attributes

delivery_stream

The name of the Kinesis Data Firehose delivery stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html#cfn-elasticache-cachecluster-kinesisfirehosedestinationdetails-deliverystream

LogDeliveryConfigurationRequestProperty

class CfnCacheClusterPropsMixin.LogDeliveryConfigurationRequestProperty(*, destination_details=None, destination_type=None, log_format=None, log_type=None)

Bases: object

Specifies the destination, format and type of the logs.

Parameters:

destination_details (Union[IResolvable, DestinationDetailsProperty, Dict[str, Any], None]) – Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
destination_type (Optional[str]) – Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose .
log_format (Optional[str]) – Valid values are either json or text .
log_type (Optional[str]) – Valid value is either slow-log , which refers to slow-log or engine-log .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html

ExampleMetadata:

fixture=_generated

Example:

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

log_delivery_configuration_request_property = elasticache_mixins.CfnCacheClusterPropsMixin.LogDeliveryConfigurationRequestProperty(
    destination_details=elasticache_mixins.CfnCacheClusterPropsMixin.DestinationDetailsProperty(
        cloud_watch_logs_details=elasticache_mixins.CfnCacheClusterPropsMixin.CloudWatchLogsDestinationDetailsProperty(
            log_group="logGroup"
        ),
        kinesis_firehose_details=elasticache_mixins.CfnCacheClusterPropsMixin.KinesisFirehoseDestinationDetailsProperty(
            delivery_stream="deliveryStream"
        )
    ),
    destination_type="destinationType",
    log_format="logFormat",
    log_type="logType"
)

Attributes

destination_details

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationdetails

destination_type

Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.

Valid values are either cloudwatch-logs or kinesis-firehose .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationtype

log_format

Valid values are either json or text .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logformat

log_type

Valid value is either slow-log , which refers to slow-log or engine-log .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logtype