db_proxy_target#

Exec module for managing Rds Db Proxy Targets.

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

Returns information about DBProxyTarget objects. This API supports pagination.

Parameters:

  • db_proxy_name (str, Optional) – The identifier of the DBProxyTarget to describe.

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

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

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

Returns:

Dict[str, Any]

Examples

Resource State:

unmanaged_resource:
  exec.run:
    - path: aws.rds.db_proxy_target.get
    - kwargs:
      db_proxy_name: value
      resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_target.get db_proxy_name=value, resource_id=value
async idem_aws.exec.aws.rds.db_proxy_target.list_(hub, ctx, db_proxy_name: str, target_group_name: str = 'default', name: str = None) → Dict[str, Any][source]#

Returns information about DBProxyTarget objects. This API supports pagination.

Parameters:

  • db_proxy_name (str) – The identifier of the DBProxy to describe.

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

  • filters (List[dict[str, Any]], Optional) –

    This parameter is not currently supported. 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.

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

Returns:

Dict[str, Any]

Examples

Resource State:

unmanaged_resources:
  exec.run:
    - path: aws.rds.db_proxy_target.list
    - kwargs:
      db_proxy_name: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_target.list db_proxy_name=value

Describe call from the CLI:

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

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Parameters:

  • 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.

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

Returns:

Dict[str, Any]

Examples

Using in a state:

resource_is_present:
  aws.rds.db_proxy_target.present:
    - db_proxy_name: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_target.create db_proxy_name=value
async idem_aws.exec.aws.rds.db_proxy_target.delete(hub, ctx, resource_id: str, db_instance_identifiers: List[str] = None, db_cluster_identifiers: List[str] = None, name: str = None) → Dict[str, Any][source]#

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

Parameters:

  • resource_id (str) – Db_proxy_target unique ID.

  • 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.

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

Returns:

Dict[str, Any]

Examples

Resource State:

resource_is_absent:
  aws.rds.db_proxy_target.absent:
    - db_proxy_name: value
    - resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_target.delete db_proxy_name=value, resource_id=value