Learn Idem

Learn Idem

Powered by Idem Project

aws.elasticache.cache_parameter_group

**Autogenerated function**

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with
any cache clusters. You cannot delete the default cache parameter groups in your account.

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

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

        resource_is_absent:
          aws.elasticache.cache_parameter_group.absent:
            - resource_id: value
**Autogenerated function**

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


Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list
contains only the descriptions for that group.


Returns:
    Dict[str, Any]

Examples:

    .. code-block:: bash

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

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of
parameters and their values that are applied to all of the nodes in any cluster or replication group using the
CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group
for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values
of specific parameters. For more information, see:    ModifyCacheParameterGroup in the ElastiCache API
Reference.    Parameters and Parameter Groups in the ElastiCache User Guide.

Args:
    name(Text): An Idem name of the resource.
    cache_parameter_group_family (Text): The name of the cache parameter group family that this cache parameter group is compatible with.
    description (Text): The description for this cache parameter group.
    resource_id(Text, optional): AWS Elasticache parameter group name to identify the resource.
    parameter_name_values(List[Dict[str, str], optional): An array of parameter names and values for the parameter update.
    You must supply at least one parameter name and value; subsequent arguments are optional.
    A maximum of 20 parameters may be modified per request.
        * ParameterName (str, optional) -- The name of the parameter.
        * ParameterValue (str, optional) -- The value of the parameter.
    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 parameter 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.
Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls
        [cache_parameter_group_name]:
          aws.elasticache.cache_parameter_group.present:
            - cache_parameter_group_family: redis6.x
            - description: Customized default parameter group for redis6.x with cluster mode
                on
            - resource_id: 'string'
            - parameter_name_values:
              - parameter_name: acllog-max-len
                parameter_value: '128'
            - tags:
              - Key: 'string'
                Value: 'string'

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

Last updated on 20 Sep 2022
 Edit on GitHub