CfnSubnetGroupProps

class aws_cdk.aws_elasticache.CfnSubnetGroupProps(*, description, subnet_ids, cache_subnet_group_name=None, tags=None)

Bases: object

Properties for defining a CfnSubnetGroup.

Parameters
  • description (str) – The description for the cache subnet group.

  • subnet_ids (Sequence[str]) – The EC2 subnet IDs for the cache subnet group.

  • cache_subnet_group_name (Optional[str]) – The name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

ExampleMetadata

fixture=_generated

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_subnet_group_props = elasticache.CfnSubnetGroupProps(
    description="description",
    subnet_ids=["subnetIds"],

    # the properties below are optional
    cache_subnet_group_name="cacheSubnetGroupName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

cache_subnet_group_name

The name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-cachesubnetgroupname

Return type

Optional[str]

description

The description for the cache subnet group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-description

Return type

str

subnet_ids

The EC2 subnet IDs for the cache subnet group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-subnetids

Return type

List[str]

tags

A tag that can be added to an ElastiCache subnet group.

Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-tags

Return type

Optional[List[CfnTag]]