db_instance#

Exec module for rds.db_instance

async idem_aws.exec.aws.rds.db_instance.get(hub, ctx, resource_id: str, name: str = None) → Dict[str, Any][source]#

Returns information about provisioned RDS instances. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Args:
resource_id (str):

An identifier of the resource in the provider. Defaults to None.

name(str, Optional): Idem name of the resource. Defaults to None.

Examples:

idem exec aws_auto.rds.db_instance.get resource_id=0123456789abcdef

async def my_func(hub, ctx):
    ret = await hub.exec.aws_auto.rds.db_instance.get(ctx, resource_id="01235789abcdef")

aws_auto_rds_db_instance_get_resource:
  exec.run:
    - path: aws_auto.rds.db_instance.get
    - resource_id: 0123456789abcdef
async idem_aws.exec.aws.rds.db_instance.list_(hub, ctx, filters: List[Filter] = None) → Dict[str, Any][source]#

Returns information about provisioned RDS instances. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Args:
filters (list[Dict[str, Any]], Optional):

A filter that specifies one or more DB instances to describe.

Supported filters: * db-cluster-id (str, Optional):

Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

  • db-instance-id (str, Optional):

    Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

  • dbi-resource-id (str, Optional):

    Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain (str, Optional):

    Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

  • engine (str, Optional):

    Accepts engine names. The results list only includes information about the DB instances for these engines. Defaults to None.

  • Name (str):

    The name of the filter. Filter names are case-sensitive.

  • Values (list[str]):

    One or more filter values. Filter values are case-sensitive.

Examples:

idem exec aws_auto.rds.db_instance.list

async def my_func(hub, ctx):
    ret = await hub.exec.aws_auto.rds.db_instance.list(ctx)

aws_auto_rds_db_instance_list_resource:
  exec.run:
    - path: aws_auto.rds.db_instance.list