Interface IDatabaseInstanceSourceProps
Construction properties for a DatabaseInstanceSource.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDatabaseInstanceSourceProps : IDatabaseInstanceNewPropsSyntax (vb)
Public Interface IDatabaseInstanceSourceProps Inherits IDatabaseInstanceNewPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.Logs;
using Amazon.CDK.AWS.RDS;
using Amazon.CDK.AWS.S3;
using Amazon.CDK.Interfaces.IAM;
using Amazon.CDK.Interfaces.KMS;
Bucket bucket;
CaCertificate caCertificate;
IInstanceEngine instanceEngine;
InstanceType instanceType;
IKeyRef keyRef;
OptionGroup optionGroup;
ParameterGroup parameterGroup;
Role role;
IRoleRef roleRef;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
SubnetGroup subnetGroup;
Vpc vpc;
var databaseInstanceSourceProps = new DatabaseInstanceSourceProps {
Engine = instanceEngine,
Vpc = vpc,
// the properties below are optional
AllocatedStorage = 123,
AllowMajorVersionUpgrade = false,
ApplyImmediately = false,
AutoMinorVersionUpgrade = false,
AvailabilityZone = "availabilityZone",
BackupRetention = Duration.Minutes(30),
CaCertificate = caCertificate,
CloudwatchLogsExports = new [] { "cloudwatchLogsExports" },
CloudwatchLogsRetention = RetentionDays.ONE_DAY,
CloudwatchLogsRetentionRole = role,
CopyTagsToSnapshot = false,
DatabaseInsightsMode = DatabaseInsightsMode.STANDARD,
DatabaseName = "databaseName",
DeleteAutomatedBackups = false,
DeletionProtection = false,
Domain = "domain",
DomainRole = roleRef,
EnablePerformanceInsights = false,
EngineLifecycleSupport = EngineLifecycleSupport.OPEN_SOURCE_RDS_EXTENDED_SUPPORT,
IamAuthentication = false,
InstanceIdentifier = "instanceIdentifier",
InstanceType = instanceType,
Iops = 123,
LicenseModel = LicenseModel.LICENSE_INCLUDED,
MaxAllocatedStorage = 123,
MonitoringInterval = Duration.Minutes(30),
MonitoringRole = roleRef,
MultiAz = false,
NetworkType = NetworkType.IPV4,
OptionGroup = optionGroup,
ParameterGroup = parameterGroup,
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
PerformanceInsightEncryptionKey = keyRef,
PerformanceInsightRetention = PerformanceInsightRetention.DEFAULT,
Port = 123,
PreferredBackupWindow = "preferredBackupWindow",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
ProcessorFeatures = new ProcessorFeatures {
CoreCount = 123,
ThreadsPerCore = 123
},
PubliclyAccessible = false,
RemovalPolicy = RemovalPolicy.DESTROY,
S3ExportBuckets = new [] { bucket },
S3ExportRole = role,
S3ImportBuckets = new [] { bucket },
S3ImportRole = role,
SecurityGroups = new [] { securityGroup },
StorageThroughput = 123,
StorageType = StorageType.STANDARD,
SubnetGroup = subnetGroup,
Timezone = "timezone",
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
}
};Synopsis
Properties
| AllocatedStorage | The allocated storage size, specified in gibibytes (GiB). |
| AllowMajorVersionUpgrade | Whether to allow major version upgrades. |
| DatabaseName | The name of the database. |
| Engine | The database engine. |
| InstanceType | The name of the compute and memory capacity for the instance. |
| LicenseModel | The license model. |
| Parameters | The parameters in the DBParameterGroup to create automatically. |
| Timezone | The time zone of the instance. |
Properties
AllocatedStorage
The allocated storage size, specified in gibibytes (GiB).
double? AllocatedStorage { get; }Property Value
Remarks
Default: 100
AllowMajorVersionUpgrade
Whether to allow major version upgrades.
bool? AllowMajorVersionUpgrade { get; }Property Value
bool?
Remarks
Default: false
DatabaseName
The name of the database.
string? DatabaseName { get; }Property Value
Remarks
Default: - no name
Engine
The database engine.
IInstanceEngine Engine { get; }Property Value
Remarks
ExampleMetadata: fixture=_generated
InstanceType
The name of the compute and memory capacity for the instance.
InstanceType? InstanceType { get; }Property Value
Remarks
Default: - m5.large (or, more specifically, db.m5.large)
LicenseModel
The license model.
LicenseModel? LicenseModel { get; }Property Value
Remarks
Default: - RDS default license model
Parameters
The parameters in the DBParameterGroup to create automatically.
IDictionary<string, string>? Parameters { get; }Property Value
Remarks
You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.
Default: - None
Timezone
The time zone of the instance.
string? Timezone { get; }Property Value
Remarks
This is currently supported only by Microsoft Sql Server.
Default: - RDS default timezone