Learn Idem

Learn Idem

Powered by Idem Project

aws.docdb.db_subnet_group

**Autogenerated function**

Deletes a subnet group.  The specified database subnet group must not be associated with any DB instances.
Idem automatically considers this resource being absent if this field is not specified

Args:
    name(Text): An Idem name of the resource.
    resource_id(Text, Optional): AWS DocumentDB Subnet Group Name. Defaults to None.

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

        resource_is_absent:
          aws.docdb.db_subnet_group.absent:
            - name: value
            - 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 DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only
the descriptions of the specified DBSubnetGroup.

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: bash

        $ idem describe aws.docdb.db_subnet_group
**Autogenerated function**

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in
the Amazon Web Services Region.

Args:
    name(Text): An Idem name of the resource.
    resource_id(Text, optional): AWS DocumentDB Subnet Group Name. Defaults to None.
    db_subnet_group_description(Text): The description for the subnet group.
    subnet_ids(List): The Amazon EC2 subnet IDs for the subnet group.
    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}]. The tags to be assigned to the subnet group. Defaults to None.

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

        resource_is_present:
          aws.docdb.db_subnet_group.present:
            - name: value
            - resource_id: value
            - db_subnet_group_description: value
            - subnet_ids: value

Full plugin documentation is available on the Idem documentation site - aws.docdb.db_subnet_group .

Last updated on 20 Sep 2022
 Edit on GitHub