aws-cdk-lib.aws_rds.DatabaseClusterEngine

class DatabaseClusterEngine

LanguageType name
.NETAmazon.CDK.AWS.RDS.DatabaseClusterEngine
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseClusterEngine
Javasoftware.amazon.awscdk.services.rds.DatabaseClusterEngine
Pythonaws_cdk.aws_rds.DatabaseClusterEngine
TypeScript (source)aws-cdk-lib » aws_rds » DatabaseClusterEngine

A database cluster engine.

Provides mapping to the serverless application used for secret rotation.

Example

declare const vpc: ec2.Vpc;
const cluster = new rds.DatabaseCluster(this, 'Database', {
  engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),
  credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'), // Optional - will default to 'admin' username and generated password
  writer: rds.ClusterInstance.provisioned('writer', {
  readers: [
    rds.ClusterInstance.provisioned('reader1', { promotionTier: 1 }),
    rds.ClusterInstance.serverlessV2('reader2'),
  ]
  vpcSubnets: {
    subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,
  },
  vpc,
});

Initializer

new DatabaseClusterEngine()

Properties

NameTypeDescription
static AURORAIClusterEngineThe unversioned 'aurora' cluster engine.
static AURORA_MYSQLIClusterEngineThe unversioned 'aurora-msql' cluster engine.
static AURORA_POSTGRESQLIClusterEngineThe unversioned 'aurora-postgresql' cluster engine.

static AURORA

Type: IClusterEngine

The unversioned 'aurora' cluster engine.

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


static AURORA_MYSQL

Type: IClusterEngine

The unversioned 'aurora-msql' cluster engine.

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


static AURORA_POSTGRESQL

Type: IClusterEngine

The unversioned 'aurora-postgresql' cluster engine.

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

NameDescription
static aurora(props)Creates a new plain Aurora database cluster engine.
static auroraMysql(props)Creates a new Aurora MySQL database cluster engine.
static auroraPostgres(props)Creates a new Aurora PostgreSQL database cluster engine.

static aurora(props)

public static aurora(props: AuroraClusterEngineProps): IClusterEngine

Parameters

  • props AuroraClusterEngineProps

Returns

  • IClusterEngine

Creates a new plain Aurora database cluster engine.


static auroraMysql(props)

public static auroraMysql(props: AuroraMysqlClusterEngineProps): IClusterEngine

Parameters

  • props AuroraMysqlClusterEngineProps

Returns

  • IClusterEngine

Creates a new Aurora MySQL database cluster engine.


static auroraPostgres(props)

public static auroraPostgres(props: AuroraPostgresClusterEngineProps): IClusterEngine

Parameters

  • props AuroraPostgresClusterEngineProps

Returns

  • IClusterEngine

Creates a new Aurora PostgreSQL database cluster engine.