Learn Idem

Learn Idem

Powered by Idem Project

aws.elasticache.cache_subnet_group

**Autogenerated function**

Deletes a cache subnet group.  You cannot delete a default cache subnet group or one that is associated with any
clusters.

Args:
    name(Text): An Idem name of the resource.
    resource_id(Text, optional): AWS Elasticache subnet group name to identify the resource.

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

        resource_is_absent:
          aws.elasticache.cache_subnet_group.absent:
            - name: value
**Autogenerated function**

Describe the resource in a way that can be recreated/managed with the corresponding "present" function


Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only
the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache
clusters now launch in VPC by default.


Returns:
    Dict[str, Any]

Examples:

    .. code-block:: bash

        $ idem describe aws.elasticache.cache_subnet_group
**Autogenerated function**

Creates a new cache subnet group. Use cache subnet group parameter only when you are creating a cluster in an Amazon Virtual
Private Cloud (Amazon VPC).

Args:
    name(Text): An Idem name of the resource.
    cache_subnet_group_description(Text): Description of the cache subnet group
    subnet_ids(list): A list of VPC subnet IDs for the cache subnet group.
    resource_id(Text, optional): AWS Elasticache subnet group name to identify the resource
    tags(Dict or List, optional): Dict in the format of {tag-key: tag-value} or List of tags in the format of
        [{"Key": tag-key, "Value": tag-value}] to associate with the cache subnet group
        Each tag consists of a key name and an associated value. Defaults to None.
        * Key (str, optional): The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode
            characters. May not begin with aws:.
        * Value(str, optional): The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256
            Unicode characters.

Request Syntax:
    [cache_subnet_group_name]:
      aws.elasticache.cache_subnet_group.present:
      - name: 'string'
      - cache_subnet_group_description: 'string'
      - subnet_ids: 'List'
      - tags:
        - Key: 'string'
          Value: 'string'

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

        cache_subnet_group_name:
          aws.elasticache.cache_subnet_group.present:
            - cache_subnet_group_description: "testing demo"
            - subnet_ids:
                - subnet-239e4b44
            - tags:
                - Key: Name
                  Value: test-elasticache

Full plugin documentation is available on the Idem documentation site - aws.elasticache.cache_subnet_group .

Last updated on 20 Sep 2022
 Edit on GitHub