java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:: DatabaseInstanceNewProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: DatabaseInstanceNewProps

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

An implementation for DatabaseInstanceNewProps

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.DatabaseInstanceNewProps
DatabaseInstanceNewProps.Builder, DatabaseInstanceNewProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(DatabaseInstanceNewProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the DatabaseInstanceNewProps.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 Boolean

getAutoMinorVersionUpgrade()

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

final String

getAvailabilityZone()

The name of the Availability Zone where the DB instance will be located.

final Duration

getBackupRetention()

The number of days during which automatic DB snapshots are retained.

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 Boolean

getCopyTagsToSnapshot()

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.

final Boolean

getDeleteAutomatedBackups()

Indicates whether automated backups should be deleted or retained when you delete a DB instance.

final Boolean

getDeletionProtection()

Indicates whether the DB instance should have deletion protection enabled.

final String

getDomain()

The Active Directory directory ID to create the DB instance in.

final IRole

getDomainRole()

The IAM role to be used when making API calls to the Directory Service.

final Boolean

getEnablePerformanceInsights()

Whether to enable Performance Insights for the DB instance.

final Boolean

getIamAuthentication()

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

final String

getInstanceIdentifier()

A name for the DB instance.

final Number

getIops()

The number of I/O operations per second (IOPS) that the database provisions.

final Number

getMaxAllocatedStorage()

Upper limit to which RDS can scale the storage in GiB(Gibibyte).

final Duration

getMonitoringInterval()

The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.

final IRole

getMonitoringRole()

Role that will be used to manage DB instance monitoring.

final Boolean

getMultiAz()

Specifies if the database instance is a multiple Availability Zone deployment.

final IOptionGroup

getOptionGroup()

The option group to associate with the instance.

final IParameterGroup

getParameterGroup()

The DB parameter group to associate with the instance.

final IKey

getPerformanceInsightEncryptionKey()

The AWS KMS key for encryption of Performance Insights data.

final PerformanceInsightRetention

getPerformanceInsightRetention()

The amount of time, in days, to retain Performance Insights data.

final Number

getPort()

The port for the instance.

final String

getPreferredBackupWindow()

The daily time range during which automated backups are performed.

final String

getPreferredMaintenanceWindow()

The weekly time range (in UTC) during which system maintenance can occur.

final ProcessorFeatures

getProcessorFeatures()

The number of CPU cores and the number of threads per core.

final Boolean

getPubliclyAccessible()

Indicates whether the DB instance is an internet-facing instance.

final RemovalPolicy

getRemovalPolicy()

The CloudFormation policy to apply when the instance is 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 instance 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 instance to enable S3 import.

final List<ISecurityGroup>

getSecurityGroups()

The security groups to assign to the DB instance.

final StorageType

getStorageType()

The storage type.

final ISubnetGroup

getSubnetGroup()

Existing subnet group for the instance.

final IVpc

getVpc()

The VPC network where the DB subnet group should be created.

final SubnetSelection

getVpcPlacement()

(deprecated) The type of subnets to add to the created DB subnet group.

final SubnetSelection

getVpcSubnets()

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

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(DatabaseInstanceNewProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the DatabaseInstanceNewProps.Builder.
Method Details
- getVpc
  
  public final IVpc getVpc()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  The VPC network where the DB subnet group should be created.
  
  Specified by:
  
  getVpc in interface DatabaseInstanceNewProps
- getAutoMinorVersionUpgrade
  
  public final Boolean 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 interface DatabaseInstanceNewProps
- getAvailabilityZone
  
  public final String 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 interface DatabaseInstanceNewProps
- getBackupRetention
  
  public final Duration 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 interface DatabaseInstanceNewProps
- getCloudwatchLogsExports
  
  public final List<String> 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 interface DatabaseInstanceNewProps
- getCloudwatchLogsRetention
  
  public final RetentionDays 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 interface DatabaseInstanceNewProps
- getCloudwatchLogsRetentionRole
  
  public final IRole 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 interface DatabaseInstanceNewProps
- getCopyTagsToSnapshot
  
  public final Boolean 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 interface DatabaseInstanceNewProps
- getDeleteAutomatedBackups
  
  public final Boolean getDeleteAutomatedBackups()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  Indicates whether automated backups should be deleted or retained when you delete a DB instance.
  Default: false
  
  Specified by:
  
  getDeleteAutomatedBackups in interface DatabaseInstanceNewProps
- getDeletionProtection
  
  public final Boolean 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 interface DatabaseInstanceNewProps
- getDomain
  
  public final String 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 interface DatabaseInstanceNewProps
- getDomainRole
  
  public final IRole 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
  
  invalid @link
  
  DatabaseInstanceNewProps#domain
  
  is specified
  Specified by:
  
  getDomainRole in interface DatabaseInstanceNewProps
- getEnablePerformanceInsights
  
  public final Boolean getEnablePerformanceInsights()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  Whether to enable Performance Insights for the DB instance.
  Default: - false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.
  
  Specified by:
  
  getEnablePerformanceInsights in interface DatabaseInstanceNewProps
- getIamAuthentication
  
  public final Boolean 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 interface DatabaseInstanceNewProps
- getInstanceIdentifier
  
  public final String 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 interface DatabaseInstanceNewProps
- getIops
  
  public final Number 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
  
  Specified by:
  
  getIops in interface DatabaseInstanceNewProps
- getMaxAllocatedStorage
  
  public final Number 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 interface DatabaseInstanceNewProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
- getMonitoringInterval
  
  public final Duration 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 interface DatabaseInstanceNewProps
- getMonitoringRole
  
  public final IRole 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 interface DatabaseInstanceNewProps
- getMultiAz
  
  public final Boolean getMultiAz()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  Specifies if the database instance is a multiple Availability Zone deployment.
  Default: false
  
  Specified by:
  
  getMultiAz in interface DatabaseInstanceNewProps
- getOptionGroup
  
  public final IOptionGroup getOptionGroup()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  The option group to associate with the instance.
  Default: - no option group
  
  Specified by:
  
  getOptionGroup in interface DatabaseInstanceNewProps
- getParameterGroup
  
  public final IParameterGroup getParameterGroup()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  The DB parameter group to associate with the instance.
  Default: - no parameter group
  
  Specified by:
  
  getParameterGroup in interface DatabaseInstanceNewProps
- getPerformanceInsightEncryptionKey
  
  public final IKey getPerformanceInsightEncryptionKey()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  The AWS KMS key for encryption of Performance Insights data.
  Default: - default master key
  
  Specified by:
  
  getPerformanceInsightEncryptionKey in interface DatabaseInstanceNewProps
- getPerformanceInsightRetention
  
  public final PerformanceInsightRetention getPerformanceInsightRetention()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  The amount of time, in days, to retain Performance Insights data.
  Default: 7
  
  Specified by:
  
  getPerformanceInsightRetention in interface DatabaseInstanceNewProps
- getPort
  
  public final Number getPort()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  The port for the instance.
  Default: - the default port for the chosen engine.
  
  Specified by:
  
  getPort in interface DatabaseInstanceNewProps
- getPreferredBackupWindow
  
  public final String 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 interface DatabaseInstanceNewProps
- getPreferredMaintenanceWindow
  
  public final String 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 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
  
  Specified by:
  
  getPreferredMaintenanceWindow in interface DatabaseInstanceNewProps
- getProcessorFeatures
  
  public final ProcessorFeatures 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 interface DatabaseInstanceNewProps
- getPubliclyAccessible
  
  public final Boolean getPubliclyAccessible()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  Indicates whether the DB instance is an internet-facing instance.
  Default: - `true` if `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise
  
  Specified by:
  
  getPubliclyAccessible in interface DatabaseInstanceNewProps
- getRemovalPolicy
  
  public final RemovalPolicy 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 interface DatabaseInstanceNewProps
- getS3ExportBuckets
  
  public final List<IBucket> 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 interface DatabaseInstanceNewProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
- getS3ExportRole
  
  public final IRole 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 interface DatabaseInstanceNewProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
- getS3ImportBuckets
  
  public final List<IBucket> 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 interface DatabaseInstanceNewProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
- getS3ImportRole
  
  public final IRole 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 interface DatabaseInstanceNewProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
- getSecurityGroups
  
  public final List<ISecurityGroup> 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 interface DatabaseInstanceNewProps
- getStorageType
  
  public final StorageType getStorageType()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  The storage type.
  Storage types supported are gp2, io1, standard.
  Default: GP2
  Specified by:
  
  getStorageType in interface DatabaseInstanceNewProps
  
  See Also:
  
  https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD
- getSubnetGroup
  
  public final ISubnetGroup getSubnetGroup()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  Existing subnet group for the instance.
  Default: - a new subnet group will be created.
  
  Specified by:
  
  getSubnetGroup in interface DatabaseInstanceNewProps
- getVpcPlacement
  
  public final SubnetSelection getVpcPlacement()
  
  Description copied from interface: DatabaseInstanceNewProps
  
  (deprecated) The type of subnets to add to the created DB subnet group.
  Default: - private subnets
  
  Specified by:
  
  getVpcPlacement in interface DatabaseInstanceNewProps
- getVpcSubnets
  
  public final SubnetSelection 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 interface DatabaseInstanceNewProps
- $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

Class DatabaseInstanceNewProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceNewProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getVpc

getAutoMinorVersionUpgrade

getAvailabilityZone

getBackupRetention

getCloudwatchLogsExports

getCloudwatchLogsRetention

getCloudwatchLogsRetentionRole

getCopyTagsToSnapshot

getDeleteAutomatedBackups

getDeletionProtection

getDomain

getDomainRole

getEnablePerformanceInsights

getIamAuthentication

getInstanceIdentifier

getIops

getMaxAllocatedStorage

getMonitoringInterval

getMonitoringRole

getMultiAz

getOptionGroup

getParameterGroup

getPerformanceInsightEncryptionKey

getPerformanceInsightRetention

getPort

getPreferredBackupWindow

getPreferredMaintenanceWindow

getProcessorFeatures

getPubliclyAccessible

getRemovalPolicy

getS3ExportBuckets

getS3ExportRole

getS3ImportBuckets

getS3ImportRole

getSecurityGroups

getStorageType

getSubnetGroup

getVpcPlacement

getVpcSubnets

$jsii$toJson

equals

hashCode