Interface IServerlessClusterAttributes

Properties that describe an existing cluster instance.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public interface IServerlessClusterAttributes

Syntax (vb)

Public Interface IServerlessClusterAttributes

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.EC2;
using Amazon.CDK.AWS.RDS;
using Amazon.CDK.AWS.SecretsManager;

Secret secret;
SecurityGroup securityGroup;

var serverlessClusterAttributes = new ServerlessClusterAttributes {
    ClusterIdentifier = "clusterIdentifier",

    // the properties below are optional
    ClusterEndpointAddress = "clusterEndpointAddress",
    Port = 123,
    ReaderEndpointAddress = "readerEndpointAddress",
    Secret = secret,
    SecurityGroups = new [] { securityGroup }
};

Synopsis

Properties

ClusterEndpointAddress	Cluster endpoint address.
ClusterIdentifier	Identifier for the cluster.
Port	The database port.
ReaderEndpointAddress	Reader endpoint address.
Secret	The secret attached to the database cluster.
SecurityGroups	The security groups of the database cluster.

Properties

ClusterEndpointAddress

Cluster endpoint address.

virtual string ClusterEndpointAddress { get; }

Property Value

System.String

Remarks

Default: - no endpoint address

ClusterIdentifier

Identifier for the cluster.

string ClusterIdentifier { get; }

Property Value

System.String

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 address

Secret

The secret attached to the database cluster.

virtual ISecret Secret { get; }

Property Value

ISecret

Remarks

Default: - no secret

SecurityGroups

The security groups of the database cluster.

virtual ISecurityGroup[] SecurityGroups { get; }

Property Value

ISecurityGroup[]

Remarks

Default: - no security groups