Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ClusterEndpoint
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.ClusterEndpoint

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Manages an RDS Aurora Cluster Custom Endpoint. You can refer to the User Guide.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const _default = new aws.rds.Cluster("default", {
    clusterIdentifier: "aurora-cluster-demo",
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    databaseName: "mydb",
    masterUsername: "foo",
    masterPassword: "bar",
    backupRetentionPeriod: 5,
    preferredBackupWindow: "07:00-09:00",
});
const test1 = new aws.rds.ClusterInstance("test1", {
    applyImmediately: true,
    clusterIdentifier: _default.id,
    identifier: "test1",
    instanceClass: aws.rds.InstanceType.T2_Small,
    engine: _default.engine,
    engineVersion: _default.engineVersion,
});
const test2 = new aws.rds.ClusterInstance("test2", {
    applyImmediately: true,
    clusterIdentifier: _default.id,
    identifier: "test2",
    instanceClass: aws.rds.InstanceType.T2_Small,
    engine: _default.engine,
    engineVersion: _default.engineVersion,
});
const test3 = new aws.rds.ClusterInstance("test3", {
    applyImmediately: true,
    clusterIdentifier: _default.id,
    identifier: "test3",
    instanceClass: aws.rds.InstanceType.T2_Small,
    engine: _default.engine,
    engineVersion: _default.engineVersion,
});
const eligible = new aws.rds.ClusterEndpoint("eligible", {
    clusterIdentifier: _default.id,
    clusterEndpointIdentifier: "reader",
    customEndpointType: "READER",
    excludedMembers: [
        test1.id,
        test2.id,
    ],
});
const static = new aws.rds.ClusterEndpoint("static", {
    clusterIdentifier: _default.id,
    clusterEndpointIdentifier: "static",
    customEndpointType: "READER",
    staticMembers: [
        test1.id,
        test3.id,
    ],
});
Copy
import pulumi
import pulumi_aws as aws

default = aws.rds.Cluster("default",
    cluster_identifier="aurora-cluster-demo",
    availability_zones=[
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    database_name="mydb",
    master_username="foo",
    master_password="bar",
    backup_retention_period=5,
    preferred_backup_window="07:00-09:00")
test1 = aws.rds.ClusterInstance("test1",
    apply_immediately=True,
    cluster_identifier=default.id,
    identifier="test1",
    instance_class=aws.rds.InstanceType.T2_SMALL,
    engine=default.engine,
    engine_version=default.engine_version)
test2 = aws.rds.ClusterInstance("test2",
    apply_immediately=True,
    cluster_identifier=default.id,
    identifier="test2",
    instance_class=aws.rds.InstanceType.T2_SMALL,
    engine=default.engine,
    engine_version=default.engine_version)
test3 = aws.rds.ClusterInstance("test3",
    apply_immediately=True,
    cluster_identifier=default.id,
    identifier="test3",
    instance_class=aws.rds.InstanceType.T2_SMALL,
    engine=default.engine,
    engine_version=default.engine_version)
eligible = aws.rds.ClusterEndpoint("eligible",
    cluster_identifier=default.id,
    cluster_endpoint_identifier="reader",
    custom_endpoint_type="READER",
    excluded_members=[
        test1.id,
        test2.id,
    ])
static = aws.rds.ClusterEndpoint("static",
    cluster_identifier=default.id,
    cluster_endpoint_identifier="static",
    custom_endpoint_type="READER",
    static_members=[
        test1.id,
        test3.id,
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := rds.NewCluster(ctx, "default", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("us-west-2a"),
				pulumi.String("us-west-2b"),
				pulumi.String("us-west-2c"),
			},
			DatabaseName:          pulumi.String("mydb"),
			MasterUsername:        pulumi.String("foo"),
			MasterPassword:        pulumi.String("bar"),
			BackupRetentionPeriod: pulumi.Int(5),
			PreferredBackupWindow: pulumi.String("07:00-09:00"),
		})
		if err != nil {
			return err
		}
		test1, err := rds.NewClusterInstance(ctx, "test1", &rds.ClusterInstanceArgs{
			ApplyImmediately:  pulumi.Bool(true),
			ClusterIdentifier: _default.ID(),
			Identifier:        pulumi.String("test1"),
			InstanceClass:     pulumi.String(rds.InstanceType_T2_Small),
			Engine:            _default.Engine,
			EngineVersion:     _default.EngineVersion,
		})
		if err != nil {
			return err
		}
		test2, err := rds.NewClusterInstance(ctx, "test2", &rds.ClusterInstanceArgs{
			ApplyImmediately:  pulumi.Bool(true),
			ClusterIdentifier: _default.ID(),
			Identifier:        pulumi.String("test2"),
			InstanceClass:     pulumi.String(rds.InstanceType_T2_Small),
			Engine:            _default.Engine,
			EngineVersion:     _default.EngineVersion,
		})
		if err != nil {
			return err
		}
		test3, err := rds.NewClusterInstance(ctx, "test3", &rds.ClusterInstanceArgs{
			ApplyImmediately:  pulumi.Bool(true),
			ClusterIdentifier: _default.ID(),
			Identifier:        pulumi.String("test3"),
			InstanceClass:     pulumi.String(rds.InstanceType_T2_Small),
			Engine:            _default.Engine,
			EngineVersion:     _default.EngineVersion,
		})
		if err != nil {
			return err
		}
		_, err = rds.NewClusterEndpoint(ctx, "eligible", &rds.ClusterEndpointArgs{
			ClusterIdentifier:         _default.ID(),
			ClusterEndpointIdentifier: pulumi.String("reader"),
			CustomEndpointType:        pulumi.String("READER"),
			ExcludedMembers: pulumi.StringArray{
				test1.ID(),
				test2.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = rds.NewClusterEndpoint(ctx, "static", &rds.ClusterEndpointArgs{
			ClusterIdentifier:         _default.ID(),
			ClusterEndpointIdentifier: pulumi.String("static"),
			CustomEndpointType:        pulumi.String("READER"),
			StaticMembers: pulumi.StringArray{
				test1.ID(),
				test3.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Rds.Cluster("default", new()
    {
        ClusterIdentifier = "aurora-cluster-demo",
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        DatabaseName = "mydb",
        MasterUsername = "foo",
        MasterPassword = "bar",
        BackupRetentionPeriod = 5,
        PreferredBackupWindow = "07:00-09:00",
    });

    var test1 = new Aws.Rds.ClusterInstance("test1", new()
    {
        ApplyImmediately = true,
        ClusterIdentifier = @default.Id,
        Identifier = "test1",
        InstanceClass = Aws.Rds.InstanceType.T2_Small,
        Engine = @default.Engine,
        EngineVersion = @default.EngineVersion,
    });

    var test2 = new Aws.Rds.ClusterInstance("test2", new()
    {
        ApplyImmediately = true,
        ClusterIdentifier = @default.Id,
        Identifier = "test2",
        InstanceClass = Aws.Rds.InstanceType.T2_Small,
        Engine = @default.Engine,
        EngineVersion = @default.EngineVersion,
    });

    var test3 = new Aws.Rds.ClusterInstance("test3", new()
    {
        ApplyImmediately = true,
        ClusterIdentifier = @default.Id,
        Identifier = "test3",
        InstanceClass = Aws.Rds.InstanceType.T2_Small,
        Engine = @default.Engine,
        EngineVersion = @default.EngineVersion,
    });

    var eligible = new Aws.Rds.ClusterEndpoint("eligible", new()
    {
        ClusterIdentifier = @default.Id,
        ClusterEndpointIdentifier = "reader",
        CustomEndpointType = "READER",
        ExcludedMembers = new[]
        {
            test1.Id,
            test2.Id,
        },
    });

    var @static = new Aws.Rds.ClusterEndpoint("static", new()
    {
        ClusterIdentifier = @default.Id,
        ClusterEndpointIdentifier = "static",
        CustomEndpointType = "READER",
        StaticMembers = new[]
        {
            test1.Id,
            test3.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Cluster;
import com.pulumi.aws.rds.ClusterArgs;
import com.pulumi.aws.rds.ClusterInstance;
import com.pulumi.aws.rds.ClusterInstanceArgs;
import com.pulumi.aws.rds.ClusterEndpoint;
import com.pulumi.aws.rds.ClusterEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new Cluster("default", ClusterArgs.builder()
            .clusterIdentifier("aurora-cluster-demo")
            .availabilityZones(            
                "us-west-2a",
                "us-west-2b",
                "us-west-2c")
            .databaseName("mydb")
            .masterUsername("foo")
            .masterPassword("bar")
            .backupRetentionPeriod(5)
            .preferredBackupWindow("07:00-09:00")
            .build());

        var test1 = new ClusterInstance("test1", ClusterInstanceArgs.builder()
            .applyImmediately(true)
            .clusterIdentifier(default_.id())
            .identifier("test1")
            .instanceClass("db.t2.small")
            .engine(default_.engine())
            .engineVersion(default_.engineVersion())
            .build());

        var test2 = new ClusterInstance("test2", ClusterInstanceArgs.builder()
            .applyImmediately(true)
            .clusterIdentifier(default_.id())
            .identifier("test2")
            .instanceClass("db.t2.small")
            .engine(default_.engine())
            .engineVersion(default_.engineVersion())
            .build());

        var test3 = new ClusterInstance("test3", ClusterInstanceArgs.builder()
            .applyImmediately(true)
            .clusterIdentifier(default_.id())
            .identifier("test3")
            .instanceClass("db.t2.small")
            .engine(default_.engine())
            .engineVersion(default_.engineVersion())
            .build());

        var eligible = new ClusterEndpoint("eligible", ClusterEndpointArgs.builder()
            .clusterIdentifier(default_.id())
            .clusterEndpointIdentifier("reader")
            .customEndpointType("READER")
            .excludedMembers(            
                test1.id(),
                test2.id())
            .build());

        var static_ = new ClusterEndpoint("static", ClusterEndpointArgs.builder()
            .clusterIdentifier(default_.id())
            .clusterEndpointIdentifier("static")
            .customEndpointType("READER")
            .staticMembers(            
                test1.id(),
                test3.id())
            .build());

    }
}
Copy
resources:
  default:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: aurora-cluster-demo
      availabilityZones:
        - us-west-2a
        - us-west-2b
        - us-west-2c
      databaseName: mydb
      masterUsername: foo
      masterPassword: bar
      backupRetentionPeriod: 5
      preferredBackupWindow: 07:00-09:00
  test1:
    type: aws:rds:ClusterInstance
    properties:
      applyImmediately: true
      clusterIdentifier: ${default.id}
      identifier: test1
      instanceClass: db.t2.small
      engine: ${default.engine}
      engineVersion: ${default.engineVersion}
  test2:
    type: aws:rds:ClusterInstance
    properties:
      applyImmediately: true
      clusterIdentifier: ${default.id}
      identifier: test2
      instanceClass: db.t2.small
      engine: ${default.engine}
      engineVersion: ${default.engineVersion}
  test3:
    type: aws:rds:ClusterInstance
    properties:
      applyImmediately: true
      clusterIdentifier: ${default.id}
      identifier: test3
      instanceClass: db.t2.small
      engine: ${default.engine}
      engineVersion: ${default.engineVersion}
  eligible:
    type: aws:rds:ClusterEndpoint
    properties:
      clusterIdentifier: ${default.id}
      clusterEndpointIdentifier: reader
      customEndpointType: READER
      excludedMembers:
        - ${test1.id}
        - ${test2.id}
  static:
    type: aws:rds:ClusterEndpoint
    properties:
      clusterIdentifier: ${default.id}
      clusterEndpointIdentifier: static
      customEndpointType: READER
      staticMembers:
        - ${test1.id}
        - ${test3.id}
Copy

Create ClusterEndpoint Resource

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

Constructor syntax

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

@overload
def ClusterEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cluster_endpoint_identifier: Optional[str] = None,
                    cluster_identifier: Optional[str] = None,
                    custom_endpoint_type: Optional[str] = None,
                    excluded_members: Optional[Sequence[str]] = None,
                    static_members: Optional[Sequence[str]] = None,
                    tags: Optional[Mapping[str, str]] = None)
func NewClusterEndpoint(ctx *Context, name string, args ClusterEndpointArgs, opts ...ResourceOption) (*ClusterEndpoint, error)
public ClusterEndpoint(string name, ClusterEndpointArgs args, CustomResourceOptions? opts = null)
public ClusterEndpoint(String name, ClusterEndpointArgs args)
public ClusterEndpoint(String name, ClusterEndpointArgs args, CustomResourceOptions options)

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

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var awsClusterEndpointResource = new Aws.Rds.ClusterEndpoint("awsClusterEndpointResource", new()
{
    ClusterEndpointIdentifier = "string",
    ClusterIdentifier = "string",
    CustomEndpointType = "string",
    ExcludedMembers = new[]
    {
        "string",
    },
    StaticMembers = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := rds.NewClusterEndpoint(ctx, "awsClusterEndpointResource", &rds.ClusterEndpointArgs{
	ClusterEndpointIdentifier: pulumi.String("string"),
	ClusterIdentifier:         pulumi.String("string"),
	CustomEndpointType:        pulumi.String("string"),
	ExcludedMembers: pulumi.StringArray{
		pulumi.String("string"),
	},
	StaticMembers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var awsClusterEndpointResource = new ClusterEndpoint("awsClusterEndpointResource", ClusterEndpointArgs.builder()
    .clusterEndpointIdentifier("string")
    .clusterIdentifier("string")
    .customEndpointType("string")
    .excludedMembers("string")
    .staticMembers("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
aws_cluster_endpoint_resource = aws.rds.ClusterEndpoint("awsClusterEndpointResource",
    cluster_endpoint_identifier="string",
    cluster_identifier="string",
    custom_endpoint_type="string",
    excluded_members=["string"],
    static_members=["string"],
    tags={
        "string": "string",
    })
Copy
const awsClusterEndpointResource = new aws.rds.ClusterEndpoint("awsClusterEndpointResource", {
    clusterEndpointIdentifier: "string",
    clusterIdentifier: "string",
    customEndpointType: "string",
    excludedMembers: ["string"],
    staticMembers: ["string"],
    tags: {
        string: "string",
    },
});
Copy
type: aws:rds:ClusterEndpoint
properties:
    clusterEndpointIdentifier: string
    clusterIdentifier: string
    customEndpointType: string
    excludedMembers:
        - string
    staticMembers:
        - string
    tags:
        string: string
Copy

ClusterEndpoint 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 ClusterEndpoint resource accepts the following input properties:

ClusterEndpointIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier.
CustomEndpointType This property is required. string
The type of the endpoint. One of: READER , ANY .
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. Conflicts with static_members.
StaticMembers List<string>
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
Tags Dictionary<string, string>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ClusterEndpointIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier.
CustomEndpointType This property is required. string
The type of the endpoint. One of: READER , ANY .
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. Conflicts with static_members.
StaticMembers []string
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
Tags map[string]string
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterEndpointIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The cluster identifier.
customEndpointType This property is required. String
The type of the endpoint. One of: READER , ANY .
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. Conflicts with static_members.
staticMembers List<String>
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags Map<String,String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterEndpointIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier.
customEndpointType This property is required. string
The type of the endpoint. One of: READER , ANY .
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. Conflicts with static_members.
staticMembers string[]
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags {[key: string]: string}
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
cluster_endpoint_identifier
This property is required.
Changes to this property will trigger replacement.
str
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
cluster_identifier
This property is required.
Changes to this property will trigger replacement.
str
The cluster identifier.
custom_endpoint_type This property is required. str
The type of the endpoint. One of: READER , ANY .
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. Conflicts with static_members.
static_members Sequence[str]
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags Mapping[str, str]
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterEndpointIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The cluster identifier.
customEndpointType This property is required. String
The type of the endpoint. One of: READER , ANY .
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. Conflicts with static_members.
staticMembers List<String>
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags Map<String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Arn string
Amazon Resource Name (ARN) of cluster
Endpoint string
A custom endpoint for the Aurora cluster
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of cluster
Endpoint string
A custom endpoint for the Aurora cluster
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of cluster
endpoint String
A custom endpoint for the Aurora cluster
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of cluster
endpoint string
A custom endpoint for the Aurora cluster
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of cluster
endpoint str
A custom endpoint for the Aurora cluster
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of cluster
endpoint String
A custom endpoint for the Aurora cluster
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing ClusterEndpoint Resource

Get an existing ClusterEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterEndpointState, opts?: CustomResourceOptions): ClusterEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cluster_endpoint_identifier: Optional[str] = None,
        cluster_identifier: Optional[str] = None,
        custom_endpoint_type: Optional[str] = None,
        endpoint: Optional[str] = None,
        excluded_members: Optional[Sequence[str]] = None,
        static_members: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ClusterEndpoint
func GetClusterEndpoint(ctx *Context, name string, id IDInput, state *ClusterEndpointState, opts ...ResourceOption) (*ClusterEndpoint, error)
public static ClusterEndpoint Get(string name, Input<string> id, ClusterEndpointState? state, CustomResourceOptions? opts = null)
public static ClusterEndpoint get(String name, Output<String> id, ClusterEndpointState state, CustomResourceOptions options)
resources:  _:    type: aws:rds:ClusterEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
Amazon Resource Name (ARN) of cluster
ClusterEndpointIdentifier Changes to this property will trigger replacement. string
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
ClusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier.
CustomEndpointType string
The type of the endpoint. One of: READER , ANY .
Endpoint string
A custom endpoint for the Aurora cluster
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. Conflicts with static_members.
StaticMembers List<string>
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
Tags Dictionary<string, string>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of cluster
ClusterEndpointIdentifier Changes to this property will trigger replacement. string
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
ClusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier.
CustomEndpointType string
The type of the endpoint. One of: READER , ANY .
Endpoint string
A custom endpoint for the Aurora cluster
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. Conflicts with static_members.
StaticMembers []string
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
Tags map[string]string
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of cluster
clusterEndpointIdentifier Changes to this property will trigger replacement. String
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
clusterIdentifier Changes to this property will trigger replacement. String
The cluster identifier.
customEndpointType String
The type of the endpoint. One of: READER , ANY .
endpoint String
A custom endpoint for the Aurora cluster
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. Conflicts with static_members.
staticMembers List<String>
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags Map<String,String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of cluster
clusterEndpointIdentifier Changes to this property will trigger replacement. string
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
clusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier.
customEndpointType string
The type of the endpoint. One of: READER , ANY .
endpoint string
A custom endpoint for the Aurora cluster
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. Conflicts with static_members.
staticMembers string[]
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags {[key: string]: string}
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of cluster
cluster_endpoint_identifier Changes to this property will trigger replacement. str
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
cluster_identifier Changes to this property will trigger replacement. str
The cluster identifier.
custom_endpoint_type str
The type of the endpoint. One of: READER , ANY .
endpoint str
A custom endpoint for the Aurora cluster
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. Conflicts with static_members.
static_members Sequence[str]
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags Mapping[str, str]
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of cluster
clusterEndpointIdentifier Changes to this property will trigger replacement. String
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
clusterIdentifier Changes to this property will trigger replacement. String
The cluster identifier.
customEndpointType String
The type of the endpoint. One of: READER , ANY .
endpoint String
A custom endpoint for the Aurora cluster
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. Conflicts with static_members.
staticMembers List<String>
List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
tags Map<String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

Using pulumi import, import RDS Clusters Endpoint using the cluster_endpoint_identifier. For example:

$ pulumi import aws:rds/clusterEndpoint:ClusterEndpoint custom_reader aurora-prod-cluster-custom-reader
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws