Class 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
    {
        AvailabilityZones = 
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "aurora-cluster-demo",
        DatabaseName = "mydb",
        MasterPassword = "bar",
        MasterUsername = "foo",
        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",
    });
    var test2 = new Aws.Rds.ClusterInstance("test2", new Aws.Rds.ClusterInstanceArgs
    {
        ApplyImmediately = true,
        ClusterIdentifier = @default.Id,
        Identifier = "test2",
        InstanceClass = "db.t2.small",
    });
    var test3 = new Aws.Rds.ClusterInstance("test3", new Aws.Rds.ClusterInstanceArgs
    {
        ApplyImmediately = true,
        ClusterIdentifier = @default.Id,
        Identifier = "test3",
        InstanceClass = "db.t2.small",
    });
    var eligible = new Aws.Rds.ClusterEndpoint("eligible", new Aws.Rds.ClusterEndpointArgs
    {
        ClusterEndpointIdentifier = "reader",
        ClusterIdentifier = @default.Id,
        CustomEndpointType = "READER",
        ExcludedMembers = 
        {
            test1.Id,
            test2.Id,
        },
    });
    var @static = new Aws.Rds.ClusterEndpoint("static", new Aws.Rds.ClusterEndpointArgs
    {
        ClusterEndpointIdentifier = "static",
        ClusterIdentifier = @default.Id,
        CustomEndpointType = "READER",
        StaticMembers = 
        {
            test1.Id,
            test3.Id,
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ClusterEndpoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Rds

Assembly: Pulumi.Aws.dll

Syntax

public class ClusterEndpoint : CustomResource

Constructors

ClusterEndpoint(String, ClusterEndpointArgs, CustomResourceOptions)

Create a ClusterEndpoint resource with the given unique name, arguments, and options.

Declaration

public ClusterEndpoint(string name, ClusterEndpointArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterEndpointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name (ARN) of cluster

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

ClusterEndpointIdentifier

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

Declaration

public Output<string> ClusterEndpointIdentifier { get; }

Property Value

Type	Description
Output<System.String>

ClusterIdentifier

The cluster identifier.

Declaration

public Output<string> ClusterIdentifier { get; }

Property Value

Type	Description
Output<System.String>

CustomEndpointType

The type of the endpoint. One of: READER , ANY .

Declaration

public Output<string> CustomEndpointType { get; }

Property Value

Type	Description
Output<System.String>

Endpoint

A custom endpoint for the Aurora cluster

Declaration

public Output<string> Endpoint { get; }

Property Value

Type	Description
Output<System.String>

ExcludedMembers

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.

Declaration

public Output<ImmutableArray<string>> ExcludedMembers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

StaticMembers

List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.

Declaration

public Output<ImmutableArray<string>> StaticMembers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Tags

Key-value map of resource tags

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, ClusterEndpointState, CustomResourceOptions)

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

Declaration

public static ClusterEndpoint Get(string name, Input<string> id, ClusterEndpointState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterEndpointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ClusterEndpoint