CfnServerlessCachePropsMixin

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

Bases: Mixin

The resource representing a serverless cache.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html
CloudformationResource:: AWS::ElastiCache::ServerlessCache
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_serverless_cache_props_mixin = elasticache_mixins.CfnServerlessCachePropsMixin(elasticache_mixins.CfnServerlessCacheMixinProps(
    cache_usage_limits=elasticache_mixins.CfnServerlessCachePropsMixin.CacheUsageLimitsProperty(
        data_storage=elasticache_mixins.CfnServerlessCachePropsMixin.DataStorageProperty(
            maximum=123,
            minimum=123,
            unit="unit"
        ),
        ecpu_per_second=elasticache_mixins.CfnServerlessCachePropsMixin.ECPUPerSecondProperty(
            maximum=123,
            minimum=123
        )
    ),
    daily_snapshot_time="dailySnapshotTime",
    description="description",
    endpoint=elasticache_mixins.CfnServerlessCachePropsMixin.EndpointProperty(
        address="address",
        port="port"
    ),
    engine="engine",
    final_snapshot_name="finalSnapshotName",
    kms_key_id="kmsKeyId",
    major_engine_version="majorEngineVersion",
    reader_endpoint=elasticache_mixins.CfnServerlessCachePropsMixin.EndpointProperty(
        address="address",
        port="port"
    ),
    security_group_ids=["securityGroupIds"],
    serverless_cache_name="serverlessCacheName",
    snapshot_arns_to_restore=["snapshotArnsToRestore"],
    snapshot_retention_limit=123,
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_group_id="userGroupId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnServerlessCacheMixinProps, 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 = ['cacheUsageLimits', 'dailySnapshotTime', 'description', 'endpoint', 'engine', 'finalSnapshotName', 'kmsKeyId', 'majorEngineVersion', 'readerEndpoint', 'securityGroupIds', 'serverlessCacheName', 'snapshotArnsToRestore', 'snapshotRetentionLimit', 'subnetIds', 'tags', 'userGroupId']

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

CacheUsageLimitsProperty

class CfnServerlessCachePropsMixin.CacheUsageLimitsProperty(*, data_storage=None, ecpu_per_second=None)

Bases: object

The usage limits for storage and ElastiCache Processing Units for the cache.

Parameters:

data_storage (Union[IResolvable, DataStorageProperty, Dict[str, Any], None]) – The maximum data storage limit in the cache, expressed in Gigabytes.
ecpu_per_second (Union[IResolvable, ECPUPerSecondProperty, Dict[str, Any], None]) – The number of ElastiCache Processing Units (ECPU) the cache can consume per second.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.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

cache_usage_limits_property = elasticache_mixins.CfnServerlessCachePropsMixin.CacheUsageLimitsProperty(
    data_storage=elasticache_mixins.CfnServerlessCachePropsMixin.DataStorageProperty(
        maximum=123,
        minimum=123,
        unit="unit"
    ),
    ecpu_per_second=elasticache_mixins.CfnServerlessCachePropsMixin.ECPUPerSecondProperty(
        maximum=123,
        minimum=123
    )
)

Attributes

data_storage

The maximum data storage limit in the cache, expressed in Gigabytes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.html#cfn-elasticache-serverlesscache-cacheusagelimits-datastorage

ecpu_per_second

The number of ElastiCache Processing Units (ECPU) the cache can consume per second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.html#cfn-elasticache-serverlesscache-cacheusagelimits-ecpupersecond

DataStorageProperty

class CfnServerlessCachePropsMixin.DataStorageProperty(*, maximum=None, minimum=None, unit=None)

Bases: object

The data storage limit.

Parameters:

maximum (Union[int, float, None]) – The upper limit for data storage the cache is set to use.
minimum (Union[int, float, None]) – The lower limit for data storage the cache is set to use.
unit (Optional[str]) – The unit that the storage is measured in, in GB.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.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

data_storage_property = elasticache_mixins.CfnServerlessCachePropsMixin.DataStorageProperty(
    maximum=123,
    minimum=123,
    unit="unit"
)

Attributes

maximum

The upper limit for data storage the cache is set to use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-maximum

minimum

The lower limit for data storage the cache is set to use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-minimum

unit

The unit that the storage is measured in, in GB.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-unit

ECPUPerSecondProperty

class CfnServerlessCachePropsMixin.ECPUPerSecondProperty(*, maximum=None, minimum=None)

Bases: object

The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.

Parameters:

maximum (Union[int, float, None]) – The configuration for the maximum number of ECPUs the cache can consume per second.
minimum (Union[int, float, None]) – The configuration for the minimum number of ECPUs the cache should be able consume per second.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.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

e_cPUPer_second_property = elasticache_mixins.CfnServerlessCachePropsMixin.ECPUPerSecondProperty(
    maximum=123,
    minimum=123
)

Attributes

maximum

The configuration for the maximum number of ECPUs the cache can consume per second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.html#cfn-elasticache-serverlesscache-ecpupersecond-maximum

minimum

The configuration for the minimum number of ECPUs the cache should be able consume per second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.html#cfn-elasticache-serverlesscache-ecpupersecond-minimum

EndpointProperty

class CfnServerlessCachePropsMixin.EndpointProperty(*, address=None, port=None)

Bases: object

Represents the information required for client programs to connect to a cache node.

This value is read-only.

Parameters:

address (Optional[str]) – The DNS hostname of the cache node.
port (Optional[str]) – The port number that the cache engine is listening on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.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

endpoint_property = elasticache_mixins.CfnServerlessCachePropsMixin.EndpointProperty(
    address="address",
    port="port"
)

Attributes

address

The DNS hostname of the cache node.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.html#cfn-elasticache-serverlesscache-endpoint-address

port

The port number that the cache engine is listening on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.html#cfn-elasticache-serverlesscache-endpoint-port