db_proxy_target#

States module for managing Rds Db Proxy Targets.

async idem_aws.states.aws.rds.db_proxy_target.present(hub, ctx, name: str, db_proxy_name: str, target_group_name: str, db_instance_identifiers: List[str] = None, db_cluster_identifiers: List[str] = None, resource_id: str = None) → Dict[str, Any][source]#

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Parameters:

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

  • db_proxy_name (str) – The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

  • target_group_name (str, Optional) – The identifier of the DBProxyTargetGroup. Defaults to None.

  • db_instance_identifiers (List[str], Optional) – One or more DB instance identifiers. Defaults to None.

  • db_cluster_identifiers (List[str], Optional) – One or more DB cluster identifiers. Defaults to None.

  • resource_id (str, Optional) – Db_proxy_target unique ID. Defaults to None.

Returns:

Dict[str, Any]

Example

idem_test_aws_auto.rds.db_proxy_target_is_present:
    aws_auto.aws_auto.rds.db_proxy_target.present:
    - db_proxy_name: string
    - target_group_name: string
    - db_instance_identifiers:
      - value
    - db_cluster_identifiers:
      - value
    - tags: dict
async idem_aws.states.aws.rds.db_proxy_target.absent(hub, ctx, name: str, db_instance_identifiers: List[str] = None, db_cluster_identifiers: List[str] = None, resource_id: str = None) → Dict[str, Any][source]#

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

Parameters:

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

  • db_instance_identifiers (List[str], Optional) – One or more DB instance identifiers. Defaults to None.

  • db_cluster_identifiers (List[str], Optional) – One or more DB cluster identifiers. Defaults to None.

  • resource_id (str, Optional) – Db_proxy_target unique ID. Defaults to None.

Returns:

Dict[str, Any]

Example

idem_test_aws_auto.rds.db_proxy_target_is_absent:
  aws_auto.aws_auto.rds.db_proxy_target.absent:
  - target_group_name: string
  - db_instance_identifiers:
    - value
  - db_cluster_identifiers:
    - value
async idem_aws.states.aws.rds.db_proxy_target.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 information about DBProxyTarget objects. This API supports pagination.

Returns:

Dict[str, Any]

Example

$ idem describe aws_auto.rds.db_proxy_target