db_cluster#

Exec module for rds.db_cluster

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

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. 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_cluster.get.get resource_id=0123456789abcdef

async def my_func(hub, ctx):
    ret = await hub.exec.aws_auto.rds.db_cluster.get.get(ctx, resource_id=0123456789abcdef)

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

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. 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 clusters to describe.

Supported filters:

  • clone-group-id:

    Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

  • db-cluster-id:

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

  • domain:

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

  • engine:

    Accepts engine names. The results list only includes information about the DB clusters 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_cluster.list

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

aws_auto_rds_db_cluster_list_resource:
  exec.run:
    - path: aws_auto.rds.db_cluster.list