Package software.amazon.awscdk.services.rds

Class DatabaseClusterFromSnapshotProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

DatabaseClusterFromSnapshotProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DatabaseClusterFromSnapshotProps

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

An implementation for DatabaseClusterFromSnapshotProps

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.DatabaseClusterFromSnapshotProps

DatabaseClusterFromSnapshotProps.Builder, DatabaseClusterFromSnapshotProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DatabaseClusterFromSnapshotProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the DatabaseClusterFromSnapshotProps.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 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 Boolean	getCopyTagsToSnapshot()	Whether to copy tags to the snapshot when a snapshot is created.
final Credentials	getCredentials()	Credentials for the administrative user.
final String	getDefaultDatabaseName()	Name of a database which is automatically created inside the cluster.
final Boolean	getDeletionProtection()	Indicates whether the DB cluster should have deletion protection enabled.
final IClusterEngine	getEngine()	What kind of database to start.
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()	Settings for the individual instances that are launched.
final Number	getInstances()	How many replicas/instances to create.
final Duration	getMonitoringInterval()	The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
final IRole	getMonitoringRole()	Role that will be used to manage DB instances monitoring.
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 Number	getPort()	What port to listen on.
final String	getPreferredMaintenanceWindow()	A preferred maintenance window day/time range.
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 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 String	getSnapshotIdentifier()	The identifier for the DB instance snapshot or DB cluster snapshot to restore from.
final Boolean	getStorageEncrypted()	Whether to enable storage encryption.
final IKey	getStorageEncryptionKey()	The KMS key for storage encryption.
final ISubnetGroup	getSubnetGroup()	Existing subnet group for the cluster.
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(DatabaseClusterFromSnapshotProps.Builder builder)

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

Method Details

getEngine

public final IClusterEngine getEngine()

Description copied from interface: DatabaseClusterFromSnapshotProps

What kind of database to start.

Specified by:

getEngine in interface DatabaseClusterFromSnapshotProps

getInstanceProps

public final InstanceProps getInstanceProps()

Description copied from interface: DatabaseClusterFromSnapshotProps

Settings for the individual instances that are launched.

Specified by:

getInstanceProps in interface DatabaseClusterFromSnapshotProps

getSnapshotIdentifier

public final String getSnapshotIdentifier()

Description copied from interface: DatabaseClusterFromSnapshotProps

The identifier for the DB instance snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB instance snapshot.

Specified by:

getSnapshotIdentifier in interface DatabaseClusterFromSnapshotProps

getBacktrackWindow

public final Duration getBacktrackWindow()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

See Also:

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

getBackup

public final BackupProps getBackup()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

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: DatabaseClusterFromSnapshotProps

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

Default: - no log exports

Specified by:

getCloudwatchLogsExports in interface DatabaseClusterFromSnapshotProps

getCloudwatchLogsRetention

public final RetentionDays getCloudwatchLogsRetention()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

getCloudwatchLogsRetentionRole

public final IRole getCloudwatchLogsRetentionRole()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

getClusterIdentifier

public final String getClusterIdentifier()

Description copied from interface: DatabaseClusterFromSnapshotProps

An optional identifier for the cluster.

Default: - A name is automatically generated.

Specified by:

getClusterIdentifier in interface DatabaseClusterFromSnapshotProps

getCopyTagsToSnapshot

public final Boolean getCopyTagsToSnapshot()

Description copied from interface: DatabaseClusterFromSnapshotProps

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

Default: - true

Specified by:

getCopyTagsToSnapshot in interface DatabaseClusterFromSnapshotProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: DatabaseClusterFromSnapshotProps

Credentials for the administrative user.

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

Specified by:

getCredentials in interface DatabaseClusterFromSnapshotProps

getDefaultDatabaseName

public final String getDefaultDatabaseName()

Description copied from interface: DatabaseClusterFromSnapshotProps

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

Default: - Database is not created in cluster.

Specified by:

getDefaultDatabaseName in interface DatabaseClusterFromSnapshotProps

getDeletionProtection

public final Boolean getDeletionProtection()

Description copied from interface: DatabaseClusterFromSnapshotProps

Indicates whether the DB cluster should have deletion protection enabled.

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

Specified by:

getDeletionProtection in interface DatabaseClusterFromSnapshotProps

getIamAuthentication

public final Boolean getIamAuthentication()

Description copied from interface: DatabaseClusterFromSnapshotProps

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

Default: false

Specified by:

getIamAuthentication in interface DatabaseClusterFromSnapshotProps

getInstanceIdentifierBase

public final String getInstanceIdentifierBase()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

getInstances

public final Number getInstances()

Description copied from interface: DatabaseClusterFromSnapshotProps

How many replicas/instances to create.

Has to be at least 1.

Default: 2

Specified by:

getInstances in interface DatabaseClusterFromSnapshotProps

getMonitoringInterval

public final Duration getMonitoringInterval()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

getMonitoringRole

public final IRole getMonitoringRole()

Description copied from interface: DatabaseClusterFromSnapshotProps

Role that will be used to manage DB instances monitoring.

Default: - A role is automatically created for you

Specified by:

getMonitoringRole in interface DatabaseClusterFromSnapshotProps

getParameterGroup

public final IParameterGroup getParameterGroup()

Description copied from interface: DatabaseClusterFromSnapshotProps

Additional parameters to pass to the database engine.

Default: - No parameter group.

Specified by:

getParameterGroup in interface DatabaseClusterFromSnapshotProps

getParameters

public final Map<String,String> getParameters()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

getPort

public final Number getPort()

Description copied from interface: DatabaseClusterFromSnapshotProps

What port to listen on.

Default: - The default for the engine is used.

Specified by:

getPort in interface DatabaseClusterFromSnapshotProps

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

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: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

getS3ExportBuckets

public final List<IBucket> getS3ExportBuckets()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

See Also:

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

getS3ExportRole

public final IRole getS3ExportRole()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

See Also:

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

getS3ImportBuckets

public final List<IBucket> getS3ImportBuckets()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

See Also:

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

getS3ImportRole

public final IRole getS3ImportRole()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

See Also:

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

getStorageEncrypted

public final Boolean getStorageEncrypted()

Description copied from interface: DatabaseClusterFromSnapshotProps

Whether to enable storage encryption.

Default: - true if storageEncryptionKey is provided, false otherwise

Specified by:

getStorageEncrypted in interface DatabaseClusterFromSnapshotProps

getStorageEncryptionKey

public final IKey getStorageEncryptionKey()

Description copied from interface: DatabaseClusterFromSnapshotProps

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 DatabaseClusterFromSnapshotProps

getSubnetGroup

public final ISubnetGroup getSubnetGroup()

Description copied from interface: DatabaseClusterFromSnapshotProps

Existing subnet group for the cluster.

Default: - a new subnet group will be created.

Specified by:

getSubnetGroup in interface DatabaseClusterFromSnapshotProps

$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