software.amazon.awscdk.services.rds

Interface DatabaseClusterFromSnapshotProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseClusterFromSnapshotProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:21.835Z")
 @Stability(value=Experimental)
public interface DatabaseClusterFromSnapshotProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for ``DatabaseClusterFromSnapshot``.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DatabaseClusterFromSnapshotProps.Builder A builder for DatabaseClusterFromSnapshotProps
static class	DatabaseClusterFromSnapshotProps.Jsii$Proxy An implementation for DatabaseClusterFromSnapshotProps

Method Summary

Modifier and Type	Method and Description
static DatabaseClusterFromSnapshotProps.Builder	builder()
default BackupProps	getBackup() (experimental) Backup settings.
default List<String>	getCloudwatchLogsExports() (experimental) The list of log types that need to be enabled for exporting to CloudWatch Logs.
default RetentionDays	getCloudwatchLogsRetention() (experimental) The number of days log events are kept in CloudWatch Logs.
default IRole	getCloudwatchLogsRetentionRole() (experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
default String	getClusterIdentifier() (experimental) An optional identifier for the cluster.
default String	getDefaultDatabaseName() (experimental) Name of a database which is automatically created inside the cluster.
default Boolean	getDeletionProtection() (experimental) Indicates whether the DB cluster should have deletion protection enabled.
IClusterEngine	getEngine() (experimental) What kind of database to start.
default Boolean	getIamAuthentication() (experimental) Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
default String	getInstanceIdentifierBase() (experimental) Base identifier for instances.
InstanceProps	getInstanceProps() (experimental) Settings for the individual instances that are launched.
default Number	getInstances() (experimental) How many replicas/instances to create.
default Duration	getMonitoringInterval() (experimental) The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
default IRole	getMonitoringRole() (experimental) Role that will be used to manage DB instances monitoring.
default IParameterGroup	getParameterGroup() (experimental) Additional parameters to pass to the database engine.
default Number	getPort() (experimental) What port to listen on.
default String	getPreferredMaintenanceWindow() (experimental) A preferred maintenance window day/time range.
default RemovalPolicy	getRemovalPolicy() (experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
default List<IBucket>	getS3ExportBuckets() (experimental) S3 buckets that you want to load data into.
default IRole	getS3ExportRole() (experimental) Role that will be associated with this DB cluster to enable S3 export.
default List<IBucket>	getS3ImportBuckets() (experimental) S3 buckets that you want to load data from.
default IRole	getS3ImportRole() (experimental) Role that will be associated with this DB cluster to enable S3 import.
String	getSnapshotIdentifier() (experimental) The identifier for the DB instance snapshot or DB cluster snapshot to restore from.
default ISubnetGroup	getSubnetGroup() (experimental) Existing subnet group for the cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEngine

@Stability(value=Experimental)
 @NotNull
IClusterEngine getEngine()

(experimental) What kind of database to start.

getInstanceProps

@Stability(value=Experimental)
 @NotNull
InstanceProps getInstanceProps()

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

getSnapshotIdentifier

@Stability(value=Experimental)
 @NotNull
String getSnapshotIdentifier()

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

getBackup

@Stability(value=Experimental)
 @Nullable
default BackupProps getBackup()

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

See Also:

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

getCloudwatchLogsExports

@Stability(value=Experimental)
 @Nullable
default List<String> getCloudwatchLogsExports()

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

Default: - no log exports

getCloudwatchLogsRetention

@Stability(value=Experimental)
 @Nullable
default RetentionDays getCloudwatchLogsRetention()

(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

getCloudwatchLogsRetentionRole

@Stability(value=Experimental)
 @Nullable
default IRole getCloudwatchLogsRetentionRole()

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

Default: - a new role is created.

getClusterIdentifier

@Stability(value=Experimental)
 @Nullable
default String getClusterIdentifier()

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

getDefaultDatabaseName

@Stability(value=Experimental)
 @Nullable
default String getDefaultDatabaseName()

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

Default: - Database is not created in cluster.

getDeletionProtection

@Stability(value=Experimental)
 @Nullable
default Boolean getDeletionProtection()

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

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

getIamAuthentication

@Stability(value=Experimental)
 @Nullable
default Boolean getIamAuthentication()

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

Default: false

getInstanceIdentifierBase

@Stability(value=Experimental)
 @Nullable
default String getInstanceIdentifierBase()

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

getInstances

@Stability(value=Experimental)
 @Nullable
default Number getInstances()

(experimental) How many replicas/instances to create.

Has to be at least 1.

Default: 2

getMonitoringInterval

@Stability(value=Experimental)
 @Nullable
default Duration getMonitoringInterval()

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

Default: no enhanced monitoring

getMonitoringRole

@Stability(value=Experimental)
 @Nullable
default IRole getMonitoringRole()

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

Default: - A role is automatically created for you

getParameterGroup

@Stability(value=Experimental)
 @Nullable
default IParameterGroup getParameterGroup()

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

Default: - No parameter group.

getPort

@Stability(value=Experimental)
 @Nullable
default Number getPort()

(experimental) What port to listen on.

Default: - The default for the engine is used.

getPreferredMaintenanceWindow

@Stability(value=Experimental)
 @Nullable
default String getPreferredMaintenanceWindow()

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

See Also:

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

getRemovalPolicy

@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()

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

getS3ExportBuckets

@Stability(value=Experimental)
 @Nullable
default List<IBucket> getS3ExportBuckets()

(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

See Also:

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

getS3ExportRole

@Stability(value=Experimental)
 @Nullable
default IRole getS3ExportRole()

(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

See Also:

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

getS3ImportBuckets

@Stability(value=Experimental)
 @Nullable
default List<IBucket> getS3ImportBuckets()

(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

See Also:

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

getS3ImportRole

@Stability(value=Experimental)
 @Nullable
default IRole getS3ImportRole()

(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

See Also:

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

getSubnetGroup

@Stability(value=Experimental)
 @Nullable
default ISubnetGroup getSubnetGroup()

(experimental) Existing subnet group for the cluster.

Default: - a new subnet group will be created.

builder

@Stability(value=Experimental)
static DatabaseClusterFromSnapshotProps.Builder builder()

Returns:

a DatabaseClusterFromSnapshotProps.Builder of DatabaseClusterFromSnapshotProps