Class DatabaseInstanceSourceProps.Jsii$Proxy
- All Implemented Interfaces:
DatabaseInstanceNewProps
,DatabaseInstanceSourceProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
DatabaseInstanceSourceProps
DatabaseInstanceSourceProps
-
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.DatabaseInstanceSourceProps
DatabaseInstanceSourceProps.Builder, DatabaseInstanceSourceProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theDatabaseInstanceSourceProps.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 Number
The allocated storage size, specified in gibibytes (GiB).final Boolean
Whether to allow major version upgrades.final Boolean
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.final String
The name of the Availability Zone where the DB instance will be located.final Duration
The number of days during which automatic DB snapshots are retained.final CaCertificate
The identifier of the CA certificate for this DB instance.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 Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.final String
The name of the database.final Boolean
Indicates whether automated backups should be deleted or retained when you delete a DB instance.final Boolean
Indicates whether the DB instance should have deletion protection enabled.final String
The Active Directory directory ID to create the DB instance in.final IRole
The IAM role to be used when making API calls to the Directory Service.final Boolean
Whether to enable Performance Insights for the DB instance.final IInstanceEngine
The database engine.final Boolean
Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.final String
A name for the DB instance.final InstanceType
The name of the compute and memory capacity for the instance.final Number
getIops()
The number of I/O operations per second (IOPS) that the database provisions.final LicenseModel
The license model.final Number
Upper limit to which RDS can scale the storage in GiB(Gibibyte).final Duration
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.final IRole
Role that will be used to manage DB instance monitoring.final Boolean
Specifies if the database instance is a multiple Availability Zone deployment.final NetworkType
The network type of the DB instance.final IOptionGroup
The option group to associate with the instance.final IParameterGroup
The DB parameter group to associate with the instance.The parameters in the DBParameterGroup 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()
The port for the instance.final String
The daily time range during which automated backups are performed.final String
The weekly time range (in UTC) during which system maintenance can occur.final ProcessorFeatures
The number of CPU cores and the number of threads per core.final Boolean
Indicates whether the DB instance is an internet-facing instance.final RemovalPolicy
The CloudFormation policy to apply when the instance is 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 instance to enable S3 export.S3 buckets that you want to load data from.final IRole
Role that will be associated with this DB instance to enable S3 import.final List<ISecurityGroup>
The security groups to assign to the DB instance.final Number
The storage throughput, specified in mebibytes per second (MiBps).final StorageType
The storage type.final ISubnetGroup
Existing subnet group for the instance.final String
The time zone of the instance.final IVpc
getVpc()
The VPC network where the DB subnet group should be created.final SubnetSelection
The type of subnets to add to the created DB subnet group.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 theDatabaseInstanceSourceProps.Builder
.
-
-
Method Details
-
getEngine
Description copied from interface:DatabaseInstanceSourceProps
The database engine.- Specified by:
getEngine
in interfaceDatabaseInstanceSourceProps
-
getAllocatedStorage
Description copied from interface:DatabaseInstanceSourceProps
The allocated storage size, specified in gibibytes (GiB).Default: 100
- Specified by:
getAllocatedStorage
in interfaceDatabaseInstanceSourceProps
-
getAllowMajorVersionUpgrade
Description copied from interface:DatabaseInstanceSourceProps
Whether to allow major version upgrades.Default: false
- Specified by:
getAllowMajorVersionUpgrade
in interfaceDatabaseInstanceSourceProps
-
getDatabaseName
Description copied from interface:DatabaseInstanceSourceProps
The name of the database.Default: - no name
- Specified by:
getDatabaseName
in interfaceDatabaseInstanceSourceProps
-
getInstanceType
Description copied from interface:DatabaseInstanceSourceProps
The name of the compute and memory capacity for the instance.Default: - m5.large (or, more specifically, db.m5.large)
- Specified by:
getInstanceType
in interfaceDatabaseInstanceSourceProps
-
getLicenseModel
Description copied from interface:DatabaseInstanceSourceProps
The license model.Default: - RDS default license model
- Specified by:
getLicenseModel
in interfaceDatabaseInstanceSourceProps
-
getParameters
Description copied from interface:DatabaseInstanceSourceProps
The parameters in the DBParameterGroup to create automatically.You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.
Default: - None
- Specified by:
getParameters
in interfaceDatabaseInstanceSourceProps
-
getTimezone
Description copied from interface:DatabaseInstanceSourceProps
The time zone of the instance.This is currently supported only by Microsoft Sql Server.
Default: - RDS default timezone
- Specified by:
getTimezone
in interfaceDatabaseInstanceSourceProps
-
getVpc
Description copied from interface:DatabaseInstanceNewProps
The VPC network where the DB subnet group should be created.- Specified by:
getVpc
in interfaceDatabaseInstanceNewProps
-
getAutoMinorVersionUpgrade
Description copied from interface:DatabaseInstanceNewProps
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.Default: true
- Specified by:
getAutoMinorVersionUpgrade
in interfaceDatabaseInstanceNewProps
-
getAvailabilityZone
Description copied from interface:DatabaseInstanceNewProps
The name of the Availability Zone where the DB instance will be located.Default: - no preference
- Specified by:
getAvailabilityZone
in interfaceDatabaseInstanceNewProps
-
getBackupRetention
Description copied from interface:DatabaseInstanceNewProps
The number of days during which automatic DB snapshots are retained.Set to zero to disable backups. When creating a read replica, you must enable automatic backups on the source database instance by setting the backup retention to a value other than zero.
Default: - Duration.days(1) for source instances, disabled for read replicas
- Specified by:
getBackupRetention
in interfaceDatabaseInstanceNewProps
-
getCaCertificate
Description copied from interface:DatabaseInstanceNewProps
The identifier of the CA certificate for this DB instance.Specifying or updating this property triggers a reboot.
For RDS DB engines:
Default: - RDS will choose a certificate authority
- Specified by:
getCaCertificate
in interfaceDatabaseInstanceNewProps
- See Also:
-
getCloudwatchLogsExports
Description copied from interface:DatabaseInstanceNewProps
The list of log types that need to be enabled for exporting to CloudWatch Logs.Default: - no log exports
- Specified by:
getCloudwatchLogsExports
in interfaceDatabaseInstanceNewProps
-
getCloudwatchLogsRetention
Description copied from interface:DatabaseInstanceNewProps
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 interfaceDatabaseInstanceNewProps
-
getCloudwatchLogsRetentionRole
Description copied from interface:DatabaseInstanceNewProps
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 interfaceDatabaseInstanceNewProps
-
getCopyTagsToSnapshot
Description copied from interface:DatabaseInstanceNewProps
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.Default: true
- Specified by:
getCopyTagsToSnapshot
in interfaceDatabaseInstanceNewProps
-
getDeleteAutomatedBackups
Description copied from interface:DatabaseInstanceNewProps
Indicates whether automated backups should be deleted or retained when you delete a DB instance.Default: true
- Specified by:
getDeleteAutomatedBackups
in interfaceDatabaseInstanceNewProps
-
getDeletionProtection
Description copied from interface:DatabaseInstanceNewProps
Indicates whether the DB instance should have deletion protection enabled.Default: - true if ``removalPolicy`` is RETAIN, false otherwise
- Specified by:
getDeletionProtection
in interfaceDatabaseInstanceNewProps
-
getDomain
Description copied from interface:DatabaseInstanceNewProps
The Active Directory directory ID to create the DB instance in.Default: - Do not join domain
- Specified by:
getDomain
in interfaceDatabaseInstanceNewProps
-
getDomainRole
Description copied from interface:DatabaseInstanceNewProps
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: - The role will be created for you if `DatabaseInstanceNewProps#domain` is specified
- Specified by:
getDomainRole
in interfaceDatabaseInstanceNewProps
-
getEnablePerformanceInsights
Description copied from interface:DatabaseInstanceNewProps
Whether to enable Performance Insights for the DB instance.Default: - false, unless ``performanceInsightRetention`` or ``performanceInsightEncryptionKey`` is set.
- Specified by:
getEnablePerformanceInsights
in interfaceDatabaseInstanceNewProps
-
getIamAuthentication
Description copied from interface:DatabaseInstanceNewProps
Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.Default: false
- Specified by:
getIamAuthentication
in interfaceDatabaseInstanceNewProps
-
getInstanceIdentifier
Description copied from interface:DatabaseInstanceNewProps
A name for the DB instance.If you specify a name, AWS CloudFormation converts it to lowercase.
Default: - a CloudFormation generated name
- Specified by:
getInstanceIdentifier
in interfaceDatabaseInstanceNewProps
-
getIops
Description copied from interface:DatabaseInstanceNewProps
The number of I/O operations per second (IOPS) that the database provisions.The value must be equal to or greater than 1000.
Default: - no provisioned iops if storage type is not specified. For GP3: 3,000 IOPS if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 12,000 IOPS otherwise (except for SQL Server where the default is always 3,000 IOPS).
- Specified by:
getIops
in interfaceDatabaseInstanceNewProps
-
getMaxAllocatedStorage
Description copied from interface:DatabaseInstanceNewProps
Upper limit to which RDS can scale the storage in GiB(Gibibyte).Default: - No autoscaling of RDS instance
- Specified by:
getMaxAllocatedStorage
in interfaceDatabaseInstanceNewProps
- See Also:
-
getMonitoringInterval
Description copied from interface:DatabaseInstanceNewProps
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.Default: - no enhanced monitoring
- Specified by:
getMonitoringInterval
in interfaceDatabaseInstanceNewProps
-
getMonitoringRole
Description copied from interface:DatabaseInstanceNewProps
Role that will be used to manage DB instance monitoring.Default: - A role is automatically created for you
- Specified by:
getMonitoringRole
in interfaceDatabaseInstanceNewProps
-
getMultiAz
Description copied from interface:DatabaseInstanceNewProps
Specifies if the database instance is a multiple Availability Zone deployment.Default: false
- Specified by:
getMultiAz
in interfaceDatabaseInstanceNewProps
-
getNetworkType
Description copied from interface:DatabaseInstanceNewProps
The network type of the DB instance.Default: - IPV4
- Specified by:
getNetworkType
in interfaceDatabaseInstanceNewProps
-
getOptionGroup
Description copied from interface:DatabaseInstanceNewProps
The option group to associate with the instance.Default: - no option group
- Specified by:
getOptionGroup
in interfaceDatabaseInstanceNewProps
-
getParameterGroup
Description copied from interface:DatabaseInstanceNewProps
The DB parameter group to associate with the instance.Default: - no parameter group
- Specified by:
getParameterGroup
in interfaceDatabaseInstanceNewProps
-
getPerformanceInsightEncryptionKey
Description copied from interface:DatabaseInstanceNewProps
The AWS KMS key for encryption of Performance Insights data.Default: - default master key
- Specified by:
getPerformanceInsightEncryptionKey
in interfaceDatabaseInstanceNewProps
-
getPerformanceInsightRetention
Description copied from interface:DatabaseInstanceNewProps
The amount of time, in days, to retain Performance Insights data.Default: 7 this is the free tier
- Specified by:
getPerformanceInsightRetention
in interfaceDatabaseInstanceNewProps
-
getPort
Description copied from interface:DatabaseInstanceNewProps
The port for the instance.Default: - the default port for the chosen engine.
- Specified by:
getPort
in interfaceDatabaseInstanceNewProps
-
getPreferredBackupWindow
Description copied from interface:DatabaseInstanceNewProps
The daily time range during which automated backups are performed.Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
Default: - a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
- Specified by:
getPreferredBackupWindow
in interfaceDatabaseInstanceNewProps
- Must be in the format
-
getPreferredMaintenanceWindow
Description copied from interface:DatabaseInstanceNewProps
The weekly time range (in UTC) during which system maintenance can occur.Format:
ddd:hh24:mi-ddd:hh24:mi
Constraint: Minimum 30-minute windowDefault: - 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. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
- Specified by:
getPreferredMaintenanceWindow
in interfaceDatabaseInstanceNewProps
-
getProcessorFeatures
Description copied from interface:DatabaseInstanceNewProps
The number of CPU cores and the number of threads per core.Default: - the default number of CPU cores and threads per core for the chosen instance class. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor
- Specified by:
getProcessorFeatures
in interfaceDatabaseInstanceNewProps
-
getPubliclyAccessible
Description copied from interface:DatabaseInstanceNewProps
Indicates whether the DB instance is an internet-facing instance.If not specified, the instance's vpcSubnets will be used to determine if the instance is internet-facing or not.
Default: - `true` if the instance's `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise
- Specified by:
getPubliclyAccessible
in interfaceDatabaseInstanceNewProps
-
getRemovalPolicy
Description copied from interface:DatabaseInstanceNewProps
The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.Default: - RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)
- Specified by:
getRemovalPolicy
in interfaceDatabaseInstanceNewProps
-
getS3ExportBuckets
Description copied from interface:DatabaseInstanceNewProps
S3 buckets that you want to load data into.This property must not be used if
s3ExportRole
is used.For Microsoft SQL Server:
Default: - None
- Specified by:
getS3ExportBuckets
in interfaceDatabaseInstanceNewProps
- See Also:
-
getS3ExportRole
Description copied from interface:DatabaseInstanceNewProps
Role that will be associated with this DB instance to enable S3 export.This property must not be used if
s3ExportBuckets
is used.For Microsoft SQL Server:
Default: - New role is created if `s3ExportBuckets` is set, no role is defined otherwise
- Specified by:
getS3ExportRole
in interfaceDatabaseInstanceNewProps
- See Also:
-
getS3ImportBuckets
Description copied from interface:DatabaseInstanceNewProps
S3 buckets that you want to load data from.This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
This property must not be used if
s3ImportRole
is used.For Microsoft SQL Server:
Default: - None
- Specified by:
getS3ImportBuckets
in interfaceDatabaseInstanceNewProps
- See Also:
-
getS3ImportRole
Description copied from interface:DatabaseInstanceNewProps
Role that will be associated with this DB instance to enable S3 import.This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
This property must not be used if
s3ImportBuckets
is used.For Microsoft SQL Server:
Default: - New role is created if `s3ImportBuckets` is set, no role is defined otherwise
- Specified by:
getS3ImportRole
in interfaceDatabaseInstanceNewProps
- See Also:
-
getSecurityGroups
Description copied from interface:DatabaseInstanceNewProps
The security groups to assign to the DB instance.Default: - a new security group is created
- Specified by:
getSecurityGroups
in interfaceDatabaseInstanceNewProps
-
getStorageThroughput
Description copied from interface:DatabaseInstanceNewProps
The storage throughput, specified in mebibytes per second (MiBps).Only applicable for GP3.
Default: - 125 MiBps if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 500 MiBps otherwise (except for SQL Server where the default is always 125 MiBps).
- Specified by:
getStorageThroughput
in interfaceDatabaseInstanceNewProps
- See Also:
-
getStorageType
Description copied from interface:DatabaseInstanceNewProps
The storage type.Storage types supported are gp2, io1, standard.
Default: GP2
- Specified by:
getStorageType
in interfaceDatabaseInstanceNewProps
- See Also:
-
getSubnetGroup
Description copied from interface:DatabaseInstanceNewProps
Existing subnet group for the instance.Default: - a new subnet group will be created.
- Specified by:
getSubnetGroup
in interfaceDatabaseInstanceNewProps
-
getVpcSubnets
Description copied from interface:DatabaseInstanceNewProps
The type of subnets to add to the created DB subnet group.Default: - private subnets
- Specified by:
getVpcSubnets
in interfaceDatabaseInstanceNewProps
-
$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()
-