@Stability(value=Experimental) @Internal public static final class DatabaseInstanceSourceProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DatabaseInstanceSourceProps
DatabaseInstanceSourcePropssoftware.amazon.jsii.JsiiObject.InitializationModeDatabaseInstanceSourceProps.Builder, DatabaseInstanceSourceProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(IInstanceEngine engine,
Number allocatedStorage,
Boolean allowMajorVersionUpgrade,
String databaseName,
InstanceType instanceType,
LicenseModel licenseModel,
IParameterGroup parameterGroup,
String timezone,
IVpc vpc,
Boolean autoMinorVersionUpgrade,
String availabilityZone,
Duration backupRetention,
List<String> cloudwatchLogsExports,
RetentionDays cloudwatchLogsRetention,
IRole cloudwatchLogsRetentionRole,
Boolean copyTagsToSnapshot,
Boolean deleteAutomatedBackups,
Boolean deletionProtection,
String domain,
IRole domainRole,
Boolean enablePerformanceInsights,
Boolean iamAuthentication,
String instanceIdentifier,
Number iops,
Number maxAllocatedStorage,
Duration monitoringInterval,
IRole monitoringRole,
Boolean multiAz,
IOptionGroup optionGroup,
IKey performanceInsightEncryptionKey,
PerformanceInsightRetention performanceInsightRetention,
Number port,
String preferredBackupWindow,
String preferredMaintenanceWindow,
ProcessorFeatures processorFeatures,
Boolean publiclyAccessible,
RemovalPolicy removalPolicy,
List<? extends IBucket> s3ExportBuckets,
IRole s3ExportRole,
List<? extends IBucket> s3ImportBuckets,
IRole s3ImportRole,
List<? extends ISecurityGroup> securityGroups,
StorageType storageType,
ISubnetGroup subnetGroup,
SubnetSelection vpcSubnets)
Constructor that initializes the object based on literal property values passed by the
DatabaseInstanceSourceProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Number |
getAllocatedStorage()
(experimental) The allocated storage size, specified in gigabytes (GB).
|
Boolean |
getAllowMajorVersionUpgrade()
(experimental) Whether to allow major version upgrades.
|
Boolean |
getAutoMinorVersionUpgrade()
(experimental) Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
String |
getAvailabilityZone()
(experimental) The name of the Availability Zone where the DB instance will be located.
|
Duration |
getBackupRetention()
(experimental) The number of days during which automatic DB snapshots are retained.
|
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.
|
Boolean |
getCopyTagsToSnapshot()
(experimental) Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
|
String |
getDatabaseName()
(experimental) The name of the database.
|
Boolean |
getDeleteAutomatedBackups()
(experimental) Indicates whether automated backups should be deleted or retained when you delete a DB instance.
|
Boolean |
getDeletionProtection()
(experimental) Indicates whether the DB instance should have deletion protection enabled.
|
String |
getDomain()
(experimental) The Active Directory directory ID to create the DB instance in.
|
IRole |
getDomainRole()
(experimental) The IAM role to be used when making API calls to the Directory Service.
|
Boolean |
getEnablePerformanceInsights()
(experimental) Whether to enable Performance Insights for the DB instance.
|
IInstanceEngine |
getEngine()
(experimental) The database engine.
|
Boolean |
getIamAuthentication()
(experimental) Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
|
String |
getInstanceIdentifier()
(experimental) A name for the DB instance.
|
InstanceType |
getInstanceType()
(experimental) The name of the compute and memory capacity for the instance.
|
Number |
getIops()
(experimental) The number of I/O operations per second (IOPS) that the database provisions.
|
LicenseModel |
getLicenseModel()
(experimental) The license model.
|
Number |
getMaxAllocatedStorage()
(experimental) Upper limit to which RDS can scale the storage in GiB(Gibibyte).
|
Duration |
getMonitoringInterval()
(experimental) The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
|
IRole |
getMonitoringRole()
(experimental) Role that will be used to manage DB instance monitoring.
|
Boolean |
getMultiAz()
(experimental) Specifies if the database instance is a multiple Availability Zone deployment.
|
IOptionGroup |
getOptionGroup()
(experimental) The option group to associate with the instance.
|
IParameterGroup |
getParameterGroup()
(experimental) The DB parameter group to associate with the instance.
|
IKey |
getPerformanceInsightEncryptionKey()
(experimental) The AWS KMS key for encryption of Performance Insights data.
|
PerformanceInsightRetention |
getPerformanceInsightRetention()
(experimental) The amount of time, in days, to retain Performance Insights data.
|
Number |
getPort()
(experimental) The port for the instance.
|
String |
getPreferredBackupWindow()
(experimental) The daily time range during which automated backups are performed.
|
String |
getPreferredMaintenanceWindow()
(experimental) The weekly time range (in UTC) during which system maintenance can occur.
|
ProcessorFeatures |
getProcessorFeatures()
(experimental) The number of CPU cores and the number of threads per core.
|
Boolean |
getPubliclyAccessible()
(experimental) Indicates whether the DB instance is an internet-facing instance.
|
RemovalPolicy |
getRemovalPolicy()
(experimental) The CloudFormation policy to apply when the instance is 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 instance 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 instance to enable S3 import.
|
List<ISecurityGroup> |
getSecurityGroups()
(experimental) The security groups to assign to the DB instance.
|
StorageType |
getStorageType()
(experimental) The storage type.
|
ISubnetGroup |
getSubnetGroup()
(experimental) Existing subnet group for the instance.
|
String |
getTimezone()
(experimental) The time zone of the instance.
|
IVpc |
getVpc()
(experimental) The VPC network where the DB subnet group should be created.
|
SubnetSelection |
getVpcSubnets()
(experimental) The type of subnets to add to the created DB subnet group.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(IInstanceEngine engine, Number allocatedStorage, Boolean allowMajorVersionUpgrade, String databaseName, InstanceType instanceType, LicenseModel licenseModel, IParameterGroup parameterGroup, String timezone, IVpc vpc, Boolean autoMinorVersionUpgrade, String availabilityZone, Duration backupRetention, List<String> cloudwatchLogsExports, RetentionDays cloudwatchLogsRetention, IRole cloudwatchLogsRetentionRole, Boolean copyTagsToSnapshot, Boolean deleteAutomatedBackups, Boolean deletionProtection, String domain, IRole domainRole, Boolean enablePerformanceInsights, Boolean iamAuthentication, String instanceIdentifier, Number iops, Number maxAllocatedStorage, Duration monitoringInterval, IRole monitoringRole, Boolean multiAz, IOptionGroup optionGroup, IKey performanceInsightEncryptionKey, PerformanceInsightRetention performanceInsightRetention, Number port, String preferredBackupWindow, String preferredMaintenanceWindow, ProcessorFeatures processorFeatures, Boolean publiclyAccessible, RemovalPolicy removalPolicy, List<? extends IBucket> s3ExportBuckets, IRole s3ExportRole, List<? extends IBucket> s3ImportBuckets, IRole s3ImportRole, List<? extends ISecurityGroup> securityGroups, StorageType storageType, ISubnetGroup subnetGroup, SubnetSelection vpcSubnets)
DatabaseInstanceSourceProps.Builder.public final IInstanceEngine getEngine()
DatabaseInstanceSourcePropsgetEngine in interface DatabaseInstanceSourcePropspublic final Number getAllocatedStorage()
DatabaseInstanceSourcePropsDefault: 100
getAllocatedStorage in interface DatabaseInstanceSourcePropspublic final Boolean getAllowMajorVersionUpgrade()
DatabaseInstanceSourcePropsDefault: false
getAllowMajorVersionUpgrade in interface DatabaseInstanceSourcePropspublic final String getDatabaseName()
DatabaseInstanceSourcePropsDefault: - no name
getDatabaseName in interface DatabaseInstanceSourcePropspublic final InstanceType getInstanceType()
DatabaseInstanceSourcePropsDefault: - m5.large (or, more specifically, db.m5.large)
getInstanceType in interface DatabaseInstanceSourcePropspublic final LicenseModel getLicenseModel()
DatabaseInstanceSourcePropsDefault: - RDS default license model
getLicenseModel in interface DatabaseInstanceSourcePropspublic final IParameterGroup getParameterGroup()
DatabaseInstanceSourcePropsDefault: - no parameter group
getParameterGroup in interface DatabaseInstanceSourcePropspublic final String getTimezone()
DatabaseInstanceSourcePropsThis is currently supported only by Microsoft Sql Server.
Default: - RDS default timezone
getTimezone in interface DatabaseInstanceSourcePropspublic final IVpc getVpc()
DatabaseInstanceNewPropsgetVpc in interface DatabaseInstanceNewPropspublic final Boolean getAutoMinorVersionUpgrade()
DatabaseInstanceNewPropsDefault: true
getAutoMinorVersionUpgrade in interface DatabaseInstanceNewPropspublic final String getAvailabilityZone()
DatabaseInstanceNewPropsDefault: - no preference
getAvailabilityZone in interface DatabaseInstanceNewPropspublic final Duration getBackupRetention()
DatabaseInstanceNewPropsSet 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)
getBackupRetention in interface DatabaseInstanceNewPropspublic final List<String> getCloudwatchLogsExports()
DatabaseInstanceNewPropsDefault: - no log exports
getCloudwatchLogsExports in interface DatabaseInstanceNewPropspublic final RetentionDays getCloudwatchLogsRetention()
DatabaseInstanceNewProps
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
getCloudwatchLogsRetention in interface DatabaseInstanceNewPropspublic final IRole getCloudwatchLogsRetentionRole()
DatabaseInstanceNewPropsDefault: - a new role is created.
getCloudwatchLogsRetentionRole in interface DatabaseInstanceNewPropspublic final Boolean getCopyTagsToSnapshot()
DatabaseInstanceNewPropsDefault: true
getCopyTagsToSnapshot in interface DatabaseInstanceNewPropspublic final Boolean getDeleteAutomatedBackups()
DatabaseInstanceNewPropsDefault: false
getDeleteAutomatedBackups in interface DatabaseInstanceNewPropspublic final Boolean getDeletionProtection()
DatabaseInstanceNewPropsDefault: - true if ``removalPolicy`` is RETAIN, false otherwise
getDeletionProtection in interface DatabaseInstanceNewPropspublic final String getDomain()
DatabaseInstanceNewPropsDefault: - Do not join domain
getDomain in interface DatabaseInstanceNewPropspublic final IRole getDomainRole()
DatabaseInstanceNewPropsThe role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent.
Default: - The role will be created for you if DatabaseInstanceNewProps#domain is specified
getDomainRole in interface DatabaseInstanceNewPropspublic final Boolean getEnablePerformanceInsights()
DatabaseInstanceNewPropsDefault: - false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.
getEnablePerformanceInsights in interface DatabaseInstanceNewPropspublic final Boolean getIamAuthentication()
DatabaseInstanceNewPropsDefault: false
getIamAuthentication in interface DatabaseInstanceNewPropspublic final String getInstanceIdentifier()
DatabaseInstanceNewPropsIf you specify a name, AWS CloudFormation converts it to lowercase.
Default: - a CloudFormation generated name
getInstanceIdentifier in interface DatabaseInstanceNewPropspublic final Number getIops()
DatabaseInstanceNewPropsThe value must be equal to or greater than 1000.
Default: - no provisioned iops
getIops in interface DatabaseInstanceNewPropspublic final Number getMaxAllocatedStorage()
DatabaseInstanceNewPropsDefault: - No autoscaling of RDS instance
getMaxAllocatedStorage in interface DatabaseInstanceNewPropshttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscalingpublic final Duration getMonitoringInterval()
DatabaseInstanceNewPropsDefault: - no enhanced monitoring
getMonitoringInterval in interface DatabaseInstanceNewPropspublic final IRole getMonitoringRole()
DatabaseInstanceNewPropsDefault: - A role is automatically created for you
getMonitoringRole in interface DatabaseInstanceNewPropspublic final Boolean getMultiAz()
DatabaseInstanceNewPropsDefault: false
getMultiAz in interface DatabaseInstanceNewPropspublic final IOptionGroup getOptionGroup()
DatabaseInstanceNewPropsDefault: - no option group
getOptionGroup in interface DatabaseInstanceNewPropspublic final IKey getPerformanceInsightEncryptionKey()
DatabaseInstanceNewPropsDefault: - default master key
getPerformanceInsightEncryptionKey in interface DatabaseInstanceNewPropspublic final PerformanceInsightRetention getPerformanceInsightRetention()
DatabaseInstanceNewPropsDefault: 7
getPerformanceInsightRetention in interface DatabaseInstanceNewPropspublic final Number getPort()
DatabaseInstanceNewPropsDefault: - the default port for the chosen engine.
getPort in interface DatabaseInstanceNewPropspublic final String getPreferredBackupWindow()
DatabaseInstanceNewPropsConstraints:
hh24:mi-hh24:mi.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
getPreferredBackupWindow in interface DatabaseInstanceNewPropspublic final String getPreferredMaintenanceWindow()
DatabaseInstanceNewProps
Format: ddd:hh24:mi-ddd:hh24:mi
Constraint: Minimum 30-minute window
Default: - 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
getPreferredMaintenanceWindow in interface DatabaseInstanceNewPropspublic final ProcessorFeatures getProcessorFeatures()
DatabaseInstanceNewPropsDefault: - 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
getProcessorFeatures in interface DatabaseInstanceNewPropspublic final Boolean getPubliclyAccessible()
DatabaseInstanceNewPropsDefault: - `true` if `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise
getPubliclyAccessible in interface DatabaseInstanceNewPropspublic final RemovalPolicy getRemovalPolicy()
DatabaseInstanceNewPropsDefault: - RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)
getRemovalPolicy in interface DatabaseInstanceNewPropspublic final List<IBucket> getS3ExportBuckets()
DatabaseInstanceNewPropsThis feature is only supported by the Microsoft SQL Server and Oracle engines.
This property must not be used if s3ExportRole is used.
For Microsoft SQL Server:
Default: - None
getS3ExportBuckets in interface DatabaseInstanceNewPropshttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.htmlpublic final IRole getS3ExportRole()
DatabaseInstanceNewPropsThis feature is only supported by the Microsoft SQL Server and Oracle engines.
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
getS3ExportRole in interface DatabaseInstanceNewPropshttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.htmlpublic final List<IBucket> getS3ImportBuckets()
DatabaseInstanceNewPropsThis 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
getS3ImportBuckets in interface DatabaseInstanceNewPropshttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.htmlpublic final IRole getS3ImportRole()
DatabaseInstanceNewPropsThis 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
getS3ImportRole in interface DatabaseInstanceNewPropshttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.htmlpublic final List<ISecurityGroup> getSecurityGroups()
DatabaseInstanceNewPropsDefault: - a new security group is created
getSecurityGroups in interface DatabaseInstanceNewPropspublic final StorageType getStorageType()
DatabaseInstanceNewPropsStorage types supported are gp2, io1, standard.
Default: GP2
getStorageType in interface DatabaseInstanceNewPropshttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSDpublic final ISubnetGroup getSubnetGroup()
DatabaseInstanceNewPropsDefault: - a new subnet group will be created.
getSubnetGroup in interface DatabaseInstanceNewPropspublic final SubnetSelection getVpcSubnets()
DatabaseInstanceNewPropsDefault: - private subnets
getVpcSubnets in interface DatabaseInstanceNewProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2021. All rights reserved.