Interface IDatabaseInstanceSourceProps

Construction properties for a DatabaseInstanceSource.

Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public interface IDatabaseInstanceSourceProps : IDatabaseInstanceNewProps
Syntax (vb)
Public Interface IDatabaseInstanceSourceProps
    Inherits IDatabaseInstanceNewProps
Remarks

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.AWS.EC2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.KMS;
using Amazon.CDK.AWS.Logs;
using Amazon.CDK.AWS.RDS;
using Amazon.CDK.AWS.S3;
using Amazon.CDK;

Bucket bucket;
IInstanceEngine instanceEngine;
InstanceType instanceType;
Key key;
OptionGroup optionGroup;
ParameterGroup parameterGroup;
Role role;
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,
    AutoMinorVersionUpgrade = false,
    AvailabilityZone = "availabilityZone",
    BackupRetention = Duration.Minutes(30),
    CloudwatchLogsExports = new [] { "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 = new Dictionary<string, string> {
        { "parametersKey", "parameters" }
    },
    PerformanceInsightEncryptionKey = key,
    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 },
    StorageType = StorageType.STANDARD,
    SubnetGroup = subnetGroup,
    Timezone = "timezone",
    VpcPlacement = new SubnetSelection {
        AvailabilityZones = new [] { "availabilityZones" },
        OnePerAz = false,
        SubnetFilters = new [] { subnetFilter },
        SubnetGroupName = "subnetGroupName",
        SubnetName = "subnetName",
        Subnets = new [] { subnet },
        SubnetType = SubnetType.ISOLATED
    },
    VpcSubnets = new SubnetSelection {
        AvailabilityZones = new [] { "availabilityZones" },
        OnePerAz = false,
        SubnetFilters = new [] { subnetFilter },
        SubnetGroupName = "subnetGroupName",
        SubnetName = "subnetName",
        Subnets = new [] { subnet },
        SubnetType = SubnetType.ISOLATED
    }
};

Synopsis

Properties

AllocatedStorage

The allocated storage size, specified in gigabytes (GB).
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 gigabytes (GB).

virtual Nullable<double> AllocatedStorage { get; }
Property Value

System.Nullable<System.Double>

Remarks

Default: 100

AllowMajorVersionUpgrade

Whether to allow major version upgrades.

virtual Nullable<bool> AllowMajorVersionUpgrade { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

DatabaseName

The name of the database.

virtual string DatabaseName { get; }
Property Value

System.String

Remarks

Default: - no name

Engine

The database engine.

IInstanceEngine Engine { get; }
Property Value

IInstanceEngine

InstanceType

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

virtual InstanceType InstanceType { get; }
Property Value

InstanceType

Remarks

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

LicenseModel

The license model.

virtual Nullable<LicenseModel> LicenseModel { get; }
Property Value

System.Nullable<LicenseModel>

Remarks

Default: - RDS default license model

Parameters

The parameters in the DBParameterGroup to create automatically.

virtual IDictionary<string, string> Parameters { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

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.

virtual string Timezone { get; }
Property Value

System.String

Remarks

This is currently supported only by Microsoft Sql Server.

Default: - RDS default timezone