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

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.getDbClusterEndpoint

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.

    Using getDbClusterEndpoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDbClusterEndpoint(args: GetDbClusterEndpointArgs, opts?: InvokeOptions): Promise<GetDbClusterEndpointResult>
function getDbClusterEndpointOutput(args: GetDbClusterEndpointOutputArgs, opts?: InvokeOutputOptions): Output<GetDbClusterEndpointResult>
    def get_db_cluster_endpoint(db_cluster_endpoint_arn: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDbClusterEndpointResult
def get_db_cluster_endpoint_output(db_cluster_endpoint_arn: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetDbClusterEndpointResult]
    func LookupDbClusterEndpoint(ctx *Context, args *LookupDbClusterEndpointArgs, opts ...InvokeOption) (*LookupDbClusterEndpointResult, error)
func LookupDbClusterEndpointOutput(ctx *Context, args *LookupDbClusterEndpointOutputArgs, opts ...InvokeOption) LookupDbClusterEndpointResultOutput

    > Note: This function is named LookupDbClusterEndpoint in the Go SDK.

    public static class GetDbClusterEndpoint 
{
    public static Task<GetDbClusterEndpointResult> InvokeAsync(GetDbClusterEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetDbClusterEndpointResult> Invoke(GetDbClusterEndpointInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetDbClusterEndpointResult> Invoke(GetDbClusterEndpointInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetDbClusterEndpointResult> getDbClusterEndpoint(GetDbClusterEndpointArgs args, InvokeOptions options)
public static Output<GetDbClusterEndpointResult> getDbClusterEndpoint(GetDbClusterEndpointArgs args, InvokeOptions options)
public static Output<GetDbClusterEndpointResult> getDbClusterEndpoint(GetDbClusterEndpointArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:rds:getDbClusterEndpoint
  arguments:
    # arguments dictionary
    data "aws-native_rds_get_db_cluster_endpoint" "name" {
    # arguments
}

    The following arguments are supported:

    DbClusterEndpointArn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    DbClusterEndpointArn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    db_cluster_endpoint_arn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    dbClusterEndpointArn String
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    dbClusterEndpointArn string
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    db_cluster_endpoint_arn str
    The Amazon Resource Name (ARN) for the DB cluster endpoint.
    dbClusterEndpointArn String
    The Amazon Resource Name (ARN) for the DB cluster endpoint.

    getDbClusterEndpoint Result

    The following output properties are available:

    CustomEndpointType Pulumi.AwsNative.Rds.DbClusterEndpointCustomEndpointType
    The type of the custom 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.
    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.
    Status string
    The current status of the endpoint.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to be assigned to the DB cluster endpoint.
    CustomEndpointType DbClusterEndpointCustomEndpointType
    The type of the custom 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.
    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.
    Status string
    The current status of the endpoint.
    Tags Tag
    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_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.
    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.
    status string
    The current status of the endpoint.
    tags list(object)
    The tags to be assigned to the DB cluster endpoint.
    customEndpointType DbClusterEndpointCustomEndpointType
    The type of the custom 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.
    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.
    status String
    The current status of the endpoint.
    tags List<Tag>
    The tags to be assigned to the DB cluster endpoint.
    customEndpointType DbClusterEndpointCustomEndpointType
    The type of the custom 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.
    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.
    status string
    The current status of 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_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.
    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.
    status str
    The current status of the endpoint.
    tags Sequence[root_Tag]
    The tags to be assigned to the DB cluster endpoint.
    customEndpointType "READER" | "WRITER" | "ANY"
    The type of the custom 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.
    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.
    status String
    The current status of the endpoint.
    tags List<Property Map>
    The tags to be assigned to the DB cluster endpoint.

    Supporting Types

    DbClusterEndpointCustomEndpointType

    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

    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