Class DatabaseClusterEngine

A database cluster engine.

Inheritance

object

DatabaseClusterEngine

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_03_0
                 }),
                 Writer = ClusterInstance.Provisioned("writer"),
                 Vpc = vpc
             });

             var proxy = new DatabaseProxy(this, "Proxy", new DatabaseProxyProps {
                 ProxyTarget = ProxyTarget.FromCluster(cluster),
                 Secrets = new [] { cluster.Secret },
                 Vpc = vpc,
                 ClientPasswordAuthType = ClientPasswordAuthType.MYSQL_NATIVE_PASSWORD
             });

Synopsis

Constructors

DatabaseClusterEngine()

A database cluster engine.

Properties

AURORA	(deprecated) The unversioned 'aurora' cluster engine.
AURORA_MYSQL	The unversioned 'aurora-msql' cluster engine.
AURORA_POSTGRESQL	The unversioned 'aurora-postgresql' cluster engine.

Methods

Aurora(IAuroraClusterEngineProps)	(deprecated) 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()

A database cluster engine.

public DatabaseClusterEngine()

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_03_0
                 }),
                 Writer = ClusterInstance.Provisioned("writer"),
                 Vpc = vpc
             });

             var proxy = new DatabaseProxy(this, "Proxy", new DatabaseProxyProps {
                 ProxyTarget = ProxyTarget.FromCluster(cluster),
                 Secrets = new [] { cluster.Secret },
                 Vpc = vpc,
                 ClientPasswordAuthType = ClientPasswordAuthType.MYSQL_NATIVE_PASSWORD
             });

Properties

AURORA

(deprecated) The unversioned 'aurora' cluster engine.

[Obsolete("use `AURORA_MYSQL` instead")]
public static IClusterEngine AURORA { get; }

Property Value

IClusterEngine

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

Stability: Deprecated

AURORA_MYSQL

The unversioned 'aurora-msql' cluster engine.

public static IClusterEngine AURORA_MYSQL { get; }

Property Value

IClusterEngine

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

IClusterEngine

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)

(deprecated) Creates a new plain Aurora database cluster engine.

[Obsolete("use `auroraMysql()` instead")]
public static IClusterEngine Aurora(IAuroraClusterEngineProps props)

Parameters

props IAuroraClusterEngineProps

Returns

IClusterEngine

Remarks

Stability: Deprecated

AuroraMysql(IAuroraMysqlClusterEngineProps)

Creates a new Aurora MySQL database cluster engine.

public static IClusterEngine AuroraMysql(IAuroraMysqlClusterEngineProps props)

Parameters

props IAuroraMysqlClusterEngineProps

Returns

IClusterEngine

Remarks

Provides mapping to the serverless application used for secret rotation.

ExampleMetadata: infused

AuroraPostgres(IAuroraPostgresClusterEngineProps)

Creates a new Aurora PostgreSQL database cluster engine.

public static IClusterEngine AuroraPostgres(IAuroraPostgresClusterEngineProps props)

Parameters

props IAuroraPostgresClusterEngineProps

Returns

IClusterEngine

Remarks

Provides mapping to the serverless application used for secret rotation.

ExampleMetadata: infused