db_proxy_endpoint#

Exec module for managing Rds Db Proxy Endpoints.

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

Returns information about DB proxy endpoints.

Parameters:

resource_id (str, Optional) – The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy. Defaults to None.
db_proxy_name (str, Optional) – The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies. 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_resource:
  exec.run:
    - path: aws.rds.db_proxy_endpoint.get
    - kwargs:
      resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_endpoint.get resource_id=value

async idem_aws.exec.aws.rds.db_proxy_endpoint.list_(hub, ctx, db_proxy_name: str = None, resource_id: str = None, filters: List[Filter] = None, name: str = None) → Dict[str, Any][source]#

Returns information about DB proxy endpoints.

Parameters:

db_proxy_name (str, Optional) – The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies. Defaults to None.
resource_id (str, Optional) – The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy. 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_endpoint.list
    - kwargs:

Exec call from the CLI:

idem exec aws.rds.db_proxy_endpoint.list

Describe call from the CLI:

$ idem describe aws.rds.db_proxy_endpoint

async idem_aws.exec.aws.rds.db_proxy_endpoint.create(hub, ctx, db_proxy_name: str, db_proxy_endpoint_name: str, vpc_subnet_ids: ~typing.List[str], vpc_security_group_ids: ~typing.List[str] = None, target_role: str = None, tags: ~typing.Dict[str, str] = None, resource_id: str = None, name: str = None, timeout: ~types.Timeout configuration.Timeout = None) → Dict[str, Any][source]#

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy’s default VPC.

Parameters:

db_proxy_name (str) – The name of the DB proxy associated with the DB proxy endpoint that you create.
db_proxy_endpoint_name (str) – The name of the DB proxy endpoint to create.
vpc_subnet_ids (List[str]) – The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
vpc_security_group_ids (List[str], Optional) – The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC. Defaults to None.
target_role (str, Optional) – A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE. Defaults to None.
tags (Dict[str, str], Optional) – The tags to apply to the resource.
resource_id (str, Optional) – Db_proxy_endpoint unique ID. Defaults to None.
name (str, Optional) – Idem name of the resource. Defaults to None.
timeout (dict, Optional) –
Timeout configuration for create/update of AWS DB Cluster.
- create (dict, Optional):
  Timeout configuration for creating DB Cluster.
  - delay(int, Optional):
    The amount of time in seconds to wait between attempts.
  - max_attempts(int, Optional):
    Customized timeout configuration containing delay and max attempts.
- update(dict, Optional):
  Timeout configuration for updating DB Cluster
  - delay(int, Optional):
    The amount of time in seconds to wait between attempts.
  - max_attempts(int, Optional):
    Customized timeout configuration containing delay and max attempts.

Returns:

Dict[str, Any]

Examples

Using in a state:

resource_is_present:
  aws.rds.db_proxy_endpoint.present:
    - db_proxy_name: value
    - db_proxy_endpoint_name: value
    - vpc_subnet_ids: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_endpoint.create db_proxy_name=value, db_proxy_endpoint_name=value, vpc_subnet_ids=value

async idem_aws.exec.aws.rds.db_proxy_endpoint.update(hub, ctx, resource_id: str, tags: ~typing.Dict[str, str] = None, db_proxy_endpoint_name: str = None, new_db_proxy_endpoint_name: str = None, vpc_security_group_ids: ~typing.List[str] = None, name: str = None, timeout: ~types.Timeout configuration.Timeout = None) → Dict[str, Any][source]#

Changes the settings for an existing DB proxy endpoint.

Parameters:

resource_id (str) – The name of the DB proxy associated with the DB proxy endpoint that you want to modify.
tags (dict, Optional) – The tags to apply to the resource. Defaults to None.
db_proxy_endpoint_name (str, Optional) – Name of the DBProxyEndpoint.
new_db_proxy_endpoint_name (str, Optional) – The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens. Defaults to None.
vpc_security_group_ids (List[str], Optional) – The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy. Defaults to None.
name (str, Optional) – Idem name of the resource. Defaults to None.
timeout (dict, Optional) –
Timeout configuration for create/update of AWS DB Cluster.
- create (dict, Optional):
  Timeout configuration for creating DB Cluster.
  - delay(int, Optional):
    The amount of time in seconds to wait between attempts.
  - max_attempts(int, Optional):
    Customized timeout configuration containing delay and max attempts.
- update(dict, Optional):
  Timeout configuration for updating DB Cluster
  - delay(int, Optional):
    The amount of time in seconds to wait between attempts.
  - max_attempts(int, Optional):
    Customized timeout configuration containing delay and max attempts.

Returns:

Dict[str, Any]

Examples

Using in a state:

resource_is_present:
  aws.rds.db_proxy_endpoint.present:
    - db_proxy_endpoint_name: value
    - tags: value
    - resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_endpoint.update db_proxy_endpoint_name=value, tags=value, resource_id=value

async idem_aws.exec.aws.rds.db_proxy_endpoint.delete(hub, ctx, resource_id: str, name: str = None, timeout: ~types.Timeout configuration.Timeout = None) → Dict[str, Any][source]#

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy’s default VPC.

Parameters:

resource_id (str) – The name of the DB proxy endpoint to delete.
name (str, Optional) – Idem name of the resource. Defaults to None.
timeout (dict, Optional) –
Timeout configuration for create/update of AWS DB Proxy Endpoint.
- delete (dict, Optional):
  Timeout configuration for deleting DB Cluster.
  - delay(int, Optional):
    The amount of time in seconds to wait between attempts.
  - max_attempts(int, Optional):
    Customized timeout configuration containing delay and max attempts.

Returns:

Dict[str, Any]

Examples

Resource State:

resource_is_absent:
  aws.rds.db_proxy_endpoint.absent:
    - resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy_endpoint.delete resource_id=value