db_cluster_endpoints

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

Overview

Name	db_cluster_endpoints
Type	Resource
Id	aws.rds.db_cluster_endpoints

Fields

The following fields are returned by SELECT queries:

describe_db_cluster_endpoints

Name	Datatype	Description
custom_endpoint_type	string	The type associated with a custom endpoint. One of: READER, WRITER, ANY.
db_cluster_endpoint_arn	string	The Amazon Resource Name (ARN) for the endpoint.
db_cluster_endpoint_identifier	string	The identifier associated with the endpoint. This parameter is stored as a lowercase string.
db_cluster_endpoint_resource_identifier	string	A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
db_cluster_identifier	string	The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
endpoint	string	The DNS address of the endpoint.
endpoint_type	string	The type of the endpoint. One of: READER, WRITER, CUSTOM.
excluded_members	string	List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
static_members	string	List of DB instance identifiers that are part of the custom endpoint group.
status	string	The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_cluster_endpoints	select	region	DBClusterIdentifier, DBClusterEndpointIdentifier, Filters, MaxRecords, Marker	Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
create_db_cluster_endpoint	insert	DBClusterIdentifier, DBClusterEndpointIdentifier, EndpointType, region	StaticMembers, ExcludedMembers, Tags	Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters.
modify_db_cluster_endpoint	update	DBClusterEndpointIdentifier, region	EndpointType, StaticMembers, ExcludedMembers	Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This operation only applies to Aurora DB clusters.
delete_db_cluster_endpoint	delete	DBClusterEndpointIdentifier, region		Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.

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
DBClusterEndpointIdentifier	string	The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
DBClusterIdentifier	string	The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
EndpointType	string	The type of the endpoint, one of: READER, WRITER, ANY.
region	string	AWS region (default: us-east-1)
DBClusterEndpointIdentifier	string	The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
DBClusterIdentifier	string	The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
EndpointType	string	The type of the endpoint. One of: READER, WRITER, ANY.
ExcludedMembers	array	List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
Filters	array	A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.
Marker	string	An optional pagination token provided by a previous DescribeDBClusterEndpoints 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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
StaticMembers	array	List of DB instance identifiers that are part of the custom endpoint group.
Tags	array	The tags to be assigned to the Amazon RDS resource.

SELECT examples

describe_db_cluster_endpoints

Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.

SELECT
custom_endpoint_type,
db_cluster_endpoint_arn,
db_cluster_endpoint_identifier,
db_cluster_endpoint_resource_identifier,
db_cluster_identifier,
endpoint,
endpoint_type,
excluded_members,
static_members,
status
FROM aws.rds.db_cluster_endpoints
WHERE region = '{{ region }}' -- required
AND DBClusterIdentifier = '{{ DBClusterIdentifier }}'
AND DBClusterEndpointIdentifier = '{{ DBClusterEndpointIdentifier }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

INSERT examples

create_db_cluster_endpoint

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters.

INSERT INTO aws.rds.db_cluster_endpoints (
DBClusterIdentifier,
DBClusterEndpointIdentifier,
EndpointType,
region,
StaticMembers,
ExcludedMembers,
Tags
)
SELECT 
'{{ DBClusterIdentifier }}',
'{{ DBClusterEndpointIdentifier }}',
'{{ EndpointType }}',
'{{ region }}',
'{{ StaticMembers }}',
'{{ ExcludedMembers }}',
'{{ Tags }}'
RETURNING
custom_endpoint_type,
db_cluster_endpoint_arn,
db_cluster_endpoint_identifier,
db_cluster_endpoint_resource_identifier,
db_cluster_identifier,
endpoint,
endpoint_type,
excluded_members,
static_members,
status
;

Manifest

# Description fields are for documentation purposes
- name: db_cluster_endpoints
props:
  - name: DBClusterIdentifier
    value: "{{ DBClusterIdentifier }}"
    description: Required parameter for the db_cluster_endpoints resource.
  - name: DBClusterEndpointIdentifier
    value: "{{ DBClusterEndpointIdentifier }}"
    description: Required parameter for the db_cluster_endpoints resource.
  - name: EndpointType
    value: "{{ EndpointType }}"
    description: Required parameter for the db_cluster_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_cluster_endpoints resource.
  - name: StaticMembers
    value: "{{ StaticMembers }}"
    description: List of DB instance identifiers that are part of the custom endpoint group.
    description: List of DB instance identifiers that are part of the custom endpoint group.
  - name: ExcludedMembers
    value: "{{ ExcludedMembers }}"
    description: List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
    description: List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
  - name: Tags
    value: "{{ Tags }}"
    description: The tags to be assigned to the Amazon RDS resource.
    description: The tags to be assigned to the Amazon RDS resource.

UPDATE examples

modify_db_cluster_endpoint

Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This operation only applies to Aurora DB clusters.

UPDATE aws.rds.db_cluster_endpoints
SET 
-- No updatable properties
WHERE 
DBClusterEndpointIdentifier = '{{ DBClusterEndpointIdentifier }}' --required
AND region = '{{ region }}' --required
AND EndpointType = '{{ EndpointType}}'
AND StaticMembers = '{{ StaticMembers}}'
AND ExcludedMembers = '{{ ExcludedMembers}}'
RETURNING
custom_endpoint_type,
db_cluster_endpoint_arn,
db_cluster_endpoint_identifier,
db_cluster_endpoint_resource_identifier,
db_cluster_identifier,
endpoint,
endpoint_type,
excluded_members,
static_members,
status;

DELETE examples

delete_db_cluster_endpoint

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.

DELETE FROM aws.rds.db_cluster_endpoints
WHERE DBClusterEndpointIdentifier = '{{ DBClusterEndpointIdentifier }}' --required
AND region = '{{ region }}' --required
;