db_subnet_group#

State module for AWS neptune DB Subnet Group.

async idem_aws.states.aws.neptune.db_subnet_group.present(hub, ctx, name: str, db_subnet_group_description: str, subnet_ids: List[str], resource_id: str = None, tags: Dict[str, Any] = None) → Dict[str, Any][source]#

Creates a new DB subnet group.

DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

Parameters:

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

  • db_subnet_group_description (str) – The description for the DB subnet group.

  • subnet_ids (list[str]) – The EC2 Subnet IDs for the DB subnet group.

  • resource_id (str, Optional) – AWS Neptune DB Subnet Group Name. Defaults to None.

  • tags (list or dict, Optional) –

    The tags to assign to the new DB subnet group. Defaults to None.

    • Key(str):

      The key of the tag. Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

    • Value(str):

      The value of the tag. Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Request Syntax:
[idem_test_aws_neptune_db_subnet_group]:
    aws.neptune.db_subnet_group.present:
        - name: 'string'
        - db_subnet_group_description: 'string'
        - subnet_ids:
            - 'string'
            - 'string'
        - resource_id: 'string'
        - tags:
            - Key: 'string'
            - Value: 'string'
Returns:

Dict[str, Dict[str,Any]]

Examples

resource_is_present:
  aws.neptune.db_subnet_group.present:
    - name: value
    - db_subnet_group_description: value
    - subnet_ids:
      - subnet-123124324
      - subnet-123124322
async idem_aws.states.aws.neptune.db_subnet_group.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

Parameters:

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

  • resource_id (str, Optional) – AWS Neptune DB Subnet Group Name. Defaults to None.

Request Syntax:
[idem_test_aws_neptune_db_subnet_group]:
    aws.neptune.db_subnet_group.present:
        - name: 'string'
        - resource_id: 'string'
Returns:

Dict[str, Dict[str,Any]]

Examples

resource_is_absent:
  aws.neptune.db_subnet_group.absent:
    - name: value
    - resource_id: value
async idem_aws.states.aws.neptune.db_subnet_group.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Returns a list of DBSubnetGroup descriptions.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.neptune.db_subnet_group