db_subnet_group#

Exec module for managing DB Subnet Group resources.

async idem_aws.exec.aws.docdb.db_subnet_group.get(hub, ctx, resource_id: str)[source]#

Get Document DB Subnet Group details from AWS given a AWS Document DB Subnet Group Name.

Parameters:

resource_id (str) – AWS Document DB Subnet Group Name

Returns:

{"result": True|False, "comment": A message List, "ret": None|Dict}

Examples

Calling this exec module function from the cli with resource_id

idem exec aws.docdb.db_subnet_group.get resource_id="resource_id"

Using in a state:

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

async idem_aws.exec.aws.docdb.db_subnet_group.list_(hub, ctx, DBSubnetGroupName: str = None, filters: List = None) → Dict[source]#

Get list of Document DB Subnet Group details from AWS.

Use an un-managed DocDb Subnet as a data-source. Supply one of the inputs as the filter.

Parameters:

DBSubnetGroupName (str, Optional) – The name of the DBSubnetGroupName.
filters (list, Optional) – One or more filters: for example, tag :<key>, tag-key. 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_subnet_groups

Returns:

{"result": True|False, "comment": A message List, "ret": None|List}

Examples

Calling from the CLI:

idem exec aws.docdb.db_subnet_group.list DBSubnetGroupName=dbg1 filters='[{"name": "filter_name", "values": ["filter_value1"]}]'

Using in a state:

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