Class DatabaseClusterEngine
A database cluster engine.
Inheritance
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DatabaseClusterEngine : DeputyBase
Syntax (vb)
Public Class DatabaseClusterEngine
Inherits DeputyBase
Remarks
Provides mapping to the serverless application used for secret rotation.
ExampleMetadata: infused
Examples
Vpc vpc;
var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
Engine = DatabaseClusterEngine.AuroraMysql(new AuroraMysqlClusterEngineProps { Version = AuroraMysqlEngineVersion.VER_3_01_0 }),
Credentials = Credentials.FromGeneratedSecret("clusteradmin"), // Optional - will default to 'admin' username and generated password
Writer = ClusterInstance.Provisioned("writer", new ProvisionedClusterInstanceProps {
PubliclyAccessible = false
}),
Readers = new [] { ClusterInstance.Provisioned("reader1", new ProvisionedClusterInstanceProps { PromotionTier = 1 }), ClusterInstance.ServerlessV2("reader2") },
VpcSubnets = new SubnetSelection {
SubnetType = SubnetType.PRIVATE_WITH_EGRESS
},
Vpc = vpc
});
Synopsis
Constructors
DatabaseClusterEngine() | |
DatabaseClusterEngine(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
DatabaseClusterEngine(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AURORA | The unversioned 'aurora' cluster engine. |
AURORA_MYSQL | The unversioned 'aurora-msql' cluster engine. |
AURORA_POSTGRESQL | The unversioned 'aurora-postgresql' cluster engine. |
Methods
Aurora(IAuroraClusterEngineProps) | Creates a new plain Aurora database cluster engine. |
AuroraMysql(IAuroraMysqlClusterEngineProps) | Creates a new Aurora MySQL database cluster engine. |
AuroraPostgres(IAuroraPostgresClusterEngineProps) | Creates a new Aurora PostgreSQL database cluster engine. |
Constructors
DatabaseClusterEngine()
public DatabaseClusterEngine()
DatabaseClusterEngine(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected DatabaseClusterEngine(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
DatabaseClusterEngine(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected DatabaseClusterEngine(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AURORA
The unversioned 'aurora' cluster engine.
public static IClusterEngine AURORA { get; }
Property Value
Remarks
Note: we do not recommend using unversioned engines for non-serverless Clusters,
as that can pose an availability risk.
We recommend using versioned engines created using the aurora()
method
AURORA_MYSQL
The unversioned 'aurora-msql' cluster engine.
public static IClusterEngine AURORA_MYSQL { get; }
Property Value
Remarks
Note: we do not recommend using unversioned engines for non-serverless Clusters,
as that can pose an availability risk.
We recommend using versioned engines created using the auroraMysql()
method
AURORA_POSTGRESQL
The unversioned 'aurora-postgresql' cluster engine.
public static IClusterEngine AURORA_POSTGRESQL { get; }
Property Value
Remarks
Note: we do not recommend using unversioned engines for non-serverless Clusters,
as that can pose an availability risk.
We recommend using versioned engines created using the auroraPostgres()
method
Methods
Aurora(IAuroraClusterEngineProps)
Creates a new plain Aurora database cluster engine.
public static IClusterEngine Aurora(IAuroraClusterEngineProps props)
Parameters
Returns
AuroraMysql(IAuroraMysqlClusterEngineProps)
Creates a new Aurora MySQL database cluster engine.
public static IClusterEngine AuroraMysql(IAuroraMysqlClusterEngineProps props)
Parameters
Returns
AuroraPostgres(IAuroraPostgresClusterEngineProps)
Creates a new Aurora PostgreSQL database cluster engine.
public static IClusterEngine AuroraPostgres(IAuroraPostgresClusterEngineProps props)
Parameters
Returns