db_cluster_parameter_group#

Exec module for managing Amazon DocDB DB Cluster Parameter Group.

async idem_aws.exec.aws.docdb.db_cluster_parameter_group.get(hub, ctx, name: str, resource_id: str = None)[source]#

Retrieves the specified AWS Document DB Cluster Parameter Group.

Parameters:

  • resource_id (str, Optional) – AWS Document DB Cluster Parameter Group Name.

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

Examples

Calling this exec module function from the cli:

idem exec aws.docdb.db_cluster_parameter_group.get resource_id="resource_id" name="name"

async def state_function(hub, ctx, name, resource_id, **kwargs):
    ret = await hub.exec.aws.docdb.db_cluster_parameter_group.get(
        ctx, name=name, resource_id=resource_id
    )

Using in a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.docdb.db_cluster_parameter_group.get
    - kwargs:
        name: name
        resource_id: resource_id
async idem_aws.exec.aws.docdb.db_cluster_parameter_group.list_(hub, ctx, name: str = None, filters: List = None) → Dict[source]#

Use a list of un-managed docdb db cluster parameter groups as a data-source.

Parameters:

  • name (str, Optional) – The name of idem state.

  • filters (list, Optional) – One or more filters, dictionary of attribute value pair which will be converted to boto3 filter format.

Note

At the time of writing this module, filters parameter is not supported for this resource as per AWS documentation so idem-aws has omitted it.

Returns:

result(bool):

Whether the result of the function has been successful (True) or not (False).

comment(list):

A list of messages.

ret(dict or None):

The AWS DocDB DB Cluster Parameter Group in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.docdb.db_cluster_parameter_group.list name=name

Calling this exec module function from within a state module in pure python:

async def state_function(hub, ctx, name, **kwargs):
    ret = await hub.exec.aws.docdb.db_cluster_parameter_group.list(
        ctx, name=name
    )

Calling this exec module function from within a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.docdb.db_cluster_parameter_group.list
    - kwargs:
        name: 'test-doc-db-cluster-param-group'