java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.rds.DatabaseClusterProps.Jsii$Proxy

All Implemented Interfaces:: DatabaseClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: DatabaseClusterProps

@Stability(Stable) @Internal public static final class DatabaseClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DatabaseClusterProps

An implementation for 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

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(DatabaseClusterProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the DatabaseClusterProps.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 Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final Boolean

getAutoMinorVersionUpgrade()

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

final Duration

getBacktrackWindow()

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

final BackupProps

getBackup()

Backup settings.

final List<String>

getCloudwatchLogsExports()

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

final RetentionDays

getCloudwatchLogsRetention()

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

final IRole

getCloudwatchLogsRetentionRole()

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

final String

getClusterIdentifier()

An optional identifier for the cluster.

final ClusterScailabilityType

getClusterScailabilityType()

(deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster.

final ClusterScalabilityType

getClusterScalabilityType()

Specifies the scalability mode of the Aurora DB cluster.

final Boolean

getCopyTagsToSnapshot()

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

final Credentials

getCredentials()

Credentials for the administrative user.

final DatabaseInsightsMode

getDatabaseInsightsMode()

The database insights mode.

final String

getDefaultDatabaseName()

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

final Boolean

getDeleteAutomatedBackups()

Specifies whether to remove automated backups immediately after the DB cluster is deleted.

final Boolean

getDeletionProtection()

Indicates whether the DB cluster should have deletion protection enabled.

final String

getDomain()

Directory ID for associating the DB cluster with a specific Active Directory.

final IRole

getDomainRole()

The IAM role to be used when making API calls to the Directory Service.

final Boolean

getEnableClusterLevelEnhancedMonitoring()

Whether to enable enhanced monitoring at the cluster level.

final Boolean

getEnableDataApi()

Whether to enable the Data API for the cluster.

final Boolean

getEnableLocalWriteForwarding()

Whether read replicas can forward write operations to the writer DB instance in the DB cluster.

final Boolean

getEnablePerformanceInsights()

Whether to enable Performance Insights for the DB cluster.

final IClusterEngine

getEngine()

What kind of database to start.

final EngineLifecycleSupport

getEngineLifecycleSupport()

The life cycle type for this DB cluster.

final Boolean

getIamAuthentication()

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

final String

getInstanceIdentifierBase()

Base identifier for instances.

final InstanceProps

getInstanceProps()

(deprecated) Settings for the individual instances that are launched.

final Number

getInstances()

(deprecated) How many replicas/instances to create.

final InstanceUpdateBehaviour

getInstanceUpdateBehaviour()

The ordering of updates for instances.

final Duration

getMonitoringInterval()

The interval between points when Amazon RDS collects enhanced monitoring metrics.

final IRole

getMonitoringRole()

Role that will be used to manage DB monitoring.

final NetworkType

getNetworkType()

The network type of the DB instance.

final IParameterGroup

getParameterGroup()

Additional parameters to pass to the database engine.

final Map<String,String>

getParameters()

The parameters in the DBClusterParameterGroup to create automatically.

final IKey

getPerformanceInsightEncryptionKey()

The AWS KMS key for encryption of Performance Insights data.

final PerformanceInsightRetention

getPerformanceInsightRetention()

The amount of time, in days, to retain Performance Insights data.

final Number

getPort()

What port to listen on.

final String

getPreferredMaintenanceWindow()

A preferred maintenance window day/time range.

final List<IClusterInstance>

getReaders()

A list of instances to create as cluster reader instances.

final RemovalPolicy

getRemovalPolicy()

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

final String

getReplicationSourceIdentifier()

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

final List<IBucket>

getS3ExportBuckets()

S3 buckets that you want to load data into.

final IRole

getS3ExportRole()

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

final List<IBucket>

getS3ImportBuckets()

S3 buckets that you want to load data from.

final IRole

getS3ImportRole()

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

final List<ISecurityGroup>

getSecurityGroups()

Security group.

final Duration

getServerlessV2AutoPauseDuration()

Specifies the duration an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.

final Number

getServerlessV2MaxCapacity()

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.

final Number

getServerlessV2MinCapacity()

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.

final Boolean

getStorageEncrypted()

Whether to enable storage encryption.

final IKeyRef

getStorageEncryptionKey()

The KMS key for storage encryption.

final DBClusterStorageType

getStorageType()

The storage type to be associated with the DB cluster.

final ISubnetGroup

getSubnetGroup()

Existing subnet group for the cluster.

final IVpc

getVpc()

What subnets to run the RDS instances in.

final SubnetSelection

getVpcSubnets()

Where to place the instances within the VPC.

final IClusterInstance

getWriter()

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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
  
  protected Jsii$Proxy(DatabaseClusterProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the DatabaseClusterProps.Builder.
Method Details
- getEngine
  
  public final IClusterEngine getEngine()
  
  Description copied from interface: DatabaseClusterProps
  
  What kind of database to start.
  
  Specified by:
  
  getEngine in interface DatabaseClusterProps
- getAutoMinorVersionUpgrade
  
  public final Boolean 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 interface DatabaseClusterProps
- getBacktrackWindow
  
  public final Duration 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html
- getBackup
  
  public final BackupProps 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
- getCloudwatchLogsExports
  
  public final List<String> 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 interface DatabaseClusterProps
- getCloudwatchLogsRetention
  
  public final RetentionDays 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 interface DatabaseClusterProps
- getCloudwatchLogsRetentionRole
  
  public final IRole 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 interface DatabaseClusterProps
- getClusterIdentifier
  
  public final String getClusterIdentifier()
  
  Description copied from interface: DatabaseClusterProps
  
  An optional identifier for the cluster.
  Default: - A name is automatically generated.
  
  Specified by:
  
  getClusterIdentifier in interface DatabaseClusterProps
- getClusterScailabilityType
  
  public final ClusterScailabilityType getClusterScailabilityType()
  
  Description copied from interface: DatabaseClusterProps
  
  (deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster.
  Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.
  Default: ClusterScailabilityType.STANDARD
  
  Specified by:
  
  getClusterScailabilityType in interface DatabaseClusterProps
- getClusterScalabilityType
  
  public final ClusterScalabilityType getClusterScalabilityType()
  
  Description copied from interface: DatabaseClusterProps
  
  Specifies the scalability mode of the Aurora DB cluster.
  Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.
  Default: ClusterScalabilityType.STANDARD
  
  Specified by:
  
  getClusterScalabilityType in interface DatabaseClusterProps
- getCopyTagsToSnapshot
  
  public final Boolean getCopyTagsToSnapshot()
  
  Description copied from interface: DatabaseClusterProps
  
  Whether to copy tags to the snapshot when a snapshot is created.
  Default: - true
  
  Specified by:
  
  getCopyTagsToSnapshot in interface DatabaseClusterProps
- getCredentials
  
  public final Credentials 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 interface DatabaseClusterProps
- getDatabaseInsightsMode
  
  public final DatabaseInsightsMode getDatabaseInsightsMode()
  
  Description copied from interface: DatabaseClusterProps
  
  The database insights mode.
  Default: - DatabaseInsightsMode.STANDARD when performance insights are enabled and Amazon Aurora engine is used, otherwise not set.
  
  Specified by:
  
  getDatabaseInsightsMode in interface DatabaseClusterProps
- getDefaultDatabaseName
  
  public final String 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 interface DatabaseClusterProps
- getDeleteAutomatedBackups
  
  public final Boolean getDeleteAutomatedBackups()
  
  Description copied from interface: DatabaseClusterProps
  
  Specifies whether to remove automated backups immediately after the DB cluster is deleted.
  Default: undefined - AWS RDS default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule.
  
  Specified by:
  
  getDeleteAutomatedBackups in interface DatabaseClusterProps
- getDeletionProtection
  
  public final Boolean 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 interface DatabaseClusterProps
- getDomain
  
  public final String 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 interface DatabaseClusterProps
- getDomainRole
  
  public final IRole 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 interface DatabaseClusterProps
- getEnableClusterLevelEnhancedMonitoring
  
  public final Boolean getEnableClusterLevelEnhancedMonitoring()
  
  Description copied from interface: DatabaseClusterProps
  
  Whether to enable enhanced monitoring at the cluster level.
  If set to true, monitoringInterval and monitoringRole are applied to not the instances, but the cluster. monitoringInterval is required to be set if enableClusterLevelEnhancedMonitoring is set to true.
  Default: - When the `monitoringInterval` is set, enhanced monitoring is enabled for each instance.
  
  Specified by:
  
  getEnableClusterLevelEnhancedMonitoring in interface DatabaseClusterProps
- getEnableDataApi
  
  public final Boolean getEnableDataApi()
  
  Description copied from interface: DatabaseClusterProps
  
  Whether to enable the Data API for the cluster.
  Default: - false
  
  Specified by:
  
  getEnableDataApi in interface DatabaseClusterProps
- getEnableLocalWriteForwarding
  
  public final Boolean 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-postgresql-write-forwarding.html
- getEnablePerformanceInsights
  
  public final Boolean getEnablePerformanceInsights()
  
  Description copied from interface: DatabaseClusterProps
  
  Whether to enable Performance Insights for the DB cluster.
  Default: - false, unless `performanceInsightRetention` or `performanceInsightEncryptionKey` is set, or `databaseInsightsMode` is set to `DatabaseInsightsMode.ADVANCED`.
  
  Specified by:
  
  getEnablePerformanceInsights in interface DatabaseClusterProps
- getEngineLifecycleSupport
  
  public final EngineLifecycleSupport getEngineLifecycleSupport()
  
  Description copied from interface: DatabaseClusterProps
  
  The life cycle type for this DB cluster.
  Default: undefined - AWS RDS default setting is `EngineLifecycleSupport.OPEN_SOURCE_RDS_EXTENDED_SUPPORT`
  Specified by:
  
  getEngineLifecycleSupport in interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
- getIamAuthentication
  
  public final Boolean 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 interface DatabaseClusterProps
- getInstanceIdentifierBase
  
  public final String 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 interface DatabaseClusterProps
- getInstanceProps
  
  public final InstanceProps getInstanceProps()
  
  Description copied from interface: DatabaseClusterProps
  
  (deprecated) Settings for the individual instances that are launched.
  
  Specified by:
  
  getInstanceProps in interface DatabaseClusterProps
- getInstances
  
  public final Number 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 interface DatabaseClusterProps
- getInstanceUpdateBehaviour
  
  public final InstanceUpdateBehaviour getInstanceUpdateBehaviour()
  
  Description copied from interface: DatabaseClusterProps
  
  The ordering of updates for instances.
  Default: InstanceUpdateBehaviour.BULK
  
  Specified by:
  
  getInstanceUpdateBehaviour in interface DatabaseClusterProps
- getMonitoringInterval
  
  public final Duration getMonitoringInterval()
  
  Description copied from interface: DatabaseClusterProps
  
  The interval between points when Amazon RDS collects enhanced monitoring metrics.
  If you enable enableClusterLevelEnhancedMonitoring, this property is applied to the cluster, otherwise it is applied to the instances.
  Default: - no enhanced monitoring
  
  Specified by:
  
  getMonitoringInterval in interface DatabaseClusterProps
- getMonitoringRole
  
  public final IRole getMonitoringRole()
  
  Description copied from interface: DatabaseClusterProps
  
  Role that will be used to manage DB monitoring.
  If you enable enableClusterLevelEnhancedMonitoring, this property is applied to the cluster, otherwise it is applied to the instances.
  Default: - A role is automatically created for you
  
  Specified by:
  
  getMonitoringRole in interface DatabaseClusterProps
- getNetworkType
  
  public final NetworkType getNetworkType()
  
  Description copied from interface: DatabaseClusterProps
  
  The network type of the DB instance.
  Default: - IPV4
  
  Specified by:
  
  getNetworkType in interface DatabaseClusterProps
- getParameterGroup
  
  public final IParameterGroup getParameterGroup()
  
  Description copied from interface: DatabaseClusterProps
  
  Additional parameters to pass to the database engine.
  Default: - No parameter group.
  
  Specified by:
  
  getParameterGroup in interface DatabaseClusterProps
- getParameters
  
  public final Map<String,String> 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 interface DatabaseClusterProps
- getPerformanceInsightEncryptionKey
  
  public final IKey getPerformanceInsightEncryptionKey()
  
  Description copied from interface: DatabaseClusterProps
  
  The AWS KMS key for encryption of Performance Insights data.
  Default: - default master key
  
  Specified by:
  
  getPerformanceInsightEncryptionKey in interface DatabaseClusterProps
- getPerformanceInsightRetention
  
  public final PerformanceInsightRetention getPerformanceInsightRetention()
  
  Description copied from interface: DatabaseClusterProps
  
  The amount of time, in days, to retain Performance Insights data.
  If you set databaseInsightsMode to DatabaseInsightsMode.ADVANCED, you must set this property to PerformanceInsightRetention.MONTHS_15.
  Default: - 7
  
  Specified by:
  
  getPerformanceInsightRetention in interface DatabaseClusterProps
- getPort
  
  public final Number getPort()
  
  Description copied from interface: DatabaseClusterProps
  
  What port to listen on.
  Default: - The default for the engine is used.
  
  Specified by:
  
  getPort in interface DatabaseClusterProps
- getPreferredMaintenanceWindow
  
  public final String 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
- getReaders
  
  public final List<IClusterInstance> 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 interface DatabaseClusterProps
- getRemovalPolicy
  
  public final RemovalPolicy 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 interface DatabaseClusterProps
- getReplicationSourceIdentifier
  
  public final String getReplicationSourceIdentifier()
  
  Description copied from interface: DatabaseClusterProps
  
  The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
  Cannot be used with credentials.
  Default: - This DB Cluster is not a read replica
  
  Specified by:
  
  getReplicationSourceIdentifier in interface DatabaseClusterProps
- getS3ExportBuckets
  
  public final List<IBucket> 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html
- getS3ExportRole
  
  public final IRole 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html
- getS3ImportBuckets
  
  public final List<IBucket> 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html
- getS3ImportRole
  
  public final IRole 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html
- getSecurityGroups
  
  public final List<ISecurityGroup> getSecurityGroups()
  
  Description copied from interface: DatabaseClusterProps
  
  Security group.
  Default: - a new security group is created.
  
  Specified by:
  
  getSecurityGroups in interface DatabaseClusterProps
- getServerlessV2AutoPauseDuration
  
  public final Duration getServerlessV2AutoPauseDuration()
  
  Description copied from interface: DatabaseClusterProps
  
  Specifies the duration an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.
  The duration must be between 300 seconds (5 minutes) and 86,400 seconds (24 hours).
  Default: - The default is 300 seconds (5 minutes).
  Specified by:
  
  getServerlessV2AutoPauseDuration in interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2-auto-pause.html
- getServerlessV2MaxCapacity
  
  public final Number 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 interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations
- getServerlessV2MinCapacity
  
  public final Number 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.
  For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
  Default: 0.5
  Specified by:
  
  getServerlessV2MinCapacity in interface DatabaseClusterProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.min_capacity_considerations
- getStorageEncrypted
  
  public final Boolean getStorageEncrypted()
  
  Description copied from interface: DatabaseClusterProps
  
  Whether to enable storage encryption.
  Default: - true if storageEncryptionKey is provided, false otherwise
  
  Specified by:
  
  getStorageEncrypted in interface DatabaseClusterProps
- getStorageEncryptionKey
  
  public final IKeyRef getStorageEncryptionKey()
  
  Description copied from interface: DatabaseClusterProps
  
  The KMS key for storage encryption.
  If specified, storageEncrypted will be set to true.
  Default: - if storageEncrypted is true then the default master key, no key otherwise
  
  Specified by:
  
  getStorageEncryptionKey in interface DatabaseClusterProps
- getStorageType
  
  public final DBClusterStorageType getStorageType()
  
  Description copied from interface: DatabaseClusterProps
  
  The storage type to be associated with the DB cluster.
  Default: - DBClusterStorageType.AURORA
  
  Specified by:
  
  getStorageType in interface DatabaseClusterProps
- getSubnetGroup
  
  public final ISubnetGroup getSubnetGroup()
  
  Description copied from interface: DatabaseClusterProps
  
  Existing subnet group for the cluster.
  Default: - a new subnet group will be created.
  
  Specified by:
  
  getSubnetGroup in interface DatabaseClusterProps
- getVpc
  
  public final IVpc 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 interface DatabaseClusterProps
- getVpcSubnets
  
  public final SubnetSelection 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 interface DatabaseClusterProps
- getWriter
  
  public final IClusterInstance 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 interface DatabaseClusterProps
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class DatabaseClusterProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.DatabaseClusterProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getEngine

getAutoMinorVersionUpgrade

getBacktrackWindow

getBackup

getCloudwatchLogsExports

getCloudwatchLogsRetention

getCloudwatchLogsRetentionRole

getClusterIdentifier

getClusterScailabilityType

getClusterScalabilityType

getCopyTagsToSnapshot

getCredentials

getDatabaseInsightsMode

getDefaultDatabaseName

getDeleteAutomatedBackups

getDeletionProtection

getDomain

getDomainRole

getEnableClusterLevelEnhancedMonitoring

getEnableDataApi

getEnableLocalWriteForwarding

getEnablePerformanceInsights

getEngineLifecycleSupport

getIamAuthentication

getInstanceIdentifierBase

getInstanceProps

getInstances

getInstanceUpdateBehaviour

getMonitoringInterval

getMonitoringRole

getNetworkType

getParameterGroup

getParameters

getPerformanceInsightEncryptionKey

getPerformanceInsightRetention

getPort

getPreferredMaintenanceWindow

getReaders

getRemovalPolicy

getReplicationSourceIdentifier

getS3ExportBuckets

getS3ExportRole

getS3ImportBuckets

getS3ImportRole

getSecurityGroups

getServerlessV2AutoPauseDuration

getServerlessV2MaxCapacity

getServerlessV2MinCapacity

getStorageEncrypted

getStorageEncryptionKey

getStorageType

getSubnetGroup

getVpc

getVpcSubnets

getWriter

$jsii$toJson

equals

hashCode