db_proxy_endpoint#

States module for managing Rds Db Proxy Endpoints.

async idem_aws.states.aws.rds.db_proxy_endpoint.present(hub, ctx, name: str, 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 = 'READ_WRITE', tags: ~typing.Dict[str, str] = None, resource_id: 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.

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

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

  • tags (Dict[str, str], Optional) – The tags to apply to the resource.

  • resource_id (str, Optional) – Db_proxy_endpoint unique ID. 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]

Example

idem_test_aws_auto.rds.db_proxy_endpoint_is_present:
    aws_auto.aws_auto.rds.db_proxy_endpoint.present:
    - db_proxy_name: string
    - db_proxy_endpoint_name: string
    - vpc_subnet_ids:
      - value
    - vpc_security_group_ids:
      - value
    - target_role: string
    - tags:
        key: value
async idem_aws.states.aws.rds.db_proxy_endpoint.absent(hub, ctx, name: str, resource_id: str = None, timeout: ~types.Specifies timeout for deletion of DB Proxy Endpoint.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:

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

  • resource_id (str) – The name of the DB proxy endpoint to delete.

  • timeout (dict, Optional) –

    Timeout configuration for delete of AWS RDS DB Proxy.

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

Example

idem_test_aws_auto.rds.db_proxy_endpoint_is_absent:
  aws_auto.aws_auto.rds.db_proxy_endpoint.absent:
  - db_proxy_endpoint_name: string
async idem_aws.states.aws.rds.db_proxy_endpoint.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 DB proxy endpoints.

Returns:

Dict[str, Any]

Example

$ idem describe aws_auto.rds.db_proxy_endpoint