class DatabaseClusterEngine
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.RDS.DatabaseClusterEngine |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseClusterEngine |
![]() | software.amazon.awscdk.services.rds.DatabaseClusterEngine |
![]() | aws_cdk.aws_rds.DatabaseClusterEngine |
![]() | 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_3_01_0 }),
credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'), // Optional - will default to 'admin' username and generated password
writer: rds.ClusterInstance.provisioned('writer', {
publiclyAccessible: false,
}),
readers: [
rds.ClusterInstance.provisioned('reader1', { promotionTier: 1 }),
rds.ClusterInstance.serverlessV2('reader2'),
],
vpcSubnets: {
subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,
},
vpc,
});
Initializer
new DatabaseClusterEngine()
Properties
Name | Type | Description |
---|---|---|
static AURORA | ICluster | The unversioned 'aurora' cluster engine. |
static AURORA_MYSQL | ICluster | The unversioned 'aurora-msql' cluster engine. |
static AURORA_POSTGRESQL | ICluster | The unversioned 'aurora-postgresql' cluster engine. |
static AURORA
⚠️ Deprecated: use AURORA_MYSQL
instead
Type:
ICluster
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:
ICluster
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:
ICluster
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
Name | Description |
---|---|
static aurora(props) | Creates a new plain Aurora database cluster engine. |
static aurora | Creates a new Aurora MySQL database cluster engine. |
static aurora | Creates a new Aurora PostgreSQL database cluster engine. |
static aurora(props)
public static aurora(props: AuroraClusterEngineProps): IClusterEngine
⚠️ Deprecated: use auroraMysql()
instead
Parameters
- props
Aurora
Cluster Engine Props
Returns
Creates a new plain Aurora database cluster engine.
static auroraMysql(props)
public static auroraMysql(props: AuroraMysqlClusterEngineProps): IClusterEngine
Parameters
Returns
Creates a new Aurora MySQL database cluster engine.
static auroraPostgres(props)
public static auroraPostgres(props: AuroraPostgresClusterEngineProps): IClusterEngine
Parameters
Returns
Creates a new Aurora PostgreSQL database cluster engine.