Interface IDatabaseClusterAttributes

Properties that describe an existing cluster instance.

Namespace: Amazon.CDK.AWS.DocDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDatabaseClusterAttributes

Syntax (vb)

Public Interface IDatabaseClusterAttributes

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DocDB;
using Amazon.CDK.AWS.EC2;

SecurityGroup securityGroup;

var databaseClusterAttributes = new DatabaseClusterAttributes {
    ClusterIdentifier = "clusterIdentifier",

    // the properties below are optional
    ClusterEndpointAddress = "clusterEndpointAddress",
    InstanceEndpointAddresses = new [] { "instanceEndpointAddresses" },
    InstanceIdentifiers = new [] { "instanceIdentifiers" },
    Port = 123,
    ReaderEndpointAddress = "readerEndpointAddress",
    SecurityGroup = securityGroup
};

Synopsis

Properties

ClusterEndpointAddress	Cluster endpoint address.
ClusterIdentifier	Identifier for the cluster.
InstanceEndpointAddresses	Endpoint addresses of individual instances.
InstanceIdentifiers	Identifier for the instances.
Port	The database port.
ReaderEndpointAddress	Reader endpoint address.
SecurityGroup	The security group of the database cluster.

Properties

ClusterEndpointAddress

Cluster endpoint address.

virtual string ClusterEndpointAddress { get; }

Property Value

System.String

Remarks

Default: - no cluster endpoint address

ClusterIdentifier

Identifier for the cluster.

string ClusterIdentifier { get; }

Property Value

System.String

InstanceEndpointAddresses

Endpoint addresses of individual instances.

virtual string[] InstanceEndpointAddresses { get; }

Property Value

System.String[]

Remarks

Default: - no instance endpoint addresses

InstanceIdentifiers

Identifier for the instances.

virtual string[] InstanceIdentifiers { get; }

Property Value

System.String[]

Remarks

Default: - no instance identifiers

Port

The database port.

virtual Nullable<double> Port { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: - none

ReaderEndpointAddress

Reader endpoint address.

virtual string ReaderEndpointAddress { get; }

Property Value

System.String

Remarks

Default: - no reader endpoint address

SecurityGroup

The security group of the database cluster.

virtual ISecurityGroup SecurityGroup { get; }

Property Value

ISecurityGroup

Remarks

Default: - no security groups