Class DatabaseClusterProps.Jsii$Proxy
- All Implemented Interfaces:
DatabaseClusterProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
DatabaseClusterProps
DatabaseClusterProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.DatabaseClusterProps
DatabaseClusterProps.Builder, DatabaseClusterProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(DatabaseClusterProps.Builder builder) Constructor that initializes the object based on literal property values passed by theDatabaseClusterProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.final Duration
The number of seconds to set a cluster's target backtrack window to.final BackupProps
Backup settings.The list of log types that need to be enabled for exporting to CloudWatch Logs.final RetentionDays
The number of days log events are kept in CloudWatch Logs.final IRole
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.final String
An optional identifier for the cluster.final Boolean
Whether to copy tags to the snapshot when a snapshot is created.final Credentials
Credentials for the administrative user.final String
Name of a database which is automatically created inside the cluster.final Boolean
Indicates whether the DB cluster should have deletion protection enabled.final String
Directory ID for associating the DB cluster with a specific Active Directory.final IRole
The IAM role to be used when making API calls to the Directory Service.final Boolean
Whether to enable the Data API for the cluster.final Boolean
Whether read replicas can forward write operations to the writer DB instance in the DB cluster.final Boolean
Whether to enable Performance Insights for the DB cluster.final IClusterEngine
What kind of database to start.final Boolean
Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.final String
Base identifier for instances.final InstanceProps
(deprecated) Settings for the individual instances that are launched.final Number
(deprecated) How many replicas/instances to create.final InstanceUpdateBehaviour
The ordering of updates for instances.final Duration
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.final IRole
Role that will be used to manage DB instances monitoring.final NetworkType
The network type of the DB instance.final IParameterGroup
Additional parameters to pass to the database engine.The parameters in the DBClusterParameterGroup to create automatically.final IKey
The AWS KMS key for encryption of Performance Insights data.The amount of time, in days, to retain Performance Insights data.final Number
getPort()
What port to listen on.final String
A preferred maintenance window day/time range.final List<IClusterInstance>
A list of instances to create as cluster reader instances.final RemovalPolicy
The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.S3 buckets that you want to load data into.final IRole
Role that will be associated with this DB cluster to enable S3 export.S3 buckets that you want to load data from.final IRole
Role that will be associated with this DB cluster to enable S3 import.final List<ISecurityGroup>
Security group.final Number
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.final Number
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.final Boolean
Whether to enable storage encryption.final IKey
The KMS key for storage encryption.final DBClusterStorageType
The storage type to be associated with the DB cluster.final ISubnetGroup
Existing subnet group for the cluster.final IVpc
getVpc()
What subnets to run the RDS instances in.final SubnetSelection
Where to place the instances within the VPC.final IClusterInstance
The instance to use for the cluster writer.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theDatabaseClusterProps.Builder
.
-
-
Method Details
-
getEngine
Description copied from interface:DatabaseClusterProps
What kind of database to start.- Specified by:
getEngine
in interfaceDatabaseClusterProps
-
getAutoMinorVersionUpgrade
Description copied from interface:DatabaseClusterProps
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.Default: true
- Specified by:
getAutoMinorVersionUpgrade
in interfaceDatabaseClusterProps
-
getBacktrackWindow
Description copied from interface:DatabaseClusterProps
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.
Default: 0 seconds (no backtrack)
- Specified by:
getBacktrackWindow
in interfaceDatabaseClusterProps
- See Also:
-
getBackup
Description copied from interface:DatabaseClusterProps
Backup settings.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.
- Specified by:
getBackup
in interfaceDatabaseClusterProps
- See Also:
-
getCloudwatchLogsExports
Description copied from interface:DatabaseClusterProps
The list of log types that need to be enabled for exporting to CloudWatch Logs.Default: - no log exports
- Specified by:
getCloudwatchLogsExports
in interfaceDatabaseClusterProps
-
getCloudwatchLogsRetention
Description copied from interface:DatabaseClusterProps
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
.Default: - logs never expire
- Specified by:
getCloudwatchLogsRetention
in interfaceDatabaseClusterProps
-
getCloudwatchLogsRetentionRole
Description copied from interface:DatabaseClusterProps
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.Default: - a new role is created.
- Specified by:
getCloudwatchLogsRetentionRole
in interfaceDatabaseClusterProps
-
getClusterIdentifier
Description copied from interface:DatabaseClusterProps
An optional identifier for the cluster.Default: - A name is automatically generated.
- Specified by:
getClusterIdentifier
in interfaceDatabaseClusterProps
-
getCopyTagsToSnapshot
Description copied from interface:DatabaseClusterProps
Whether to copy tags to the snapshot when a snapshot is created.Default: - true
- Specified by:
getCopyTagsToSnapshot
in interfaceDatabaseClusterProps
-
getCredentials
Description copied from interface:DatabaseClusterProps
Credentials for the administrative user.Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password
- Specified by:
getCredentials
in interfaceDatabaseClusterProps
-
getDefaultDatabaseName
Description copied from interface:DatabaseClusterProps
Name of a database which is automatically created inside the cluster.Default: - Database is not created in cluster.
- Specified by:
getDefaultDatabaseName
in interfaceDatabaseClusterProps
-
getDeletionProtection
Description copied from interface:DatabaseClusterProps
Indicates whether the DB cluster should have deletion protection enabled.Default: - true if `removalPolicy` is RETAIN, `undefined` otherwise, which will not enable deletion protection. To disable deletion protection after it has been enabled, you must explicitly set this value to `false`.
- Specified by:
getDeletionProtection
in interfaceDatabaseClusterProps
-
getDomain
Description copied from interface:DatabaseClusterProps
Directory ID for associating the DB cluster with a specific Active Directory.Necessary for enabling Kerberos authentication. If specified, the DB cluster joins the given Active Directory, enabling Kerberos authentication. If not specified, the DB cluster will not be associated with any Active Directory, and Kerberos authentication will not be enabled.
Default: - DB cluster is not associated with an Active Directory; Kerberos authentication is not enabled.
- Specified by:
getDomain
in interfaceDatabaseClusterProps
-
getDomainRole
Description copied from interface:DatabaseClusterProps
The IAM role to be used when making API calls to the Directory Service.The role needs the AWS-managed policy
AmazonRDSDirectoryServiceAccess
or equivalent.Default: - If `DatabaseClusterBaseProps.domain` is specified, a role with the `AmazonRDSDirectoryServiceAccess` policy is automatically created.
- Specified by:
getDomainRole
in interfaceDatabaseClusterProps
-
getEnableDataApi
Description copied from interface:DatabaseClusterProps
Whether to enable the Data API for the cluster.Default: - false
- Specified by:
getEnableDataApi
in interfaceDatabaseClusterProps
-
getEnableLocalWriteForwarding
Description copied from interface:DatabaseClusterProps
Whether read replicas can forward write operations to the writer DB instance in the DB cluster.This setting can only be enabled for Aurora MySQL 3.04 or higher, and for Aurora PostgreSQL 16.4 or higher (for version 16), 15.8 or higher (for version 15), and 14.13 or higher (for version 14).
Default: false
- Specified by:
getEnableLocalWriteForwarding
in interfaceDatabaseClusterProps
- See Also:
-
getEnablePerformanceInsights
Description copied from interface:DatabaseClusterProps
Whether to enable Performance Insights for the DB cluster.Default: - false, unless `performanceInsightRetention` or `performanceInsightEncryptionKey` is set.
- Specified by:
getEnablePerformanceInsights
in interfaceDatabaseClusterProps
-
getIamAuthentication
Description copied from interface:DatabaseClusterProps
Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.Default: false
- Specified by:
getIamAuthentication
in interfaceDatabaseClusterProps
-
getInstanceIdentifierBase
Description copied from interface:DatabaseClusterProps
Base identifier for instances.Every replica is named by appending the replica number to this string, 1-based.
Default: - clusterIdentifier is used with the word "Instance" appended. If clusterIdentifier is not provided, the identifier is automatically generated.
- Specified by:
getInstanceIdentifierBase
in interfaceDatabaseClusterProps
-
getInstanceProps
Description copied from interface:DatabaseClusterProps
(deprecated) Settings for the individual instances that are launched.- Specified by:
getInstanceProps
in interfaceDatabaseClusterProps
-
getInstances
Description copied from interface:DatabaseClusterProps
(deprecated) How many replicas/instances to create.Has to be at least 1.
Default: 2
- Specified by:
getInstances
in interfaceDatabaseClusterProps
-
getInstanceUpdateBehaviour
Description copied from interface:DatabaseClusterProps
The ordering of updates for instances.Default: InstanceUpdateBehaviour.BULK
- Specified by:
getInstanceUpdateBehaviour
in interfaceDatabaseClusterProps
-
getMonitoringInterval
Description copied from interface:DatabaseClusterProps
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.Default: no enhanced monitoring
- Specified by:
getMonitoringInterval
in interfaceDatabaseClusterProps
-
getMonitoringRole
Description copied from interface:DatabaseClusterProps
Role that will be used to manage DB instances monitoring.Default: - A role is automatically created for you
- Specified by:
getMonitoringRole
in interfaceDatabaseClusterProps
-
getNetworkType
Description copied from interface:DatabaseClusterProps
The network type of the DB instance.Default: - IPV4
- Specified by:
getNetworkType
in interfaceDatabaseClusterProps
-
getParameterGroup
Description copied from interface:DatabaseClusterProps
Additional parameters to pass to the database engine.Default: - No parameter group.
- Specified by:
getParameterGroup
in interfaceDatabaseClusterProps
-
getParameters
Description copied from interface:DatabaseClusterProps
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.
Default: - None
- Specified by:
getParameters
in interfaceDatabaseClusterProps
-
getPerformanceInsightEncryptionKey
Description copied from interface:DatabaseClusterProps
The AWS KMS key for encryption of Performance Insights data.Default: - default master key
- Specified by:
getPerformanceInsightEncryptionKey
in interfaceDatabaseClusterProps
-
getPerformanceInsightRetention
Description copied from interface:DatabaseClusterProps
The amount of time, in days, to retain Performance Insights data.Default: 7
- Specified by:
getPerformanceInsightRetention
in interfaceDatabaseClusterProps
-
getPort
Description copied from interface:DatabaseClusterProps
What port to listen on.Default: - The default for the engine is used.
- Specified by:
getPort
in interfaceDatabaseClusterProps
-
getPreferredMaintenanceWindow
Description copied from interface:DatabaseClusterProps
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'
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.
- Specified by:
getPreferredMaintenanceWindow
in interfaceDatabaseClusterProps
- See Also:
-
getReaders
Description copied from interface:DatabaseClusterProps
A list of instances to create as cluster reader instances.Default: - no readers are created. The cluster will have a single writer/reader
- Specified by:
getReaders
in interfaceDatabaseClusterProps
-
getRemovalPolicy
Description copied from interface:DatabaseClusterProps
The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)
- Specified by:
getRemovalPolicy
in interfaceDatabaseClusterProps
-
getS3ExportBuckets
Description copied from interface:DatabaseClusterProps
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:
Default: - None
- Specified by:
getS3ExportBuckets
in interfaceDatabaseClusterProps
- See Also:
-
getS3ExportRole
Description copied from interface:DatabaseClusterProps
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. To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine For MySQL:Default: - New role is created if `s3ExportBuckets` is set, no role is defined otherwise
- Specified by:
getS3ExportRole
in interfaceDatabaseClusterProps
- See Also:
-
getS3ImportBuckets
Description copied from interface:DatabaseClusterProps
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:
Default: - None
- Specified by:
getS3ImportBuckets
in interfaceDatabaseClusterProps
- See Also:
-
getS3ImportRole
Description copied from interface:DatabaseClusterProps
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. To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine For MySQL:Default: - New role is created if `s3ImportBuckets` is set, no role is defined otherwise
- Specified by:
getS3ImportRole
in interfaceDatabaseClusterProps
- See Also:
-
getSecurityGroups
Description copied from interface:DatabaseClusterProps
Security group.Default: a new security group is created.
- Specified by:
getSecurityGroups
in interfaceDatabaseClusterProps
-
getServerlessV2MaxCapacity
Description copied from interface:DatabaseClusterProps
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 256.
The maximum capacity must be higher than 0.5 ACUs.
Default: 2
- Specified by:
getServerlessV2MaxCapacity
in interfaceDatabaseClusterProps
- See Also:
-
getServerlessV2MinCapacity
Description copied from interface:DatabaseClusterProps
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
Default: 0.5
- Specified by:
getServerlessV2MinCapacity
in interfaceDatabaseClusterProps
- See Also:
-
getStorageEncrypted
Description copied from interface:DatabaseClusterProps
Whether to enable storage encryption.Default: - true if storageEncryptionKey is provided, false otherwise
- Specified by:
getStorageEncrypted
in interfaceDatabaseClusterProps
-
getStorageEncryptionKey
Description copied from interface:DatabaseClusterProps
The KMS key for storage encryption.If specified,
storageEncrypted
will be set totrue
.Default: - if storageEncrypted is true then the default master key, no key otherwise
- Specified by:
getStorageEncryptionKey
in interfaceDatabaseClusterProps
-
getStorageType
Description copied from interface:DatabaseClusterProps
The storage type to be associated with the DB cluster.Default: - DBClusterStorageType.AURORA_IOPT1
- Specified by:
getStorageType
in interfaceDatabaseClusterProps
-
getSubnetGroup
Description copied from interface:DatabaseClusterProps
Existing subnet group for the cluster.Default: - a new subnet group will be created.
- Specified by:
getSubnetGroup
in interfaceDatabaseClusterProps
-
getVpc
Description copied from interface:DatabaseClusterProps
What subnets to run the RDS instances in.Must be at least 2 subnets in two different AZs.
- Specified by:
getVpc
in interfaceDatabaseClusterProps
-
getVpcSubnets
Description copied from interface:DatabaseClusterProps
Where to place the instances within the VPC.Default: - the Vpc default strategy if not specified.
- Specified by:
getVpcSubnets
in interfaceDatabaseClusterProps
-
getWriter
Description copied from interface:DatabaseClusterProps
The instance to use for the cluster writer.Default: required if instanceProps is not provided
- Specified by:
getWriter
in interfaceDatabaseClusterProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-