Class ServerlessClusterAttributes

Properties that describe an existing cluster instance.

Inheritance

object

ServerlessClusterAttributes

Implements

IServerlessClusterAttributes

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ServerlessClusterAttributes : IServerlessClusterAttributes

Syntax (vb)

Public Class ServerlessClusterAttributes Implements 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

Constructors

ServerlessClusterAttributes()

Properties that describe an existing cluster instance.

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.

Constructors

ServerlessClusterAttributes()

Properties that describe an existing cluster instance.

public ServerlessClusterAttributes()

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 }
            };

Properties

ClusterEndpointAddress

Cluster endpoint address.

public string? ClusterEndpointAddress { get; set; }

Property Value

string

Remarks

Default: - no endpoint address

ClusterIdentifier

Identifier for the cluster.

public string ClusterIdentifier { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Port

The database port.

public double? Port { get; set; }

Property Value

double?

Remarks

Default: - none

ReaderEndpointAddress

Reader endpoint address.

public string? ReaderEndpointAddress { get; set; }

Property Value

string

Remarks

Default: - no reader address

Secret

The secret attached to the database cluster.

public ISecret? Secret { get; set; }

Property Value

ISecret

Remarks

Default: - no secret

SecurityGroups

The security groups of the database cluster.

public ISecurityGroup[]? SecurityGroups { get; set; }

Property Value

ISecurityGroup[]

Remarks

Default: - no security groups

Implements

IServerlessClusterAttributes