db_cluster#

Exec module for managing Amazon DocDB DB Cluster.

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

Retrieves the specified AWS Document DB Cluster.

Parameters:

resource_id (str, Optional) – AWS Document DB Cluster Identifier. If resource_id is not given name will be used to retrieve the DB Cluster.
name (str) – An Idem name of the resource.

Examples

Calling this exec module function from the cli:

idem exec aws.docdb.db_cluster.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.get(
        ctx, name=name, resource_id=resource_id
    )

Using in a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.docdb.db_cluster.get
    - kwargs:
        name: name
        resource_id: resource_id

async idem_aws.exec.aws.docdb.db_cluster.list_(hub, ctx, name: str = None, filters: List = None)[source]#

Parameters:

name (str, Optional) – The name of idem state.
filters (list, Optional) – One or more filters, A complete list of filters can be found at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/docdb.html#DocDB.Client.describe_db_clusters

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 Doc DB Cluster 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.list name="idem_name"

Using in a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.docdb.db_cluster.list
    - kwargs:
        name: dbg1
        filters:
          - name: filter-name
            values:
                - filter_value