Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. rds
  6. DbClusterEndpoint

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.rds.DbClusterEndpoint

aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::RDS::DBClusterEndpoint. Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This resource applies only to Aurora DB clusters.

    Create DbClusterEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DbClusterEndpoint(name: string, args: DbClusterEndpointArgs, opts?: CustomResourceOptions);
    @overload
def DbClusterEndpoint(resource_name: str,
                      args: DbClusterEndpointArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def DbClusterEndpoint(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      custom_endpoint_type: Optional[DbClusterEndpointCustomEndpointType] = None,
                      db_cluster_endpoint_identifier: Optional[str] = None,
                      db_cluster_identifier: Optional[str] = None,
                      excluded_members: Optional[Sequence[str]] = None,
                      static_members: Optional[Sequence[str]] = None,
                      tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDbClusterEndpoint(ctx *Context, name string, args DbClusterEndpointArgs, opts ...ResourceOption) (*DbClusterEndpoint, error)
    public DbClusterEndpoint(string name, DbClusterEndpointArgs args, CustomResourceOptions? opts = null)
    public DbClusterEndpoint(String name, DbClusterEndpointArgs args)
public DbClusterEndpoint(String name, DbClusterEndpointArgs args, CustomResourceOptions options)

    type: aws-native:rds:DbClusterEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_rds_db_cluster_endpoint" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DbClusterEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DbClusterEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DbClusterEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbClusterEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbClusterEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DbClusterEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DbClusterEndpoint resource accepts the following input properties:

    CustomEndpointType Pulumi.AwsNative.Rds.DbClusterEndpointCustomEndpointType
    The type of the custom endpoint.
    DbClusterEndpointIdentifier string
    The identifier to use for the new 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.
    ExcludedMembers List<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. 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.
    StaticMembers List<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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to be assigned to the DB cluster endpoint.
    CustomEndpointType DbClusterEndpointCustomEndpointType
    The type of the custom endpoint.
    DbClusterEndpointIdentifier string
    The identifier to use for the new 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.
    ExcludedMembers []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. 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.
    StaticMembers []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.
    Tags TagArgs
    The tags to be assigned to the DB cluster endpoint.
    custom_endpoint_type "READER" | "WRITER" | "ANY"
    The type of the custom endpoint.
    db_cluster_endpoint_identifier string
    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
    db_cluster_identifier string
    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
    excluded_members list(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. 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.
    static_members list(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.
    tags list(object)
    The tags to be assigned to the DB cluster endpoint.
    customEndpointType DbClusterEndpointCustomEndpointType
    The type of the custom endpoint.
    dbClusterEndpointIdentifier String
    The identifier to use for the new 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.
    excludedMembers List<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. 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.
    staticMembers List<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.
    tags List<Tag>
    The tags to be assigned to the DB cluster endpoint.
    customEndpointType DbClusterEndpointCustomEndpointType
    The type of the custom endpoint.
    dbClusterEndpointIdentifier string
    The identifier to use for the new 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.
    excludedMembers 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. 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.
    staticMembers 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.
    tags Tag[]
    The tags to be assigned to the DB cluster endpoint.
    custom_endpoint_type DbClusterEndpointCustomEndpointType
    The type of the custom endpoint.
    db_cluster_endpoint_identifier str
    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
    db_cluster_identifier str
    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
    excluded_members Sequence[str]
    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. 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.
    static_members Sequence[str]
    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.
    tags Sequence[TagArgs]
    The tags to be assigned to the DB cluster endpoint.
    customEndpointType "READER" | "WRITER" | "ANY"
    The type of the custom endpoint.
    dbClusterEndpointIdentifier String
    The identifier to use for the new 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.
    excludedMembers List<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. 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.
    staticMembers List<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.
    tags List<Property Map>
    The tags to be assigned to the DB cluster endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DbClusterEndpoint resource produces the following output properties:

    DbClusterEndpointArn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    DbClusterEndpointResourceIdentifier string
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    Endpoint string
    The DNS address of the endpoint.
    EndpointType string
    The endpoint classification returned by Amazon RDS.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current status of the endpoint.
    DbClusterEndpointArn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    DbClusterEndpointResourceIdentifier string
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    Endpoint string
    The DNS address of the endpoint.
    EndpointType string
    The endpoint classification returned by Amazon RDS.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current status of the endpoint.
    db_cluster_endpoint_arn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    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.
    endpoint string
    The DNS address of the endpoint.
    endpoint_type string
    The endpoint classification returned by Amazon RDS.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The current status of the endpoint.
    dbClusterEndpointArn String
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    dbClusterEndpointResourceIdentifier String
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    endpoint String
    The DNS address of the endpoint.
    endpointType String
    The endpoint classification returned by Amazon RDS.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current status of the endpoint.
    dbClusterEndpointArn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    dbClusterEndpointResourceIdentifier string
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    endpoint string
    The DNS address of the endpoint.
    endpointType string
    The endpoint classification returned by Amazon RDS.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The current status of the endpoint.
    db_cluster_endpoint_arn str
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    db_cluster_endpoint_resource_identifier str
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    endpoint str
    The DNS address of the endpoint.
    endpoint_type str
    The endpoint classification returned by Amazon RDS.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The current status of the endpoint.
    dbClusterEndpointArn String
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    dbClusterEndpointResourceIdentifier String
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    endpoint String
    The DNS address of the endpoint.
    endpointType String
    The endpoint classification returned by Amazon RDS.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current status of the endpoint.

    Supporting Types

    DbClusterEndpointCustomEndpointType, DbClusterEndpointCustomEndpointTypeArgs

    NameValue
    ReaderREADER
    WriterWRITER
    AnyANY
    NameValue
    DbClusterEndpointCustomEndpointTypeReaderREADER
    DbClusterEndpointCustomEndpointTypeWriterWRITER
    DbClusterEndpointCustomEndpointTypeAnyANY
    Value
    READER
    WRITER
    ANY
    NameValue
    ReaderREADER
    WriterWRITER
    AnyANY
    NameValue
    ReaderREADER
    WriterWRITER
    AnyANY
    NameValue
    READERREADER
    WRITERWRITER
    ANYANY
    Value
    READER
    WRITER
    ANY

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.85.0
    published on Monday, Nov 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial