This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-rds

AWS RDS Construct Library

The aws-cdk-rds package contains Constructs for setting up RDS instances.

Supported:

  • Clustered databases

Not supported:

  • Instance databases
  • Setting up from a snapshot

Starting a Clustered Database

To set up a clustered database (like Aurora), create an instance of DatabaseCluster. You must always launch a database in a VPC. Use the vpcPlacement attribute to control whether your instances will be launched privately or publicly:

const cluster = new DatabaseCluster(this, 'Database', {
    engine: DatabaseClusterEngine.Aurora,
    masterUser: {
        username: 'admin',
        password: '7959866cacc02c2d243ecfe177464fe6',
    },
    instanceProps: {
        instanceType: new InstanceTypePair(InstanceClass.Burstable2, InstanceSize.Small),
        vpcPlacement: {
            subnetsToUse: ec2.SubnetType.Public,
        },
        vpc
    }
});

Your cluster will be empty by default. To add a default database upon construction, specify the defaultDatabaseName attribute.

Connecting

To control who can access the cluster, use the .connections attribute. RDS database have a default port, so you don’t need to specify the port:

cluster.connections.allowFromAnyIpv4('Open to the world');

The endpoints to access your database will be available as the .clusterEndpoint and .readerEndpoint attributes:

const writeAddress = cluster.clusterEndpoint.socketAddress;   // "HOSTNAME:PORT"

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.RDS" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.RDS --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.RDS" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:rds:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="rds" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>rds</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:rds:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='rds', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-rds@0.25.3

package.json:

{
  "@aws-cdk/aws-rds": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-rds@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-rds@0.25.3

package.json:

{
  "@aws-cdk/aws-rds": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-rds@0.25.3

BackupProps (interface)

class @aws-cdk/aws-rds.BackupProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.BackupProps;
// BackupProps is an interface
import { BackupProps } from '@aws-cdk/aws-rds';

Backup configuration for RDS databases

retentionDays

How many days to retain the backup

Type:number
preferredWindow

A daily time range in 24-hours UTC format in which backups preferably execute.

Must be at least 30 minutes long.

Example: ‘01:00-02:00’

Type:string (optional)

CfnDBCluster

class @aws-cdk/aws-rds.CfnDBCluster(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBCluster;
const { CfnDBCluster } = require('@aws-cdk/aws-rds');
import { CfnDBCluster } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dbClusterEndpointAddress
Type:string (readonly)
dbClusterEndpointPort
Type:string (readonly)
dbClusterName
Type:string (readonly)
dbClusterReadEndpointAddress
Type:string (readonly)
propertyOverrides
Type:CfnDBClusterProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class ScalingConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBCluster.ScalingConfigurationProperty;
// CfnDBCluster.ScalingConfigurationProperty is an interface
import { CfnDBCluster.ScalingConfigurationProperty } from '@aws-cdk/aws-rds';
autoPause

CfnDBCluster.ScalingConfigurationProperty.AutoPause

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause

Type:boolean or @aws-cdk/cdk.Token (optional)
maxCapacity

CfnDBCluster.ScalingConfigurationProperty.MaxCapacity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity

Type:number or @aws-cdk/cdk.Token (optional)
minCapacity

CfnDBCluster.ScalingConfigurationProperty.MinCapacity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity

Type:number or @aws-cdk/cdk.Token (optional)
secondsUntilAutoPause

CfnDBCluster.ScalingConfigurationProperty.SecondsUntilAutoPause

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause

Type:number or @aws-cdk/cdk.Token (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDBClusterParameterGroup

class @aws-cdk/aws-rds.CfnDBClusterParameterGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBClusterParameterGroup;
const { CfnDBClusterParameterGroup } = require('@aws-cdk/aws-rds');
import { CfnDBClusterParameterGroup } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dbClusterParameterGroupName
Type:string (readonly)
propertyOverrides
Type:CfnDBClusterParameterGroupProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDBClusterParameterGroupProps (interface)

class @aws-cdk/aws-rds.CfnDBClusterParameterGroupProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBClusterParameterGroupProps;
// CfnDBClusterParameterGroupProps is an interface
import { CfnDBClusterParameterGroupProps } from '@aws-cdk/aws-rds';
description

AWS::RDS::DBClusterParameterGroup.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description

Type:string
family

AWS::RDS::DBClusterParameterGroup.Family

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family

Type:string
parameters

AWS::RDS::DBClusterParameterGroup.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-parameters

Type:json or @aws-cdk/cdk.Token
tags

AWS::RDS::DBClusterParameterGroup.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnDBClusterProps (interface)

class @aws-cdk/aws-rds.CfnDBClusterProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBClusterProps;
// CfnDBClusterProps is an interface
import { CfnDBClusterProps } from '@aws-cdk/aws-rds';
engine

AWS::RDS::DBCluster.Engine

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine

Type:string
availabilityZones

AWS::RDS::DBCluster.AvailabilityZones

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
backtrackWindow

AWS::RDS::DBCluster.BacktrackWindow

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow

Type:number or @aws-cdk/cdk.Token (optional)
backupRetentionPeriod

AWS::RDS::DBCluster.BackupRetentionPeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backuprententionperiod

Type:number or @aws-cdk/cdk.Token (optional)
databaseName

AWS::RDS::DBCluster.DatabaseName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename

Type:string (optional)
dbClusterIdentifier

AWS::RDS::DBCluster.DBClusterIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier

Type:string (optional)
dbClusterParameterGroupName

AWS::RDS::DBCluster.DBClusterParameterGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname

Type:string (optional)
dbSubnetGroupName

AWS::RDS::DBCluster.DBSubnetGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname

Type:string (optional)
deletionProtection

AWS::RDS::DBCluster.DeletionProtection

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection

Type:boolean or @aws-cdk/cdk.Token (optional)
enableCloudwatchLogsExports

AWS::RDS::DBCluster.EnableCloudwatchLogsExports

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
enableIamDatabaseAuthentication

AWS::RDS::DBCluster.EnableIAMDatabaseAuthentication

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication

Type:boolean or @aws-cdk/cdk.Token (optional)
engineMode

AWS::RDS::DBCluster.EngineMode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode

Type:string (optional)
engineVersion

AWS::RDS::DBCluster.EngineVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion

Type:string (optional)
kmsKeyId

AWS::RDS::DBCluster.KmsKeyId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid

Type:string (optional)
masterUsername

AWS::RDS::DBCluster.MasterUsername

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername

Type:string (optional)
masterUserPassword

AWS::RDS::DBCluster.MasterUserPassword

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword

Type:string (optional)
port

AWS::RDS::DBCluster.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port

Type:number or @aws-cdk/cdk.Token (optional)
preferredBackupWindow

AWS::RDS::DBCluster.PreferredBackupWindow

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow

Type:string (optional)
preferredMaintenanceWindow

AWS::RDS::DBCluster.PreferredMaintenanceWindow

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow

Type:string (optional)
replicationSourceIdentifier

AWS::RDS::DBCluster.ReplicationSourceIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier

Type:string (optional)
scalingConfiguration

AWS::RDS::DBCluster.ScalingConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration

Type:@aws-cdk/cdk.Token or ScalingConfigurationProperty (optional)
snapshotIdentifier

AWS::RDS::DBCluster.SnapshotIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier

Type:string (optional)
sourceRegion

AWS::RDS::DBCluster.SourceRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion

Type:string (optional)
storageEncrypted

AWS::RDS::DBCluster.StorageEncrypted

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted

Type:boolean or @aws-cdk/cdk.Token (optional)
tags

AWS::RDS::DBCluster.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
vpcSecurityGroupIds

AWS::RDS::DBCluster.VpcSecurityGroupIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)

CfnDBInstance

class @aws-cdk/aws-rds.CfnDBInstance(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBInstance;
const { CfnDBInstance } = require('@aws-cdk/aws-rds');
import { CfnDBInstance } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dbInstanceEndpointAddress
Type:string (readonly)
dbInstanceEndpointPort
Type:string (readonly)
dbInstanceId
Type:string (readonly)
propertyOverrides
Type:CfnDBInstanceProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class ProcessorFeatureProperty

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBInstance.ProcessorFeatureProperty;
// CfnDBInstance.ProcessorFeatureProperty is an interface
import { CfnDBInstance.ProcessorFeatureProperty } from '@aws-cdk/aws-rds';
name

CfnDBInstance.ProcessorFeatureProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-name

Type:string (optional)
value

CfnDBInstance.ProcessorFeatureProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-value

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDBInstanceProps (interface)

class @aws-cdk/aws-rds.CfnDBInstanceProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBInstanceProps;
// CfnDBInstanceProps is an interface
import { CfnDBInstanceProps } from '@aws-cdk/aws-rds';
dbInstanceClass

AWS::RDS::DBInstance.DBInstanceClass

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceclass

Type:string
allocatedStorage

AWS::RDS::DBInstance.AllocatedStorage

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allocatedstorage

Type:string (optional)
allowMajorVersionUpgrade

AWS::RDS::DBInstance.AllowMajorVersionUpgrade

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allowmajorversionupgrade

Type:boolean or @aws-cdk/cdk.Token (optional)
autoMinorVersionUpgrade

AWS::RDS::DBInstance.AutoMinorVersionUpgrade

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-autominorversionupgrade

Type:boolean or @aws-cdk/cdk.Token (optional)
availabilityZone

AWS::RDS::DBInstance.AvailabilityZone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-availabilityzone

Type:string (optional)
backupRetentionPeriod

AWS::RDS::DBInstance.BackupRetentionPeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-backupretentionperiod

Type:string (optional)
characterSetName

AWS::RDS::DBInstance.CharacterSetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-charactersetname

Type:string (optional)
copyTagsToSnapshot

AWS::RDS::DBInstance.CopyTagsToSnapshot

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-copytagstosnapshot

Type:boolean or @aws-cdk/cdk.Token (optional)
dbClusterIdentifier

AWS::RDS::DBInstance.DBClusterIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbclusteridentifier

Type:string (optional)
dbInstanceIdentifier

AWS::RDS::DBInstance.DBInstanceIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceidentifier

Type:string (optional)
dbName

AWS::RDS::DBInstance.DBName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbname

Type:string (optional)
dbParameterGroupName

AWS::RDS::DBInstance.DBParameterGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbparametergroupname

Type:string (optional)
dbSecurityGroups

AWS::RDS::DBInstance.DBSecurityGroups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
dbSnapshotIdentifier

AWS::RDS::DBInstance.DBSnapshotIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier

Type:string (optional)
dbSubnetGroupName

AWS::RDS::DBInstance.DBSubnetGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsubnetgroupname

Type:string (optional)
deleteAutomatedBackups

AWS::RDS::DBInstance.DeleteAutomatedBackups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deleteautomatedbackups

Type:boolean or @aws-cdk/cdk.Token (optional)
deletionProtection

AWS::RDS::DBInstance.DeletionProtection

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deletionprotection

Type:boolean or @aws-cdk/cdk.Token (optional)
domain

AWS::RDS::DBInstance.Domain

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domain

Type:string (optional)
domainIamRoleName

AWS::RDS::DBInstance.DomainIAMRoleName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domainiamrolename

Type:string (optional)
enableCloudwatchLogsExports

AWS::RDS::DBInstance.EnableCloudwatchLogsExports

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
enableIamDatabaseAuthentication

AWS::RDS::DBInstance.EnableIAMDatabaseAuthentication

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication

Type:boolean or @aws-cdk/cdk.Token (optional)
enablePerformanceInsights

AWS::RDS::DBInstance.EnablePerformanceInsights

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights

Type:boolean or @aws-cdk/cdk.Token (optional)
engine

AWS::RDS::DBInstance.Engine

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engine

Type:string (optional)
engineVersion

AWS::RDS::DBInstance.EngineVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion

Type:string (optional)
iops

AWS::RDS::DBInstance.Iops

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-iops

Type:number or @aws-cdk/cdk.Token (optional)
kmsKeyId

AWS::RDS::DBInstance.KmsKeyId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-kmskeyid

Type:string (optional)
licenseModel

AWS::RDS::DBInstance.LicenseModel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-licensemodel

Type:string (optional)
masterUsername

AWS::RDS::DBInstance.MasterUsername

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masterusername

Type:string (optional)
masterUserPassword

AWS::RDS::DBInstance.MasterUserPassword

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masteruserpassword

Type:string (optional)
monitoringInterval

AWS::RDS::DBInstance.MonitoringInterval

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringinterval

Type:number or @aws-cdk/cdk.Token (optional)
monitoringRoleArn

AWS::RDS::DBInstance.MonitoringRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringrolearn

Type:string (optional)
multiAz

AWS::RDS::DBInstance.MultiAZ

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-multiaz

Type:boolean or @aws-cdk/cdk.Token (optional)
optionGroupName

AWS::RDS::DBInstance.OptionGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-optiongroupname

Type:string (optional)
performanceInsightsKmsKeyId

AWS::RDS::DBInstance.PerformanceInsightsKMSKeyId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightskmskeyid

Type:string (optional)
performanceInsightsRetentionPeriod

AWS::RDS::DBInstance.PerformanceInsightsRetentionPeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod

Type:number or @aws-cdk/cdk.Token (optional)
port

AWS::RDS::DBInstance.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port

Type:string (optional)
preferredBackupWindow

AWS::RDS::DBInstance.PreferredBackupWindow

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredbackupwindow

Type:string (optional)
preferredMaintenanceWindow

AWS::RDS::DBInstance.PreferredMaintenanceWindow

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredmaintenancewindow

Type:string (optional)
processorFeatures

AWS::RDS::DBInstance.ProcessorFeatures

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-processorfeatures

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ProcessorFeatureProperty)[] (optional)
promotionTier

AWS::RDS::DBInstance.PromotionTier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-promotiontier

Type:number or @aws-cdk/cdk.Token (optional)
publiclyAccessible

AWS::RDS::DBInstance.PubliclyAccessible

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-publiclyaccessible

Type:boolean or @aws-cdk/cdk.Token (optional)
sourceDbInstanceIdentifier

AWS::RDS::DBInstance.SourceDBInstanceIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier

Type:string (optional)
sourceRegion

AWS::RDS::DBInstance.SourceRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourceregion

Type:string (optional)
storageEncrypted

AWS::RDS::DBInstance.StorageEncrypted

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storageencrypted

Type:boolean or @aws-cdk/cdk.Token (optional)
storageType

AWS::RDS::DBInstance.StorageType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storagetype

Type:string (optional)
tags

AWS::RDS::DBInstance.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
timezone

AWS::RDS::DBInstance.Timezone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-timezone

Type:string (optional)
useDefaultProcessorFeatures

AWS::RDS::DBInstance.UseDefaultProcessorFeatures

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures

Type:boolean or @aws-cdk/cdk.Token (optional)
vpcSecurityGroups

AWS::RDS::DBInstance.VPCSecurityGroups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-vpcsecuritygroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)

CfnDBParameterGroup

class @aws-cdk/aws-rds.CfnDBParameterGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBParameterGroup;
const { CfnDBParameterGroup } = require('@aws-cdk/aws-rds');
import { CfnDBParameterGroup } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dbParameterGroupName
Type:string (readonly)
propertyOverrides
Type:CfnDBParameterGroupProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDBParameterGroupProps (interface)

class @aws-cdk/aws-rds.CfnDBParameterGroupProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBParameterGroupProps;
// CfnDBParameterGroupProps is an interface
import { CfnDBParameterGroupProps } from '@aws-cdk/aws-rds';
description

AWS::RDS::DBParameterGroup.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description

Type:string
family

AWS::RDS::DBParameterGroup.Family

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family

Type:string
parameters

AWS::RDS::DBParameterGroup.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
tags

AWS::RDS::DBParameterGroup.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnDBSecurityGroup

class @aws-cdk/aws-rds.CfnDBSecurityGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBSecurityGroup;
const { CfnDBSecurityGroup } = require('@aws-cdk/aws-rds');
import { CfnDBSecurityGroup } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dbSecurityGroupName
Type:string (readonly)
propertyOverrides
Type:CfnDBSecurityGroupProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class IngressProperty

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBSecurityGroup.IngressProperty;
// CfnDBSecurityGroup.IngressProperty is an interface
import { CfnDBSecurityGroup.IngressProperty } from '@aws-cdk/aws-rds';
cidrip

CfnDBSecurityGroup.IngressProperty.CIDRIP

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-cidrip

Type:string (optional)
ec2SecurityGroupId

CfnDBSecurityGroup.IngressProperty.EC2SecurityGroupId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupid

Type:string (optional)
ec2SecurityGroupName

CfnDBSecurityGroup.IngressProperty.EC2SecurityGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupname

Type:string (optional)
ec2SecurityGroupOwnerId

CfnDBSecurityGroup.IngressProperty.EC2SecurityGroupOwnerId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupownerid

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDBSecurityGroupIngress

class @aws-cdk/aws-rds.CfnDBSecurityGroupIngress(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBSecurityGroupIngress;
const { CfnDBSecurityGroupIngress } = require('@aws-cdk/aws-rds');
import { CfnDBSecurityGroupIngress } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dbSecurityGroupIngressName
Type:string (readonly)
propertyOverrides
Type:CfnDBSecurityGroupIngressProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDBSecurityGroupIngressProps (interface)

class @aws-cdk/aws-rds.CfnDBSecurityGroupIngressProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBSecurityGroupIngressProps;
// CfnDBSecurityGroupIngressProps is an interface
import { CfnDBSecurityGroupIngressProps } from '@aws-cdk/aws-rds';
dbSecurityGroupName

AWS::RDS::DBSecurityGroupIngress.DBSecurityGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-dbsecuritygroupname

Type:string
cidrip

AWS::RDS::DBSecurityGroupIngress.CIDRIP

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-cidrip

Type:string (optional)
ec2SecurityGroupId

AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupid

Type:string (optional)
ec2SecurityGroupName

AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupname

Type:string (optional)
ec2SecurityGroupOwnerId

AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupOwnerId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupownerid

Type:string (optional)

CfnDBSecurityGroupProps (interface)

class @aws-cdk/aws-rds.CfnDBSecurityGroupProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBSecurityGroupProps;
// CfnDBSecurityGroupProps is an interface
import { CfnDBSecurityGroupProps } from '@aws-cdk/aws-rds';
dbSecurityGroupIngress

AWS::RDS::DBSecurityGroup.DBSecurityGroupIngress

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-dbsecuritygroupingress

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or IngressProperty)[]
groupDescription

AWS::RDS::DBSecurityGroup.GroupDescription

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-groupdescription

Type:string
ec2VpcId

AWS::RDS::DBSecurityGroup.EC2VpcId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-ec2vpcid

Type:string (optional)
tags

AWS::RDS::DBSecurityGroup.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnDBSubnetGroup

class @aws-cdk/aws-rds.CfnDBSubnetGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBSubnetGroup;
const { CfnDBSubnetGroup } = require('@aws-cdk/aws-rds');
import { CfnDBSubnetGroup } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dbSubnetGroupName
Type:string (readonly)
propertyOverrides
Type:CfnDBSubnetGroupProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDBSubnetGroupProps (interface)

class @aws-cdk/aws-rds.CfnDBSubnetGroupProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnDBSubnetGroupProps;
// CfnDBSubnetGroupProps is an interface
import { CfnDBSubnetGroupProps } from '@aws-cdk/aws-rds';
dbSubnetGroupDescription

AWS::RDS::DBSubnetGroup.DBSubnetGroupDescription

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription

Type:string
subnetIds

AWS::RDS::DBSubnetGroup.SubnetIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-subnetids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
dbSubnetGroupName

AWS::RDS::DBSubnetGroup.DBSubnetGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname

Type:string (optional)
tags

AWS::RDS::DBSubnetGroup.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnEventSubscription

class @aws-cdk/aws-rds.CfnEventSubscription(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnEventSubscription;
const { CfnEventSubscription } = require('@aws-cdk/aws-rds');
import { CfnEventSubscription } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
eventSubscriptionName
Type:string (readonly)
propertyOverrides
Type:CfnEventSubscriptionProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnEventSubscriptionProps (interface)

class @aws-cdk/aws-rds.CfnEventSubscriptionProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnEventSubscriptionProps;
// CfnEventSubscriptionProps is an interface
import { CfnEventSubscriptionProps } from '@aws-cdk/aws-rds';
snsTopicArn

AWS::RDS::EventSubscription.SnsTopicArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-snstopicarn

Type:string
enabled

AWS::RDS::EventSubscription.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
eventCategories

AWS::RDS::EventSubscription.EventCategories

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
sourceIds

AWS::RDS::EventSubscription.SourceIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
sourceType

AWS::RDS::EventSubscription.SourceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype

Type:string (optional)

CfnOptionGroup

class @aws-cdk/aws-rds.CfnOptionGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnOptionGroup;
const { CfnOptionGroup } = require('@aws-cdk/aws-rds');
import { CfnOptionGroup } from '@aws-cdk/aws-rds';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
optionGroupName
Type:string (readonly)
propertyOverrides
Type:CfnOptionGroupProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class OptionConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnOptionGroup.OptionConfigurationProperty;
// CfnOptionGroup.OptionConfigurationProperty is an interface
import { CfnOptionGroup.OptionConfigurationProperty } from '@aws-cdk/aws-rds';
optionName

CfnOptionGroup.OptionConfigurationProperty.OptionName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-optionname

Type:string
dbSecurityGroupMemberships

CfnOptionGroup.OptionConfigurationProperty.DBSecurityGroupMemberships

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-dbsecuritygroupmemberships

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
optionSettings

CfnOptionGroup.OptionConfigurationProperty.OptionSettings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-optionsettings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or OptionSettingProperty)[] (optional)
optionVersion

CfnOptionGroup.OptionConfigurationProperty.OptionVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfiguration-optionversion

Type:string (optional)
port

CfnOptionGroup.OptionConfigurationProperty.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-port

Type:number or @aws-cdk/cdk.Token (optional)
vpcSecurityGroupMemberships

CfnOptionGroup.OptionConfigurationProperty.VpcSecurityGroupMemberships

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-vpcsecuritygroupmemberships

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class OptionSettingProperty

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnOptionGroup.OptionSettingProperty;
// CfnOptionGroup.OptionSettingProperty is an interface
import { CfnOptionGroup.OptionSettingProperty } from '@aws-cdk/aws-rds';
name

CfnOptionGroup.OptionSettingProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html#cfn-rds-optiongroup-optionconfigurations-optionsettings-name

Type:string (optional)
value

CfnOptionGroup.OptionSettingProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html#cfn-rds-optiongroup-optionconfigurations-optionsettings-value

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnOptionGroupProps (interface)

class @aws-cdk/aws-rds.CfnOptionGroupProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.CfnOptionGroupProps;
// CfnOptionGroupProps is an interface
import { CfnOptionGroupProps } from '@aws-cdk/aws-rds';
engineName

AWS::RDS::OptionGroup.EngineName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename

Type:string
majorEngineVersion

AWS::RDS::OptionGroup.MajorEngineVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion

Type:string
optionConfigurations

AWS::RDS::OptionGroup.OptionConfigurations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or OptionConfigurationProperty)[]
optionGroupDescription

AWS::RDS::OptionGroup.OptionGroupDescription

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription

Type:string
tags

AWS::RDS::OptionGroup.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

ClusterParameterGroup

class @aws-cdk/aws-rds.ClusterParameterGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.ClusterParameterGroup;
const { ClusterParameterGroup } = require('@aws-cdk/aws-rds');
import { ClusterParameterGroup } from '@aws-cdk/aws-rds';

Defina a cluster parameter group

Extends:

@aws-cdk/cdk.Construct

Implements:

IClusterParameterGroup

Parameters:
static import(scope, id, props) → @aws-cdk/aws-rds.IClusterParameterGroup

Import a parameter group

Parameters:
Return type:

IClusterParameterGroup

export() → @aws-cdk/aws-rds.ClusterParameterGroupImportProps

Implements @aws-cdk/aws-rds.IClusterParameterGroup.export()

Export this parameter group

Return type:ClusterParameterGroupImportProps
removeParameter(key)

Remove a previously-set parameter from this parameter group

Parameters:key (string) –
setParameter(key[, value])

Set a single parameter in this parameter group

Parameters:
  • key (string) –
  • value (string (optional)) –
validate() → string[]

Overrides @aws-cdk/cdk.Construct.validate()

Validate this construct

Protected method

Return type:string[]
parameterGroupName

Implements @aws-cdk/aws-rds.IClusterParameterGroup.parameterGroupName()

Name of this parameter group

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ClusterParameterGroupImportProps (interface)

class @aws-cdk/aws-rds.ClusterParameterGroupImportProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.ClusterParameterGroupImportProps;
// ClusterParameterGroupImportProps is an interface
import { ClusterParameterGroupImportProps } from '@aws-cdk/aws-rds';

Properties to reference a cluster parameter group

parameterGroupName
Type:string

ClusterParameterGroupProps (interface)

class @aws-cdk/aws-rds.ClusterParameterGroupProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.ClusterParameterGroupProps;
// ClusterParameterGroupProps is an interface
import { ClusterParameterGroupProps } from '@aws-cdk/aws-rds';

Properties for a cluster parameter group

description

Description for this parameter group

Type:string
family

Database family of this parameter group

Type:string
parameters

The parameters in this parameter group

Type:string => any (optional)

DatabaseCluster

class @aws-cdk/aws-rds.DatabaseCluster(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.DatabaseCluster;
const { DatabaseCluster } = require('@aws-cdk/aws-rds');
import { DatabaseCluster } from '@aws-cdk/aws-rds';

Create a clustered database with a given number of instances.

Extends:

@aws-cdk/cdk.Construct

Implements:

IDatabaseCluster

Parameters:
static import(scope, id, props) → @aws-cdk/aws-rds.IDatabaseCluster

Import an existing DatabaseCluster from properties

Parameters:
Return type:

IDatabaseCluster

export() → @aws-cdk/aws-rds.DatabaseClusterImportProps

Implements @aws-cdk/aws-rds.IDatabaseCluster.export()

Export a Database Cluster for importing in another stack

Return type:DatabaseClusterImportProps
clusterEndpoint

Implements @aws-cdk/aws-rds.IDatabaseCluster.clusterEndpoint()

The endpoint to use for read/write operations

Type:Endpoint (readonly)
clusterIdentifier

Implements @aws-cdk/aws-rds.IDatabaseCluster.clusterIdentifier()

Identifier of the cluster

Type:string (readonly)
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Access to the network connections

Type:@aws-cdk/aws-ec2.Connections (readonly)
instanceEndpoints

Implements @aws-cdk/aws-rds.IDatabaseCluster.instanceEndpoints()

Endpoints which address each individual replica.

Type:Endpoint[] (readonly)
instanceIdentifiers

Implements @aws-cdk/aws-rds.IDatabaseCluster.instanceIdentifiers()

Identifiers of the replicas

Type:string[] (readonly)
readerEndpoint

Implements @aws-cdk/aws-rds.IDatabaseCluster.readerEndpoint()

Endpoint to use for load-balanced read-only operations.

Type:Endpoint (readonly)
securityGroupId

Implements @aws-cdk/aws-rds.IDatabaseCluster.securityGroupId()

Security group identifier of this database

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

DatabaseClusterEngine (enum)

class @aws-cdk/aws-rds.DatabaseClusterEngine

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.DatabaseClusterEngine;
const { DatabaseClusterEngine } = require('@aws-cdk/aws-rds');
import { DatabaseClusterEngine } from '@aws-cdk/aws-rds';

The engine for the database cluster

Aurora
AuroraMysql
AuroraPostgresql
Neptune

DatabaseClusterImportProps (interface)

class @aws-cdk/aws-rds.DatabaseClusterImportProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.DatabaseClusterImportProps;
// DatabaseClusterImportProps is an interface
import { DatabaseClusterImportProps } from '@aws-cdk/aws-rds';

Properties that describe an existing cluster instance

clusterEndpointAddress

Cluster endpoint address

Type:string
clusterIdentifier

Identifier for the cluster

Type:string
instanceEndpointAddresses

Endpoint addresses of individual instances

Type:string[]
instanceIdentifiers

Identifier for the instances

Type:string[]
port

The database port

Type:string
readerEndpointAddress

Reader endpoint address

Type:string
securityGroupId

The security group for this database cluster

Type:string

DatabaseClusterProps (interface)

class @aws-cdk/aws-rds.DatabaseClusterProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.DatabaseClusterProps;
// DatabaseClusterProps is an interface
import { DatabaseClusterProps } from '@aws-cdk/aws-rds';

Properties for a new database cluster

engine

What kind of database to start

Type:DatabaseClusterEngine
instanceProps

Settings for the individual instances that are launched

Type:InstanceProps
masterUser

Username and password for the administrative user

Type:Login
backup

Backup settings

Type:BackupProps (optional)
clusterIdentifier

An optional identifier for the cluster

If not supplied, a name is automatically generated.

Type:string (optional)
defaultDatabaseName

Name of a database which is automatically created inside the cluster

Type:string (optional)
instanceIdentifierBase

Base identifier for instances

Every replica is named by appending the replica number to this string, 1-based.

If not given, the clusterIdentifier is used with the word “Instance” appended.

If clusterIdentifier is also not given, the identifier is automatically generated.

Type:string (optional)
instances

How many replicas/instances to create

Has to be at least 1.

Type:number (optional)
Default:2
kmsKeyArn

ARN of KMS key if you want to enable storage encryption

Type:string (optional)
parameterGroup

Additional parameters to pass to the database engine

Type:IClusterParameterGroup (optional)
Default:No parameter group
port

What port to listen on

If not supplied, the default for the engine is used.

Type:number (optional)
preferredMaintenanceWindow

A daily time range in 24-hours UTC format in which backups preferably execute.

Must be at least 30 minutes long.

Example: ‘01:00-02:00’

Type:string (optional)

DatabaseInstance

class @aws-cdk/aws-rds.DatabaseInstance(scope, id)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.DatabaseInstance;
const { DatabaseInstance } = require('@aws-cdk/aws-rds');
import { DatabaseInstance } from '@aws-cdk/aws-rds';

Create a database instance

This can be a standalone database instance, or part of a cluster.

Extends:

@aws-cdk/cdk.Construct

Parameters:
  • scope (@aws-cdk/cdk.Construct) – The scope in which to define this construct
  • id (string) – The scoped construct ID. Must be unique amongst siblings. If the ID includes a path separator (/), then it will be replaced by double dash .
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

Endpoint

class @aws-cdk/aws-rds.Endpoint(address, port)

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.Endpoint;
const { Endpoint } = require('@aws-cdk/aws-rds');
import { Endpoint } from '@aws-cdk/aws-rds';

Connection endpoint of a database cluster or instance

Consists of a combination of hostname and port.

Parameters:
  • address (string) –
  • port (string) –
hostname

The hostname of the endpoint

Type:string (readonly)
port

The port of the endpoint

Type:string (readonly)
socketAddress

The combination of “HOSTNAME:PORT” for this endpoint

Type:string (readonly)

IClusterParameterGroup (interface)

class @aws-cdk/aws-rds.IClusterParameterGroup

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.IClusterParameterGroup;
// IClusterParameterGroup is an interface
import { IClusterParameterGroup } from '@aws-cdk/aws-rds';

A cluster parameter group

Extends:@aws-cdk/cdk.IConstruct
parameterGroupName

Name of this parameter group

Type:string (readonly)
export() → @aws-cdk/aws-rds.ClusterParameterGroupImportProps

Export this parameter group

Return type:ClusterParameterGroupImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IDatabaseCluster (interface)

class @aws-cdk/aws-rds.IDatabaseCluster

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.IDatabaseCluster;
// IDatabaseCluster is an interface
import { IDatabaseCluster } from '@aws-cdk/aws-rds';

Create a clustered database with a given number of instances.

Extends:@aws-cdk/cdk.IConstruct
Extends:@aws-cdk/aws-ec2.IConnectable
clusterEndpoint

The endpoint to use for read/write operations

Type:Endpoint (readonly)
clusterIdentifier

Identifier of the cluster

Type:string (readonly)
instanceEndpoints

Endpoints which address each individual replica.

Type:Endpoint[] (readonly)
instanceIdentifiers

Identifiers of the replicas

Type:string[] (readonly)
readerEndpoint

Endpoint to use for load-balanced read-only operations.

Type:Endpoint (readonly)
securityGroupId

The security group for this database cluster

Type:string (readonly)
export() → @aws-cdk/aws-rds.DatabaseClusterImportProps

Export a Database Cluster for importing in another stack

Return type:DatabaseClusterImportProps
Abstract:Yes
connections

Inherited from @aws-cdk/aws-ec2.IConnectable

Type:@aws-cdk/aws-ec2.Connections (readonly)
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

InstanceProps (interface)

class @aws-cdk/aws-rds.InstanceProps

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.InstanceProps;
// InstanceProps is an interface
import { InstanceProps } from '@aws-cdk/aws-rds';

Instance properties for database instances

instanceType

What type of instance to start for the replicas

Type:@aws-cdk/aws-ec2.InstanceType
vpc

What subnets to run the RDS instances in.

Must be at least 2 subnets in two different AZs.

Type:@aws-cdk/aws-ec2.IVpcNetwork
vpcPlacement

Where to place the instances within the VPC

Type:@aws-cdk/aws-ec2.VpcPlacementStrategy (optional)

Login (interface)

class @aws-cdk/aws-rds.Login

Language-specific names:

using Amazon.CDK.AWS.RDS;
import software.amazon.awscdk.services.rds.Login;
// Login is an interface
import { Login } from '@aws-cdk/aws-rds';

Username and password combination

password

Password

Do not put passwords in your CDK code directly. Import it from a Stack

Parameter or the SSM Parameter Store instead.

Type:string
username

Username

Type:string