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.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceSourceProps
DatabaseInstanceSourceProps.Builder, DatabaseInstanceSourceProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theDatabaseInstanceSourceProps.Builder.protectedJsii$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.JsonNodefinal booleanfinal NumberThe allocated storage size, specified in gibibytes (GiB).final BooleanWhether to allow major version upgrades.final BooleanSpecifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of thepreferredMaintenanceWindowsetting.final BooleanIndicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.final StringThe name of the Availability Zone where the DB instance will be located.final DurationThe number of days during which automatic DB snapshots are retained.final CaCertificateThe 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 RetentionDaysThe number of days log events are kept in CloudWatch Logs.final IRoleThe IAM role for the Lambda function associated with the custom resource that sets the retention policy.final BooleanIndicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.final DatabaseInsightsModeThe database insights mode.final StringThe name of the database.final BooleanIndicates whether automated backups should be deleted or retained when you delete a DB instance.final BooleanIndicates whether the DB instance should have deletion protection enabled.final StringThe Active Directory directory ID to create the DB instance in.final IRoleRefThe IAM role to be used when making API calls to the Directory Service.final BooleanWhether to enable Performance Insights for the DB instance.final IInstanceEngineThe database engine.final EngineLifecycleSupportThe life cycle type for this DB instance.final BooleanWhether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.final StringA name for the DB instance.final InstanceTypeThe name of the compute and memory capacity for the instance.final NumbergetIops()The number of I/O operations per second (IOPS) that the database provisions.final LicenseModelThe license model.final NumberUpper limit to which RDS can scale the storage in GiB(Gibibyte).final DurationThe interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.final IRoleRefRole that will be used to manage DB instance monitoring.final BooleanSpecifies if the database instance is a multiple Availability Zone deployment.final NetworkTypeThe network type of the DB instance.final IOptionGroupThe option group to associate with the instance.final IParameterGroupThe DB parameter group to associate with the instance.The parameters in the DBParameterGroup to create automatically.final IKeyRefThe AWS KMS key for encryption of Performance Insights data.The amount of time, in days, to retain Performance Insights data.final NumbergetPort()The port for the instance.final StringThe daily time range during which automated backups are performed.final StringThe weekly time range (in UTC) during which system maintenance can occur.final ProcessorFeaturesThe number of CPU cores and the number of threads per core.final BooleanIndicates whether the DB instance is an internet-facing instance.final RemovalPolicyThe 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 IRoleRole that will be associated with this DB instance to enable S3 export.S3 buckets that you want to load data from.final IRoleRole 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 NumberThe storage throughput, specified in mebibytes per second (MiBps).final StorageTypeThe storage type to associate with the DB instance.final ISubnetGroupExisting subnet group for the instance.final StringThe time zone of the instance.final IVpcgetVpc()The VPC network where the DB subnet group should be created.final SubnetSelectionThe type of subnets to add to the created DB subnet group.final inthashCode()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:DatabaseInstanceSourcePropsThe database engine.- Specified by:
getEnginein interfaceDatabaseInstanceSourceProps
-
getAllocatedStorage
Description copied from interface:DatabaseInstanceSourcePropsThe allocated storage size, specified in gibibytes (GiB).Default: 100
- Specified by:
getAllocatedStoragein interfaceDatabaseInstanceSourceProps
-
getAllowMajorVersionUpgrade
Description copied from interface:DatabaseInstanceSourcePropsWhether to allow major version upgrades.Default: false
- Specified by:
getAllowMajorVersionUpgradein interfaceDatabaseInstanceSourceProps
-
getDatabaseName
Description copied from interface:DatabaseInstanceSourcePropsThe name of the database.Default: - no name
- Specified by:
getDatabaseNamein interfaceDatabaseInstanceSourceProps
-
getInstanceType
Description copied from interface:DatabaseInstanceSourcePropsThe name of the compute and memory capacity for the instance.Default: - m5.large (or, more specifically, db.m5.large)
- Specified by:
getInstanceTypein interfaceDatabaseInstanceSourceProps
-
getLicenseModel
Description copied from interface:DatabaseInstanceSourcePropsThe license model.Default: - RDS default license model
- Specified by:
getLicenseModelin interfaceDatabaseInstanceSourceProps
-
getParameters
Description copied from interface:DatabaseInstanceSourcePropsThe 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:
getParametersin interfaceDatabaseInstanceSourceProps
-
getTimezone
Description copied from interface:DatabaseInstanceSourcePropsThe time zone of the instance.This is currently supported only by Microsoft Sql Server.
Default: - RDS default timezone
- Specified by:
getTimezonein interfaceDatabaseInstanceSourceProps
-
getVpc
Description copied from interface:DatabaseInstanceNewPropsThe VPC network where the DB subnet group should be created.- Specified by:
getVpcin interfaceDatabaseInstanceNewProps
-
getApplyImmediately
Description copied from interface:DatabaseInstanceNewPropsSpecifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of thepreferredMaintenanceWindowsetting.If set to
false, changes are applied during the next maintenance window.Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.
This property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.
Default: - Changes will be applied immediately
- Specified by:
getApplyImmediatelyin interfaceDatabaseInstanceNewProps- See Also:
-
getAutoMinorVersionUpgrade
Description copied from interface:DatabaseInstanceNewPropsIndicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.Default: true
- Specified by:
getAutoMinorVersionUpgradein interfaceDatabaseInstanceNewProps
-
getAvailabilityZone
Description copied from interface:DatabaseInstanceNewPropsThe name of the Availability Zone where the DB instance will be located.Default: - no preference
- Specified by:
getAvailabilityZonein interfaceDatabaseInstanceNewProps
-
getBackupRetention
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getBackupRetentionin interfaceDatabaseInstanceNewProps
-
getCaCertificate
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getCaCertificatein interfaceDatabaseInstanceNewProps- See Also:
-
getCloudwatchLogsExports
Description copied from interface:DatabaseInstanceNewPropsThe list of log types that need to be enabled for exporting to CloudWatch Logs.Default: - no log exports
- Specified by:
getCloudwatchLogsExportsin interfaceDatabaseInstanceNewProps
-
getCloudwatchLogsRetention
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getCloudwatchLogsRetentionin interfaceDatabaseInstanceNewProps
-
getCloudwatchLogsRetentionRole
Description copied from interface:DatabaseInstanceNewPropsThe IAM role for the Lambda function associated with the custom resource that sets the retention policy.Default: - a new role is created.
- Specified by:
getCloudwatchLogsRetentionRolein interfaceDatabaseInstanceNewProps
-
getCopyTagsToSnapshot
Description copied from interface:DatabaseInstanceNewPropsIndicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.Default: true
- Specified by:
getCopyTagsToSnapshotin interfaceDatabaseInstanceNewProps
-
getDatabaseInsightsMode
Description copied from interface:DatabaseInstanceNewPropsThe database insights mode.Default: - DatabaseInsightsMode.STANDARD when performance insights are enabled, otherwise not set.
- Specified by:
getDatabaseInsightsModein interfaceDatabaseInstanceNewProps
-
getDeleteAutomatedBackups
Description copied from interface:DatabaseInstanceNewPropsIndicates whether automated backups should be deleted or retained when you delete a DB instance.Default: true
- Specified by:
getDeleteAutomatedBackupsin interfaceDatabaseInstanceNewProps
-
getDeletionProtection
Description copied from interface:DatabaseInstanceNewPropsIndicates whether the DB instance should have deletion protection enabled.Default: - true if ``removalPolicy`` is RETAIN, false otherwise
- Specified by:
getDeletionProtectionin interfaceDatabaseInstanceNewProps
-
getDomain
Description copied from interface:DatabaseInstanceNewPropsThe Active Directory directory ID to create the DB instance in.Default: - Do not join domain
- Specified by:
getDomainin interfaceDatabaseInstanceNewProps
-
getDomainRole
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getDomainRolein interfaceDatabaseInstanceNewProps
-
getEnablePerformanceInsights
Description copied from interface:DatabaseInstanceNewPropsWhether to enable Performance Insights for the DB instance.Default: - false, unless ``performanceInsightRetention`` or ``performanceInsightEncryptionKey`` is set.
- Specified by:
getEnablePerformanceInsightsin interfaceDatabaseInstanceNewProps
-
getEngineLifecycleSupport
Description copied from interface:DatabaseInstanceNewPropsThe life cycle type for this DB instance.This setting applies only to RDS for MySQL and RDS for PostgreSQL.
Default: undefined - AWS RDS default setting is `EngineLifecycleSupport.OPEN_SOURCE_RDS_EXTENDED_SUPPORT`
- Specified by:
getEngineLifecycleSupportin interfaceDatabaseInstanceNewProps- See Also:
-
getIamAuthentication
Description copied from interface:DatabaseInstanceNewPropsWhether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.Default: false
- Specified by:
getIamAuthenticationin interfaceDatabaseInstanceNewProps
-
getInstanceIdentifier
Description copied from interface:DatabaseInstanceNewPropsA name for the DB instance.If you specify a name, AWS CloudFormation converts it to lowercase.
Default: - a CloudFormation generated name
- Specified by:
getInstanceIdentifierin interfaceDatabaseInstanceNewProps
-
getIops
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getIopsin interfaceDatabaseInstanceNewProps
-
getMaxAllocatedStorage
Description copied from interface:DatabaseInstanceNewPropsUpper limit to which RDS can scale the storage in GiB(Gibibyte).Default: - No autoscaling of RDS instance
- Specified by:
getMaxAllocatedStoragein interfaceDatabaseInstanceNewProps- See Also:
-
getMonitoringInterval
Description copied from interface:DatabaseInstanceNewPropsThe interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.Default: - no enhanced monitoring
- Specified by:
getMonitoringIntervalin interfaceDatabaseInstanceNewProps
-
getMonitoringRole
Description copied from interface:DatabaseInstanceNewPropsRole that will be used to manage DB instance monitoring.Default: - A role is automatically created for you
- Specified by:
getMonitoringRolein interfaceDatabaseInstanceNewProps
-
getMultiAz
Description copied from interface:DatabaseInstanceNewPropsSpecifies if the database instance is a multiple Availability Zone deployment.Default: false
- Specified by:
getMultiAzin interfaceDatabaseInstanceNewProps
-
getNetworkType
Description copied from interface:DatabaseInstanceNewPropsThe network type of the DB instance.Default: - IPV4
- Specified by:
getNetworkTypein interfaceDatabaseInstanceNewProps
-
getOptionGroup
Description copied from interface:DatabaseInstanceNewPropsThe option group to associate with the instance.Default: - no option group
- Specified by:
getOptionGroupin interfaceDatabaseInstanceNewProps
-
getParameterGroup
Description copied from interface:DatabaseInstanceNewPropsThe DB parameter group to associate with the instance.Default: - no parameter group
- Specified by:
getParameterGroupin interfaceDatabaseInstanceNewProps
-
getPerformanceInsightEncryptionKey
Description copied from interface:DatabaseInstanceNewPropsThe AWS KMS key for encryption of Performance Insights data.Default: - default master key
- Specified by:
getPerformanceInsightEncryptionKeyin interfaceDatabaseInstanceNewProps
-
getPerformanceInsightRetention
Description copied from interface:DatabaseInstanceNewPropsThe amount of time, in days, to retain Performance Insights data.If you set
databaseInsightsModetoDatabaseInsightsMode.ADVANCED, you must set this property toPerformanceInsightRetention.MONTHS_15.Default: 7 this is the free tier
- Specified by:
getPerformanceInsightRetentionin interfaceDatabaseInstanceNewProps
-
getPort
Description copied from interface:DatabaseInstanceNewPropsThe port for the instance.Default: - the default port for the chosen engine.
- Specified by:
getPortin interfaceDatabaseInstanceNewProps
-
getPreferredBackupWindow
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getPreferredBackupWindowin interfaceDatabaseInstanceNewProps
- Must be in the format
-
getPreferredMaintenanceWindow
Description copied from interface:DatabaseInstanceNewPropsThe weekly time range (in UTC) during which system maintenance can occur.Format:
ddd:hh24:mi-ddd:hh24:miConstraint: 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:
getPreferredMaintenanceWindowin interfaceDatabaseInstanceNewProps
-
getProcessorFeatures
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getProcessorFeaturesin interfaceDatabaseInstanceNewProps
-
getPubliclyAccessible
Description copied from interface:DatabaseInstanceNewPropsIndicates 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:
getPubliclyAccessiblein interfaceDatabaseInstanceNewProps
-
getRemovalPolicy
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getRemovalPolicyin interfaceDatabaseInstanceNewProps
-
getS3ExportBuckets
Description copied from interface:DatabaseInstanceNewPropsS3 buckets that you want to load data into.This property must not be used if
s3ExportRoleis used.For Microsoft SQL Server:
Default: - None
- Specified by:
getS3ExportBucketsin interfaceDatabaseInstanceNewProps- See Also:
-
getS3ExportRole
Description copied from interface:DatabaseInstanceNewPropsRole that will be associated with this DB instance to enable S3 export.This property must not be used if
s3ExportBucketsis used.For Microsoft SQL Server:
Default: - New role is created if `s3ExportBuckets` is set, no role is defined otherwise
- Specified by:
getS3ExportRolein interfaceDatabaseInstanceNewProps- See Also:
-
getS3ImportBuckets
Description copied from interface:DatabaseInstanceNewPropsS3 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
s3ImportRoleis used.For Microsoft SQL Server:
Default: - None
- Specified by:
getS3ImportBucketsin interfaceDatabaseInstanceNewProps- See Also:
-
getS3ImportRole
Description copied from interface:DatabaseInstanceNewPropsRole 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
s3ImportBucketsis used.For Microsoft SQL Server:
Default: - New role is created if `s3ImportBuckets` is set, no role is defined otherwise
- Specified by:
getS3ImportRolein interfaceDatabaseInstanceNewProps- See Also:
-
getSecurityGroups
Description copied from interface:DatabaseInstanceNewPropsThe security groups to assign to the DB instance.Default: - a new security group is created
- Specified by:
getSecurityGroupsin interfaceDatabaseInstanceNewProps
-
getStorageThroughput
Description copied from interface:DatabaseInstanceNewPropsThe 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:
getStorageThroughputin interfaceDatabaseInstanceNewProps- See Also:
-
getStorageType
Description copied from interface:DatabaseInstanceNewPropsThe storage type to associate with the DB instance.Storage types supported are gp2, gp3, io1, io2, and standard.
Default: StorageType.GP2
- Specified by:
getStorageTypein interfaceDatabaseInstanceNewProps- See Also:
-
getSubnetGroup
Description copied from interface:DatabaseInstanceNewPropsExisting subnet group for the instance.Default: - a new subnet group will be created.
- Specified by:
getSubnetGroupin interfaceDatabaseInstanceNewProps
-
getVpcSubnets
Description copied from interface:DatabaseInstanceNewPropsThe type of subnets to add to the created DB subnet group.Default: - private subnets
- Specified by:
getVpcSubnetsin interfaceDatabaseInstanceNewProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-