Class DatabaseClusterAttributes
Properties that describe an existing cluster instance.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class DatabaseClusterAttributes : Object, IDatabaseClusterAttributes
Syntax (vb)
Public Class DatabaseClusterAttributes
Inherits Object
Implements 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.EC2;
using Amazon.CDK.AWS.RDS;
IClusterEngine clusterEngine;
SecurityGroup securityGroup;
var databaseClusterAttributes = new DatabaseClusterAttributes {
ClusterIdentifier = "clusterIdentifier",
// the properties below are optional
ClusterEndpointAddress = "clusterEndpointAddress",
Engine = clusterEngine,
InstanceEndpointAddresses = new [] { "instanceEndpointAddresses" },
InstanceIdentifiers = new [] { "instanceIdentifiers" },
Port = 123,
ReaderEndpointAddress = "readerEndpointAddress",
SecurityGroups = new [] { securityGroup }
};
Synopsis
Constructors
DatabaseClusterAttributes() |
Properties
ClusterEndpointAddress | Cluster endpoint address. |
ClusterIdentifier | Identifier for the cluster. |
Engine | The engine of the existing Cluster. |
InstanceEndpointAddresses | Endpoint addresses of individual instances. |
InstanceIdentifiers | Identifier for the instances. |
Port | The database port. |
ReaderEndpointAddress | Reader endpoint address. |
SecurityGroups | The security groups of the database cluster. |
Constructors
DatabaseClusterAttributes()
public DatabaseClusterAttributes()
Properties
ClusterEndpointAddress
Cluster endpoint address.
public string ClusterEndpointAddress { get; set; }
Property Value
System.String
Remarks
Default: - no endpoint address
ClusterIdentifier
Identifier for the cluster.
public string ClusterIdentifier { get; set; }
Property Value
System.String
Engine
The engine of the existing Cluster.
public IClusterEngine Engine { get; set; }
Property Value
Remarks
Default: - the imported Cluster's engine is unknown
InstanceEndpointAddresses
Endpoint addresses of individual instances.
public string[] InstanceEndpointAddresses { get; set; }
Property Value
System.String[]
Remarks
Default: - no instance endpoints
InstanceIdentifiers
Identifier for the instances.
public string[] InstanceIdentifiers { get; set; }
Property Value
System.String[]
Remarks
Default: - no instance identifiers
Port
The database port.
public Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - none
ReaderEndpointAddress
Reader endpoint address.
public string ReaderEndpointAddress { get; set; }
Property Value
System.String
Remarks
Default: - no reader address
SecurityGroups
The security groups of the database cluster.
public ISecurityGroup[] SecurityGroups { get; set; }
Property Value
Remarks
Default: - no security groups