AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

ClusterEndpoint

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.Rds.Cluster("default", new Aws.Rds.ClusterArgs
        {
            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",
        });
        var test1 = new Aws.Rds.ClusterInstance("test1", new Aws.Rds.ClusterInstanceArgs
        {
            ApplyImmediately = true,
            ClusterIdentifier = @default.Id,
            Identifier = "test1",
            InstanceClass = "db.t2.small",
            Engine = @default.Engine,
            EngineVersion = @default.EngineVersion,
        });
        var test2 = new Aws.Rds.ClusterInstance("test2", new Aws.Rds.ClusterInstanceArgs
        {
            ApplyImmediately = true,
            ClusterIdentifier = @default.Id,
            Identifier = "test2",
            InstanceClass = "db.t2.small",
            Engine = @default.Engine,
            EngineVersion = @default.EngineVersion,
        });
        var test3 = new Aws.Rds.ClusterInstance("test3", new Aws.Rds.ClusterInstanceArgs
        {
            ApplyImmediately = true,
            ClusterIdentifier = @default.Id,
            Identifier = "test3",
            InstanceClass = "db.t2.small",
            Engine = @default.Engine,
            EngineVersion = @default.EngineVersion,
        });
        var eligible = new Aws.Rds.ClusterEndpoint("eligible", new Aws.Rds.ClusterEndpointArgs
        {
            ClusterIdentifier = @default.Id,
            ClusterEndpointIdentifier = "reader",
            CustomEndpointType = "READER",
            ExcludedMembers = 
            {
                test1.Id,
                test2.Id,
            },
        });
        var @static = new Aws.Rds.ClusterEndpoint("static", new Aws.Rds.ClusterEndpointArgs
        {
            ClusterIdentifier = @default.Id,
            ClusterEndpointIdentifier = "static",
            CustomEndpointType = "READER",
            StaticMembers = 
            {
                test1.Id,
                test3.Id,
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, 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("db.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("db.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("db.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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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());

    }
}
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="db.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="db.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="db.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,
    ])
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: "db.t2.small",
    engine: _default.engine,
    engineVersion: _default.engineVersion,
});
const test2 = new aws.rds.ClusterInstance("test2", {
    applyImmediately: true,
    clusterIdentifier: _default.id,
    identifier: "test2",
    instanceClass: "db.t2.small",
    engine: _default.engine,
    engineVersion: _default.engineVersion,
});
const test3 = new aws.rds.ClusterInstance("test3", {
    applyImmediately: true,
    clusterIdentifier: _default.id,
    identifier: "test3",
    instanceClass: "db.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,
    ],
});
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}

Create a ClusterEndpoint Resource

new ClusterEndpoint(name: string, args: ClusterEndpointArgs, opts?: CustomResourceOptions);
@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)
@overload
def ClusterEndpoint(resource_name: str,
                    args: ClusterEndpointArgs,
                    opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args ClusterEndpointArgs
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 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 string
The unique name of the resource.
args ClusterEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The ClusterEndpoint resource accepts the following input properties:

ClusterEndpointIdentifier string

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

ClusterIdentifier string

The cluster identifier.

CustomEndpointType 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 string

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

ClusterIdentifier string

The cluster identifier.

CustomEndpointType 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 String

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

clusterIdentifier String

The cluster identifier.

customEndpointType 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 string

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

clusterIdentifier string

The cluster identifier.

customEndpointType 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 str

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

cluster_identifier str

The cluster identifier.

custom_endpoint_type 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 String

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

clusterIdentifier String

The cluster identifier.

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

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 .

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 .

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 .

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 .

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 .

Look up an 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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 string

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

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

Arn string

Amazon Resource Name (ARN) of cluster

ClusterEndpointIdentifier string

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

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

arn String

Amazon Resource Name (ARN) of cluster

clusterEndpointIdentifier String

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

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

arn string

Amazon Resource Name (ARN) of cluster

clusterEndpointIdentifier string

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

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

arn str

Amazon Resource Name (ARN) of cluster

cluster_endpoint_identifier str

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

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

arn String

Amazon Resource Name (ARN) of cluster

clusterEndpointIdentifier String

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

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

Import

RDS Clusters Endpoint can be imported using the cluster_endpoint_identifier, e.g.,

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

[1]https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html#Aurora.Endpoints.Cluster

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.