software.amazon.awscdk.services.rds

Interface DatabaseInstanceSourceProps

All Superinterfaces:

DatabaseInstanceNewProps, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DatabaseInstanceFromSnapshotProps, DatabaseInstanceProps

All Known Implementing Classes:

DatabaseInstanceFromSnapshotProps.Jsii$Proxy, DatabaseInstanceProps.Jsii$Proxy, DatabaseInstanceSourceProps.Jsii$Proxy

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

Construction properties for a DatabaseInstanceSource.

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;
 IInstanceEngine instanceEngine;
 InstanceType instanceType;
 Key key;
 OptionGroup optionGroup;
 ParameterGroup parameterGroup;
 Role role;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 SubnetGroup subnetGroup;
 Vpc vpc;
 DatabaseInstanceSourceProps databaseInstanceSourceProps = DatabaseInstanceSourceProps.builder()
         .engine(instanceEngine)
         .vpc(vpc)
         // the properties below are optional
         .allocatedStorage(123)
         .allowMajorVersionUpgrade(false)
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .backupRetention(Duration.minutes(30))
         .cloudwatchLogsExports(List.of("cloudwatchLogsExports"))
         .cloudwatchLogsRetention(RetentionDays.ONE_DAY)
         .cloudwatchLogsRetentionRole(role)
         .copyTagsToSnapshot(false)
         .databaseName("databaseName")
         .deleteAutomatedBackups(false)
         .deletionProtection(false)
         .domain("domain")
         .domainRole(role)
         .enablePerformanceInsights(false)
         .iamAuthentication(false)
         .instanceIdentifier("instanceIdentifier")
         .instanceType(instanceType)
         .iops(123)
         .licenseModel(LicenseModel.LICENSE_INCLUDED)
         .maxAllocatedStorage(123)
         .monitoringInterval(Duration.minutes(30))
         .monitoringRole(role)
         .multiAz(false)
         .optionGroup(optionGroup)
         .parameterGroup(parameterGroup)
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .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)
         .timezone("timezone")
         .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	DatabaseInstanceSourceProps.Builder A builder for DatabaseInstanceSourceProps
static class	DatabaseInstanceSourceProps.Jsii$Proxy An implementation for DatabaseInstanceSourceProps

Method Summary

Modifier and Type	Method and Description
static DatabaseInstanceSourceProps.Builder	builder()
default Number	getAllocatedStorage() The allocated storage size, specified in gibibytes (GiB).
default Boolean	getAllowMajorVersionUpgrade() Whether to allow major version upgrades.
default String	getDatabaseName() The name of the database.
IInstanceEngine	getEngine() The database engine.
default InstanceType	getInstanceType() The name of the compute and memory capacity for the instance.
default LicenseModel	getLicenseModel() The license model.
default Map<String,String>	getParameters() The parameters in the DBParameterGroup to create automatically.
default String	getTimezone() The time zone of the instance.

Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceNewProps

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, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEngine

@Stability(value=Stable)
 @NotNull
IInstanceEngine getEngine()

The database engine.

getAllocatedStorage

@Stability(value=Stable)
 @Nullable
default Number getAllocatedStorage()

The allocated storage size, specified in gibibytes (GiB).

Default: 100

getAllowMajorVersionUpgrade

@Stability(value=Stable)
 @Nullable
default Boolean getAllowMajorVersionUpgrade()

Whether to allow major version upgrades.

Default: false

getDatabaseName

@Stability(value=Stable)
 @Nullable
default String getDatabaseName()

The name of the database.

Default: - no name

getInstanceType

@Stability(value=Stable)
 @Nullable
default InstanceType getInstanceType()

The name of the compute and memory capacity for the instance.

Default: - m5.large (or, more specifically, db.m5.large)

getLicenseModel

@Stability(value=Stable)
 @Nullable
default LicenseModel getLicenseModel()

The license model.

Default: - RDS default license model

getParameters

@Stability(value=Stable)
 @Nullable
default Map<String,String> getParameters()

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

getTimezone

@Stability(value=Stable)
 @Nullable
default String getTimezone()

The time zone of the instance.

This is currently supported only by Microsoft Sql Server.

Default: - RDS default timezone

builder

@Stability(value=Stable)
static DatabaseInstanceSourceProps.Builder builder()

Specified by:

builder in interface DatabaseInstanceNewProps

Returns:

a DatabaseInstanceSourceProps.Builder of DatabaseInstanceSourceProps