cache_parameter_group#

State module for managing Amazon Elasticache Parameter Groups.

async idem_aws.states.aws.elasticache.cache_parameter_group.present(hub, ctx, name: str, cache_parameter_group_family: str, description: str, resource_id: str = None, parameter_name_values: ~typing.List[~types.A list of parameter names and values for the parameter update.ParameterNameValue] = None, tags: ~typing.Dict[str, ~typing.Any] = None) → Dict[str, Any][source]#

Creates an AWS Elasticache Parameter Group.

Parameters:

  • name (str) – An Idem name of the resource

  • resource_id (str, Optional) – The name of the AWS Elasticache Parameter Group in Amazon Web Services.

  • cache_parameter_group_family (str) – The name of the cache parameter group family that the cache parameter group can be used with. Valid values are memcached1.4, memcached1.5, memcached1.6, redis2.6, redis2.8, redis3.2, redis4.0, redis5.0, and redis6.x.

  • description (str) – A user-specified description for the cache parameter group.

  • parameter_name_values (list, Optional) –

    A list 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 parameter group.

    • Key (str):

      The key of the tag.

    • Value (str):

      The value of the tag.

Request Syntax:
[idem_test_aws_elasticache_cache_parameter_group]:
  aws.elasticache.cache_parameter_group.present:
    - name: 'string'
    - resource_id: 'string'
    - cache_parameter_group_family: 'memcached1.4|memcached1.5|memcached1.6|redis2.6|redis2.8|redis3.2|redis4.0|redis5.0|redis6.x'
    - description: 'string'
    - parameter_name_values:
        - ParameterName: 'string'
          ParameterValue: 'string'
    - tags:
        - Key: 'string'
          Value: 'string'
Returns:

Dict[str, Any]

Examples

idem_test_aws_elasticache_cache_parameter_group:
  aws.elasticache.cache_parameter_group.present:
    - name: 'idem_test_cache_parameter_group'
    - cache_parameter_group_family: 'redis6.x'
    - description: 'My Elasticache Parameter Group'
    - parameter_name_values:
      - ParameterName: 'acllog-max-len'
        ParameterValue: '128'
    - tags:
        - Key: 'provider'
          Value: 'idem'
async idem_aws.states.aws.elasticache.cache_parameter_group.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes the specified AWS Elasticache Parameter Group.

Warning

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.

Parameters:

  • name (str) – The name of the AWS Elasticache Parameter Group in Amazon Web Services.

  • resource_id (str, Optional) – The name of the AWS Elasticache Parameter Group in Amazon Web Services.

Request Syntax:
[idem_test_aws_elasticache_cache_parameter_group]:
  aws.elasticache.cache_parameter_group.absent:
    - name: 'string'
    - resource_id: 'string'
Returns:

Dict[str, Any]

Examples

idem_test_aws_elasticache_cache_parameter_group:
  aws.elasticache.cache_parameter_group.absent:
    - name: 'idem_test_cache_parameter_group'
async idem_aws.states.aws.elasticache.cache_parameter_group.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describes Elasticache Parameter Groups in a way that can be recreated/managed with the corresponding “present” function.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.elasticache.cache_parameter_group