DatabaseInstanceNewProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:: DatabaseInstanceFromSnapshotProps, DatabaseInstanceProps, DatabaseInstanceReadReplicaProps, DatabaseInstanceSourceProps

All Known Implementing Classes:: DatabaseInstanceFromSnapshotProps.Jsii$Proxy, DatabaseInstanceNewProps.Jsii$Proxy, DatabaseInstanceProps.Jsii$Proxy, DatabaseInstanceReadReplicaProps.Jsii$Proxy, DatabaseInstanceSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.459Z")
 @Stability(value=Stable)
public interface DatabaseInstanceNewProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for a DatabaseInstanceNew.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.rds.*;
 import software.amazon.awscdk.services.s3.*;
 Bucket bucket;
 Key key;
 OptionGroup optionGroup;
 ParameterGroup parameterGroup;
 Role role;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 SubnetGroup subnetGroup;
 Vpc vpc;
 DatabaseInstanceNewProps databaseInstanceNewProps = DatabaseInstanceNewProps.builder()
         .vpc(vpc)
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .backupRetention(Duration.minutes(30))
         .cloudwatchLogsExports(List.of("cloudwatchLogsExports"))
         .cloudwatchLogsRetention(RetentionDays.ONE_DAY)
         .cloudwatchLogsRetentionRole(role)
         .copyTagsToSnapshot(false)
         .deleteAutomatedBackups(false)
         .deletionProtection(false)
         .domain("domain")
         .domainRole(role)
         .enablePerformanceInsights(false)
         .iamAuthentication(false)
         .instanceIdentifier("instanceIdentifier")
         .iops(123)
         .maxAllocatedStorage(123)
         .monitoringInterval(Duration.minutes(30))
         .monitoringRole(role)
         .multiAz(false)
         .optionGroup(optionGroup)
         .parameterGroup(parameterGroup)
         .performanceInsightEncryptionKey(key)
         .performanceInsightRetention(PerformanceInsightRetention.DEFAULT)
         .port(123)
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .processorFeatures(ProcessorFeatures.builder()
                 .coreCount(123)
                 .threadsPerCore(123)
                 .build())
         .publiclyAccessible(false)
         .removalPolicy(RemovalPolicy.DESTROY)
         .s3ExportBuckets(List.of(bucket))
         .s3ExportRole(role)
         .s3ImportBuckets(List.of(bucket))
         .s3ImportRole(role)
         .securityGroups(List.of(securityGroup))
         .storageType(StorageType.STANDARD)
         .subnetGroup(subnetGroup)
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DatabaseInstanceNewProps.Builder` A builder for `DatabaseInstanceNewProps`
`static class`	`DatabaseInstanceNewProps.Jsii$Proxy` An implementation for `DatabaseInstanceNewProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static DatabaseInstanceNewProps.Builder`	`builder()`
`default Boolean`	`getAutoMinorVersionUpgrade()` Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
`default String`	`getAvailabilityZone()` The name of the Availability Zone where the DB instance will be located.
`default Duration`	`getBackupRetention()` The number of days during which automatic DB snapshots are retained.
`default List<String>`	`getCloudwatchLogsExports()` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`default RetentionDays`	`getCloudwatchLogsRetention()` The number of days log events are kept in CloudWatch Logs.
`default IRole`	`getCloudwatchLogsRetentionRole()` The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
`default Boolean`	`getCopyTagsToSnapshot()` Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
`default Boolean`	`getDeleteAutomatedBackups()` Indicates whether automated backups should be deleted or retained when you delete a DB instance.
`default Boolean`	`getDeletionProtection()` Indicates whether the DB instance should have deletion protection enabled.
`default String`	`getDomain()` The Active Directory directory ID to create the DB instance in.
`default IRole`	`getDomainRole()` The IAM role to be used when making API calls to the Directory Service.
`default Boolean`	`getEnablePerformanceInsights()` Whether to enable Performance Insights for the DB instance.
`default Boolean`	`getIamAuthentication()` Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`default String`	`getInstanceIdentifier()` A name for the DB instance.
`default Number`	`getIops()` The number of I/O operations per second (IOPS) that the database provisions.
`default Number`	`getMaxAllocatedStorage()` Upper limit to which RDS can scale the storage in GiB(Gibibyte).
`default Duration`	`getMonitoringInterval()` The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
`default IRole`	`getMonitoringRole()` Role that will be used to manage DB instance monitoring.
`default Boolean`	`getMultiAz()` Specifies if the database instance is a multiple Availability Zone deployment.
`default IOptionGroup`	`getOptionGroup()` The option group to associate with the instance.
`default IParameterGroup`	`getParameterGroup()` The DB parameter group to associate with the instance.
`default IKey`	`getPerformanceInsightEncryptionKey()` The AWS KMS key for encryption of Performance Insights data.
`default PerformanceInsightRetention`	`getPerformanceInsightRetention()` The amount of time, in days, to retain Performance Insights data.
`default Number`	`getPort()` The port for the instance.
`default String`	`getPreferredBackupWindow()` The daily time range during which automated backups are performed.
`default String`	`getPreferredMaintenanceWindow()` The weekly time range (in UTC) during which system maintenance can occur.
`default ProcessorFeatures`	`getProcessorFeatures()` The number of CPU cores and the number of threads per core.
`default Boolean`	`getPubliclyAccessible()` Indicates whether the DB instance is an internet-facing instance.
`default RemovalPolicy`	`getRemovalPolicy()` The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
`default List<IBucket>`	`getS3ExportBuckets()` S3 buckets that you want to load data into.
`default IRole`	`getS3ExportRole()` Role that will be associated with this DB instance to enable S3 export.
`default List<IBucket>`	`getS3ImportBuckets()` S3 buckets that you want to load data from.
`default IRole`	`getS3ImportRole()` Role that will be associated with this DB instance to enable S3 import.
`default List<ISecurityGroup>`	`getSecurityGroups()` The security groups to assign to the DB instance.
`default StorageType`	`getStorageType()` The storage type.
`default ISubnetGroup`	`getSubnetGroup()` Existing subnet group for the instance.
`IVpc`	`getVpc()` The VPC network where the DB subnet group should be created.
`default SubnetSelection`	`getVpcSubnets()` The type of subnets to add to the created DB subnet group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getVpc
```
@Stability(value=Stable)
 @NotNull
IVpc getVpc()
```
    The VPC network where the DB subnet group should be created.
  - getAutoMinorVersionUpgrade
```
@Stability(value=Stable)
 @Nullable
default Boolean getAutoMinorVersionUpgrade()
```
    Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
    Default: true
  - getAvailabilityZone
```
@Stability(value=Stable)
 @Nullable
default String getAvailabilityZone()
```
    The name of the Availability Zone where the DB instance will be located.
    Default: - no preference
  - getBackupRetention
```
@Stability(value=Stable)
 @Nullable
default Duration getBackupRetention()
```
    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
  - getCloudwatchLogsExports
```
@Stability(value=Stable)
 @Nullable
default List<String> getCloudwatchLogsExports()
```
    The list of log types that need to be enabled for exporting to CloudWatch Logs.
    Default: - no log exports
  - getCloudwatchLogsRetention
```
@Stability(value=Stable)
 @Nullable
default RetentionDays getCloudwatchLogsRetention()
```
    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=Stable)
 @Nullable
default IRole getCloudwatchLogsRetentionRole()
```
    The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
    Default: - a new role is created.
  - getCopyTagsToSnapshot
```
@Stability(value=Stable)
 @Nullable
default Boolean getCopyTagsToSnapshot()
```
    Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
    Default: true
  - getDeleteAutomatedBackups
```
@Stability(value=Stable)
 @Nullable
default Boolean getDeleteAutomatedBackups()
```
    Indicates whether automated backups should be deleted or retained when you delete a DB instance.
    Default: false
  - getDeletionProtection
```
@Stability(value=Stable)
 @Nullable
default Boolean getDeletionProtection()
```
    Indicates whether the DB instance should have deletion protection enabled.
    Default: - true if ``removalPolicy`` is RETAIN, false otherwise
  - getDomain
```
@Stability(value=Stable)
 @Nullable
default String getDomain()
```
    The Active Directory directory ID to create the DB instance in.
    Default: - Do not join domain
  - getDomainRole
```
@Stability(value=Stable)
 @Nullable
default IRole getDomainRole()
```
    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
  - getEnablePerformanceInsights
```
@Stability(value=Stable)
 @Nullable
default Boolean getEnablePerformanceInsights()
```
    Whether to enable Performance Insights for the DB instance.
    Default: - false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.
  - getIamAuthentication
```
@Stability(value=Stable)
 @Nullable
default Boolean getIamAuthentication()
```
    Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
    Default: false
  - getInstanceIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getInstanceIdentifier()
```
    A name for the DB instance.
    If you specify a name, AWS CloudFormation converts it to lowercase.
    Default: - a CloudFormation generated name
  - getIops
```
@Stability(value=Stable)
 @Nullable
default Number getIops()
```
    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
  - getMaxAllocatedStorage
```
@Stability(value=Stable)
 @Nullable
default Number getMaxAllocatedStorage()
```
    Upper limit to which RDS can scale the storage in GiB(Gibibyte).
    Default: - No autoscaling of RDS instance
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
  - getMonitoringInterval
```
@Stability(value=Stable)
 @Nullable
default Duration getMonitoringInterval()
```
    The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
    Default: - no enhanced monitoring
  - getMonitoringRole
```
@Stability(value=Stable)
 @Nullable
default IRole getMonitoringRole()
```
    Role that will be used to manage DB instance monitoring.
    Default: - A role is automatically created for you
  - getMultiAz
```
@Stability(value=Stable)
 @Nullable
default Boolean getMultiAz()
```
    Specifies if the database instance is a multiple Availability Zone deployment.
    Default: false
  - getOptionGroup
```
@Stability(value=Stable)
 @Nullable
default IOptionGroup getOptionGroup()
```
    The option group to associate with the instance.
    Default: - no option group
  - getParameterGroup
```
@Stability(value=Stable)
 @Nullable
default IParameterGroup getParameterGroup()
```
    The DB parameter group to associate with the instance.
    Default: - no parameter group
  - getPerformanceInsightEncryptionKey
```
@Stability(value=Stable)
 @Nullable
default IKey getPerformanceInsightEncryptionKey()
```
    The AWS KMS key for encryption of Performance Insights data.
    Default: - default master key
  - getPerformanceInsightRetention
```
@Stability(value=Stable)
 @Nullable
default PerformanceInsightRetention getPerformanceInsightRetention()
```
    The amount of time, in days, to retain Performance Insights data.
    Default: 7
  - getPort
```
@Stability(value=Stable)
 @Nullable
default Number getPort()
```
    The port for the instance.
    Default: - the default port for the chosen engine.
  - getPreferredBackupWindow
```
@Stability(value=Stable)
 @Nullable
default String getPreferredBackupWindow()
```
    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
  - getPreferredMaintenanceWindow
```
@Stability(value=Stable)
 @Nullable
default String getPreferredMaintenanceWindow()
```
    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
  - getProcessorFeatures
```
@Stability(value=Stable)
 @Nullable
default ProcessorFeatures getProcessorFeatures()
```
    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
  - getPubliclyAccessible
```
@Stability(value=Stable)
 @Nullable
default Boolean getPubliclyAccessible()
```
    Indicates whether the DB instance is an internet-facing instance.
    Default: - `true` if `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise
  - getRemovalPolicy
```
@Stability(value=Stable)
 @Nullable
default RemovalPolicy getRemovalPolicy()
```
    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)
  - getS3ExportBuckets
```
@Stability(value=Stable)
 @Nullable
default List<IBucket> getS3ExportBuckets()
```
    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
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
  - getS3ExportRole
```
@Stability(value=Stable)
 @Nullable
default IRole getS3ExportRole()
```
    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
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
  - getS3ImportBuckets
```
@Stability(value=Stable)
 @Nullable
default List<IBucket> getS3ImportBuckets()
```
    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
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
  - getS3ImportRole
```
@Stability(value=Stable)
 @Nullable
default IRole getS3ImportRole()
```
    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
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
  - getSecurityGroups
```
@Stability(value=Stable)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()
```
    The security groups to assign to the DB instance.
    Default: - a new security group is created
  - getStorageType
```
@Stability(value=Stable)
 @Nullable
default StorageType getStorageType()
```
    The storage type.
    Storage types supported are gp2, io1, standard.
    Default: GP2
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD
  - getSubnetGroup
```
@Stability(value=Stable)
 @Nullable
default ISubnetGroup getSubnetGroup()
```
    Existing subnet group for the instance.
    Default: - a new subnet group will be created.
  - getVpcSubnets
```
@Stability(value=Stable)
 @Nullable
default SubnetSelection getVpcSubnets()
```
    The type of subnets to add to the created DB subnet group.
    Default: - private subnets
  - builder
```
@Stability(value=Stable)
static DatabaseInstanceNewProps.Builder builder()
```
    Returns:
    
    a DatabaseInstanceNewProps.Builder of DatabaseInstanceNewProps

Interface DatabaseInstanceNewProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

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

getVpcSubnets

builder