1.204.0

interface DatabaseClusterProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.DatabaseClusterProps
Javasoftware.amazon.awscdk.services.rds.DatabaseClusterProps
Pythonaws_cdk.aws_rds.DatabaseClusterProps
TypeScript (source)@aws-cdk/aws-rds » DatabaseClusterProps

Properties for a new database cluster.

Example

declare const vpc: ec2.Vpc;
const cluster = new rds.DatabaseCluster(this, 'Database', {
  engine: rds.DatabaseClusterEngine.AURORA,
  instanceProps: { vpc },
});

const proxy = new rds.DatabaseProxy(this, 'Proxy', {
  proxyTarget: rds.ProxyTarget.fromCluster(cluster),
  secrets: [cluster.secret!],
  vpc,
});

const role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });
proxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'.

Properties

NameTypeDescription
engineIClusterEngineWhat kind of database to start.
instancePropsInstancePropsSettings for the individual instances that are launched.
backtrackWindow?DurationThe number of seconds to set a cluster's target backtrack window to.
backup?BackupPropsBackup settings.
cloudwatchLogsExports?string[]The list of log types that need to be enabled for exporting to CloudWatch Logs.
cloudwatchLogsRetention?RetentionDaysThe number of days log events are kept in CloudWatch Logs.
cloudwatchLogsRetentionRole?IRoleThe IAM role for the Lambda function associated with the custom resource that sets the retention policy.
clusterIdentifier?stringAn optional identifier for the cluster.
copyTagsToSnapshot?booleanWhether to copy tags to the snapshot when a snapshot is created.
credentials?CredentialsCredentials for the administrative user.
defaultDatabaseName?stringName of a database which is automatically created inside the cluster.
deletionProtection?booleanIndicates whether the DB cluster should have deletion protection enabled.
iamAuthentication?booleanWhether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
instanceIdentifierBase?stringBase identifier for instances.
instances?numberHow many replicas/instances to create.
monitoringInterval?DurationThe interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
monitoringRole?IRoleRole that will be used to manage DB instances monitoring.
parameterGroup?IParameterGroupAdditional parameters to pass to the database engine.
parameters?{ [string]: string }The parameters in the DBClusterParameterGroup to create automatically.
port?numberWhat port to listen on.
preferredMaintenanceWindow?stringA preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
removalPolicy?RemovalPolicyThe removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
s3ExportBuckets?IBucket[]S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine.
s3ExportRole?IRoleRole that will be associated with this DB cluster to enable S3 export.
s3ImportBuckets?IBucket[]S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine.
s3ImportRole?IRoleRole that will be associated with this DB cluster to enable S3 import.
storageEncrypted?booleanWhether to enable storage encryption.
storageEncryptionKey?IKeyThe KMS key for storage encryption.
subnetGroup?ISubnetGroupExisting subnet group for the cluster.

engine

Type: IClusterEngine

What kind of database to start.

instanceProps

Type: InstanceProps

Settings for the individual instances that are launched.

backtrackWindow?

Type: Duration (optional, default: 0 seconds (no backtrack))

The number of seconds to set a cluster's target backtrack window to.

This feature is only supported by the Aurora MySQL database engine and cannot be enabled on existing clusters.

See also: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html

backup?

Type: BackupProps (optional, default: Backup retention period for automated backups is 1 day. Backup preferred window is set to a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.)

Backup settings.

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

cloudwatchLogsExports?

Type: string[] (optional, default: no log exports)

The list of log types that need to be enabled for exporting to CloudWatch Logs.

cloudwatchLogsRetention?

Type: RetentionDays (optional, default: logs never expire)

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.

cloudwatchLogsRetentionRole?

Type: IRole (optional, default: a new role is created.)

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

clusterIdentifier?

Type: string (optional, default: A name is automatically generated.)

An optional identifier for the cluster.

copyTagsToSnapshot?

Type: boolean (optional, default: true)

Whether to copy tags to the snapshot when a snapshot is created.

credentials?

Type: Credentials (optional, default: A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password)

Credentials for the administrative user.

defaultDatabaseName?

Type: string (optional, default: Database is not created in cluster.)

Name of a database which is automatically created inside the cluster.

deletionProtection?

Type: boolean (optional, default: true if removalPolicy is RETAIN, false otherwise)

Indicates whether the DB cluster should have deletion protection enabled.

iamAuthentication?

Type: boolean (optional, default: false)

Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

instanceIdentifierBase?

Type: string (optional, default: clusterIdentifier is used with the word "Instance" appended. If clusterIdentifier is not provided, the identifier is automatically generated.)

Base identifier for instances.

Every replica is named by appending the replica number to this string, 1-based.

instances?

Type: number (optional, default: 2)

How many replicas/instances to create.

Has to be at least 1.

monitoringInterval?

Type: Duration (optional, default: no enhanced monitoring)

The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.

monitoringRole?

Type: IRole (optional, default: A role is automatically created for you)

Role that will be used to manage DB instances monitoring.

parameterGroup?

Type: IParameterGroup (optional, default: No parameter group.)

Additional parameters to pass to the database engine.

parameters?

Type: { [string]: string } (optional, default: None)

The parameters in the DBClusterParameterGroup to create automatically.

You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBClusterParameterGroup.

port?

Type: number (optional, default: The default for the engine is used.)

What port to listen on.

preferredMaintenanceWindow?

Type: string (optional, default: 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.)

A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).

Example: 'Sun:23:45-Mon:00:15'

See also: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data))

The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.

s3ExportBuckets?

Type: IBucket[] (optional, default: None)

S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine.

This property must not be used if s3ExportRole is used.

For MySQL:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html

s3ExportRole?

Type: IRole (optional, default: New role is created if s3ExportBuckets is set, no role is defined otherwise)

Role that will be associated with this DB cluster to enable S3 export.

This feature is only supported by the Aurora database engine.

This property must not be used if s3ExportBuckets is used.

For MySQL:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html

s3ImportBuckets?

Type: IBucket[] (optional, default: None)

S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine.

This property must not be used if s3ImportRole is used.

For MySQL:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html

s3ImportRole?

Type: IRole (optional, default: New role is created if s3ImportBuckets is set, no role is defined otherwise)

Role that will be associated with this DB cluster to enable S3 import.

This feature is only supported by the Aurora database engine.

This property must not be used if s3ImportBuckets is used.

For MySQL:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html

storageEncrypted?

Type: boolean (optional, default: true if storageEncryptionKey is provided, false otherwise)

Whether to enable storage encryption.

storageEncryptionKey?

Type: IKey (optional, default: if storageEncrypted is true then the default master key, no key otherwise)

The KMS key for storage encryption.

If specified, {@link storageEncrypted} will be set to true.

subnetGroup?

Type: ISubnetGroup (optional, default: a new subnet group will be created.)

Existing subnet group for the cluster.

← PreviousNext →