CfnDBClusterEndpointProps Struct
Properties for defining a CfnDBClusterEndpoint.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnDBClusterEndpointProps: rds.CfnDBClusterEndpointProps = {
customEndpointType: 'customEndpointType',
dbClusterEndpointIdentifier: 'dbClusterEndpointIdentifier',
dbClusterIdentifier: 'dbClusterIdentifier',
// the properties below are optional
excludedMembers: ['excludedMembers'],
staticMembers: ['staticMembers'],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
customEndpointTypestringcustom_endpoint_typestrcustomEndpointTypeStringCustomEndpointTypestringCustomEndpointType*stringrequired#The type of the custom endpoint.
dbClusterEndpointIdentifierstringdb_cluster_endpoint_identifierstrdbClusterEndpointIdentifierStringDbClusterEndpointIdentifierstringDbClusterEndpointIdentifier*stringrequired#The identifier to use for the new endpoint.
This parameter is stored as a lowercase string.
dbClusterIdentifierstringdb_cluster_identifierstrdbClusterIdentifierStringDbClusterIdentifierstringDbClusterIdentifier*stringrequired#The DB cluster identifier of the DB cluster associated with the endpoint.
This parameter is stored as a lowercase string.
excludedMembersoptionalstring[]excluded_membersoptionaltyping.List[str]excludedMembersoptionalList<String>ExcludedMembersoptionalstring[]ExcludedMembersoptional*[]*string#List of DB instance identifiers that aren't part of the custom endpoint group.
notes
All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Once either member list is set, it can be changed or replaced by the other list, but both lists cannot be removed in place; removing them requires replacing the endpoint.
staticMembersoptionalstring[]static_membersoptionaltyping.List[str]staticMembersoptionalList<String>StaticMembersoptionalstring[]StaticMembersoptional*[]*string#List of DB instance identifiers that are part of the custom endpoint group.
Once either member list is set, it can be changed or replaced by the other list, but both lists cannot be removed in place; removing them requires replacing the endpoint.