software.amazon.awscdk.services.rds

Class DatabaseClusterProps.Jsii$Proxy

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(value=Experimental)
 @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 and Description
protected	Jsii$Proxy(IClusterEngine engine, InstanceProps instanceProps, BackupProps backup, List<String> cloudwatchLogsExports, RetentionDays cloudwatchLogsRetention, IRole cloudwatchLogsRetentionRole, String clusterIdentifier, Credentials credentials, String defaultDatabaseName, Boolean deletionProtection, Boolean iamAuthentication, String instanceIdentifierBase, Number instances, Duration monitoringInterval, IRole monitoringRole, IParameterGroup parameterGroup, Number port, String preferredMaintenanceWindow, RemovalPolicy removalPolicy, List<? extends IBucket> s3ExportBuckets, IRole s3ExportRole, List<? extends IBucket> s3ImportBuckets, IRole s3ImportRole, Boolean storageEncrypted, IKey storageEncryptionKey, ISubnetGroup subnetGroup) 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 and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
BackupProps	getBackup() (experimental) Backup settings.
List<String>	getCloudwatchLogsExports() (experimental) The list of log types that need to be enabled for exporting to CloudWatch Logs.
RetentionDays	getCloudwatchLogsRetention() (experimental) The number of days log events are kept in CloudWatch Logs.
IRole	getCloudwatchLogsRetentionRole() (experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
String	getClusterIdentifier() (experimental) An optional identifier for the cluster.
Credentials	getCredentials() (experimental) Credentials for the administrative user.
String	getDefaultDatabaseName() (experimental) Name of a database which is automatically created inside the cluster.
Boolean	getDeletionProtection() (experimental) Indicates whether the DB cluster should have deletion protection enabled.
IClusterEngine	getEngine() (experimental) What kind of database to start.
Boolean	getIamAuthentication() (experimental) Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
String	getInstanceIdentifierBase() (experimental) Base identifier for instances.
InstanceProps	getInstanceProps() (experimental) Settings for the individual instances that are launched.
Number	getInstances() (experimental) How many replicas/instances to create.
Duration	getMonitoringInterval() (experimental) The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
IRole	getMonitoringRole() (experimental) Role that will be used to manage DB instances monitoring.
IParameterGroup	getParameterGroup() (experimental) Additional parameters to pass to the database engine.
Number	getPort() (experimental) What port to listen on.
String	getPreferredMaintenanceWindow() (experimental) A preferred maintenance window day/time range.
RemovalPolicy	getRemovalPolicy() (experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
List<IBucket>	getS3ExportBuckets() (experimental) S3 buckets that you want to load data into.
IRole	getS3ExportRole() (experimental) Role that will be associated with this DB cluster to enable S3 export.
List<IBucket>	getS3ImportBuckets() (experimental) S3 buckets that you want to load data from.
IRole	getS3ImportRole() (experimental) Role that will be associated with this DB cluster to enable S3 import.
Boolean	getStorageEncrypted() (experimental) Whether to enable storage encryption.
IKey	getStorageEncryptionKey() (experimental) The KMS key for storage encryption.
ISubnetGroup	getSubnetGroup() (experimental) Existing subnet group for the cluster.
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

Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseClusterProps

builder

Constructor Detail

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(IClusterEngine engine,
                     InstanceProps instanceProps,
                     BackupProps backup,
                     List<String> cloudwatchLogsExports,
                     RetentionDays cloudwatchLogsRetention,
                     IRole cloudwatchLogsRetentionRole,
                     String clusterIdentifier,
                     Credentials credentials,
                     String defaultDatabaseName,
                     Boolean deletionProtection,
                     Boolean iamAuthentication,
                     String instanceIdentifierBase,
                     Number instances,
                     Duration monitoringInterval,
                     IRole monitoringRole,
                     IParameterGroup parameterGroup,
                     Number port,
                     String preferredMaintenanceWindow,
                     RemovalPolicy removalPolicy,
                     List<? extends IBucket> s3ExportBuckets,
                     IRole s3ExportRole,
                     List<? extends IBucket> s3ImportBuckets,
                     IRole s3ImportRole,
                     Boolean storageEncrypted,
                     IKey storageEncryptionKey,
                     ISubnetGroup subnetGroup)

Constructor that initializes the object based on literal property values passed by the DatabaseClusterProps.Builder.

Method Detail

getEngine

public final IClusterEngine getEngine()

Description copied from interface: DatabaseClusterProps

(experimental) What kind of database to start.

Specified by:

getEngine in interface DatabaseClusterProps

getInstanceProps

public final InstanceProps getInstanceProps()

Description copied from interface: DatabaseClusterProps

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

Specified by:

getInstanceProps in interface DatabaseClusterProps

getBackup

public final BackupProps getBackup()

Description copied from interface: DatabaseClusterProps

(experimental) 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

(experimental) 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

(experimental) 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

(experimental) 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

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

Specified by:

getClusterIdentifier in interface DatabaseClusterProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: DatabaseClusterProps

(experimental) Credentials for the administrative user.

Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password

Specified by:

getCredentials in interface DatabaseClusterProps

getDefaultDatabaseName

public final String getDefaultDatabaseName()

Description copied from interface: DatabaseClusterProps

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

Default: - Database is not created in cluster.

Specified by:

getDefaultDatabaseName in interface DatabaseClusterProps

getDeletionProtection

public final Boolean getDeletionProtection()

Description copied from interface: DatabaseClusterProps

(experimental) Indicates whether the DB cluster should have deletion protection enabled.

Default: - true if ``removalPolicy`` is RETAIN, false otherwise

Specified by:

getDeletionProtection in interface DatabaseClusterProps

getIamAuthentication

public final Boolean getIamAuthentication()

Description copied from interface: DatabaseClusterProps

(experimental) 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

(experimental) 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

getInstances

public final Number getInstances()

Description copied from interface: DatabaseClusterProps

(experimental) How many replicas/instances to create.

Has to be at least 1.

Default: 2

Specified by:

getInstances in interface DatabaseClusterProps

getMonitoringInterval

public final Duration getMonitoringInterval()

Description copied from interface: DatabaseClusterProps

(experimental) 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 interface DatabaseClusterProps

getMonitoringRole

public final IRole getMonitoringRole()

Description copied from interface: DatabaseClusterProps

(experimental) Role that will be used to manage DB instances monitoring.

Default: - A role is automatically created for you

Specified by:

getMonitoringRole in interface DatabaseClusterProps

getParameterGroup

public final IParameterGroup getParameterGroup()

Description copied from interface: DatabaseClusterProps

(experimental) Additional parameters to pass to the database engine.

Default: - No parameter group.

Specified by:

getParameterGroup in interface DatabaseClusterProps

getPort

public final Number getPort()

Description copied from interface: DatabaseClusterProps

(experimental) 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

(experimental) 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

getRemovalPolicy

public final RemovalPolicy getRemovalPolicy()

Description copied from interface: DatabaseClusterProps

(experimental) 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

getS3ExportBuckets

public final List<IBucket> getS3ExportBuckets()

Description copied from interface: DatabaseClusterProps

(experimental) 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

(experimental) 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:

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

(experimental) 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

(experimental) 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:

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

getStorageEncrypted

public final Boolean getStorageEncrypted()

Description copied from interface: DatabaseClusterProps

(experimental) Whether to enable storage encryption.

Default: - true if storageEncryptionKey is provided, false otherwise

Specified by:

getStorageEncrypted in interface DatabaseClusterProps

getStorageEncryptionKey

public final IKey getStorageEncryptionKey()

Description copied from interface: DatabaseClusterProps

(experimental) The KMS key for storage encryption.

If specified, {@link 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

getSubnetGroup

public final ISubnetGroup getSubnetGroup()

Description copied from interface: DatabaseClusterProps

(experimental) Existing subnet group for the cluster.

Default: - a new subnet group will be created.

Specified by:

getSubnetGroup 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