db_proxy_endpoints

Creates, updates, deletes, gets or lists a db_proxy_endpoints resource.

Overview

Name	db_proxy_endpoints
Type	Resource
Id	aws.rds.db_proxy_endpoints

Fields

The following fields are returned by SELECT queries:

describe_db_proxy_endpoints

Name	Datatype	Description
created_date	string	The date and time when the DB proxy endpoint was first created.
db_proxy_endpoint_arn	string	The Amazon Resource Name (ARN) for the DB proxy endpoint.
db_proxy_endpoint_name	string	The name for the DB proxy endpoint. 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.
db_proxy_name	string	The identifier for the DB proxy that is associated with this DB proxy endpoint.
endpoint	string	The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
endpoint_network_type	string	The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: IPV4 - The proxy endpoint supports IPv4 only. IPV6 - The proxy endpoint supports IPv6 only. DUAL - The proxy endpoint supports both IPv4 and IPv6.
is_default	boolean	Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
status	string	The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
target_role	string	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
vpc_id	string	Provides the VPC ID of the DB proxy endpoint.
vpc_security_group_ids	string	Provides a list of VPC security groups that the DB proxy endpoint belongs to.
vpc_subnet_ids	string	The EC2 subnet IDs for the DB proxy endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_proxy_endpoints	select	region	DBProxyName, DBProxyEndpointName, Filters, Marker, MaxRecords	Returns information about DB proxy endpoints.
create_db_proxy_endpoint	insert	DBProxyName, DBProxyEndpointName, VpcSubnetIds, region	VpcSecurityGroupIds, TargetRole, Tags, EndpointNetworkType	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.
modify_db_proxy_endpoint	update	DBProxyEndpointName, region	NewDBProxyEndpointName, VpcSecurityGroupIds	Changes the settings for an existing DB proxy endpoint.
delete_db_proxy_endpoint	delete	DBProxyEndpointName, region		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DBProxyEndpointName	string	The name of the DB proxy endpoint to delete.
DBProxyName	string	The name of the DB proxy associated with the DB proxy endpoint that you create.
VpcSubnetIds	array	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.
region	string	AWS region (default: us-east-1)
DBProxyEndpointName	string	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.
DBProxyName	string	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.
EndpointNetworkType	string	The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: IPV4 - The proxy endpoint supports IPv4 only. IPV6 - The proxy endpoint supports IPv6 only. DUAL - The proxy endpoint supports both IPv4 and IPv6. Default: IPV4 Constraints: If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block. If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.
Filters	array	This parameter is not currently supported.
Marker	string	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
NewDBProxyEndpointName	string	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.
Tags	array
TargetRole	string	The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
VpcSecurityGroupIds	array	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.

SELECT examples

describe_db_proxy_endpoints

Returns information about DB proxy endpoints.

SELECT
created_date,
db_proxy_endpoint_arn,
db_proxy_endpoint_name,
db_proxy_name,
endpoint,
endpoint_network_type,
is_default,
status,
target_role,
vpc_id,
vpc_security_group_ids,
vpc_subnet_ids
FROM aws.rds.db_proxy_endpoints
WHERE region = '{{ region }}' -- required
AND DBProxyName = '{{ DBProxyName }}'
AND DBProxyEndpointName = '{{ DBProxyEndpointName }}'
AND Filters = '{{ Filters }}'
AND Marker = '{{ Marker }}'
AND MaxRecords = '{{ MaxRecords }}'
;

INSERT examples

create_db_proxy_endpoint

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.

INSERT INTO aws.rds.db_proxy_endpoints (
DBProxyName,
DBProxyEndpointName,
VpcSubnetIds,
region,
VpcSecurityGroupIds,
TargetRole,
Tags,
EndpointNetworkType
)
SELECT 
'{{ DBProxyName }}',
'{{ DBProxyEndpointName }}',
'{{ VpcSubnetIds }}',
'{{ region }}',
'{{ VpcSecurityGroupIds }}',
'{{ TargetRole }}',
'{{ Tags }}',
'{{ EndpointNetworkType }}'
RETURNING
created_date,
db_proxy_endpoint_arn,
db_proxy_endpoint_name,
db_proxy_name,
endpoint,
endpoint_network_type,
is_default,
status,
target_role,
vpc_id,
vpc_security_group_ids,
vpc_subnet_ids
;

Manifest

# Description fields are for documentation purposes
- name: db_proxy_endpoints
props:
  - name: DBProxyName
    value: "{{ DBProxyName }}"
    description: Required parameter for the db_proxy_endpoints resource.
  - name: DBProxyEndpointName
    value: "{{ DBProxyEndpointName }}"
    description: Required parameter for the db_proxy_endpoints resource.
  - name: VpcSubnetIds
    value: "{{ VpcSubnetIds }}"
    description: Required parameter for the db_proxy_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_proxy_endpoints resource.
  - name: VpcSecurityGroupIds
    value: "{{ VpcSecurityGroupIds }}"
    description: 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.
    description: 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.
  - name: TargetRole
    value: "{{ TargetRole }}"
    description: The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
    description: The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
  - name: Tags
    value: "{{ Tags }}"
  - name: EndpointNetworkType
    value: "{{ EndpointNetworkType }}"
    description: The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: IPV4 - The proxy endpoint supports IPv4 only. IPV6 - The proxy endpoint supports IPv6 only. DUAL - The proxy endpoint supports both IPv4 and IPv6. Default: IPV4 Constraints: If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block. If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.
    description: The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: IPV4 - The proxy endpoint supports IPv4 only. IPV6 - The proxy endpoint supports IPv6 only. DUAL - The proxy endpoint supports both IPv4 and IPv6. Default: IPV4 Constraints: If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block. If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

UPDATE examples

modify_db_proxy_endpoint

Changes the settings for an existing DB proxy endpoint.

UPDATE aws.rds.db_proxy_endpoints
SET 
-- No updatable properties
WHERE 
DBProxyEndpointName = '{{ DBProxyEndpointName }}' --required
AND region = '{{ region }}' --required
AND NewDBProxyEndpointName = '{{ NewDBProxyEndpointName}}'
AND VpcSecurityGroupIds = '{{ VpcSecurityGroupIds}}'
RETURNING
created_date,
db_proxy_endpoint_arn,
db_proxy_endpoint_name,
db_proxy_name,
endpoint,
endpoint_network_type,
is_default,
status,
target_role,
vpc_id,
vpc_security_group_ids,
vpc_subnet_ids;

DELETE examples

delete_db_proxy_endpoint

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.

DELETE FROM aws.rds.db_proxy_endpoints
WHERE DBProxyEndpointName = '{{ DBProxyEndpointName }}' --required
AND region = '{{ region }}' --required
;