awsrds

package
v2.0.0-rc.32 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2021 License: Apache-2.0 Imports: 14 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnDBClusterParameterGroup_CFN_RESOURCE_TYPE_NAME

func CfnDBClusterParameterGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBClusterParameterGroup_IsCfnElement

func CfnDBClusterParameterGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBClusterParameterGroup_IsCfnResource

func CfnDBClusterParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBClusterParameterGroup_IsConstruct

func CfnDBClusterParameterGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBCluster_CFN_RESOURCE_TYPE_NAME

func CfnDBCluster_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBCluster_IsCfnElement

func CfnDBCluster_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBCluster_IsCfnResource

func CfnDBCluster_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBCluster_IsConstruct

func CfnDBCluster_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBInstance_CFN_RESOURCE_TYPE_NAME

func CfnDBInstance_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBInstance_IsCfnElement

func CfnDBInstance_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBInstance_IsCfnResource

func CfnDBInstance_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBInstance_IsConstruct

func CfnDBInstance_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBParameterGroup_CFN_RESOURCE_TYPE_NAME

func CfnDBParameterGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBParameterGroup_IsCfnElement

func CfnDBParameterGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBParameterGroup_IsCfnResource

func CfnDBParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBParameterGroup_IsConstruct

func CfnDBParameterGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBProxyEndpoint_CFN_RESOURCE_TYPE_NAME

func CfnDBProxyEndpoint_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBProxyEndpoint_IsCfnElement

func CfnDBProxyEndpoint_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBProxyEndpoint_IsCfnResource

func CfnDBProxyEndpoint_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBProxyEndpoint_IsConstruct

func CfnDBProxyEndpoint_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBProxyTargetGroup_CFN_RESOURCE_TYPE_NAME

func CfnDBProxyTargetGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBProxyTargetGroup_IsCfnElement

func CfnDBProxyTargetGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBProxyTargetGroup_IsCfnResource

func CfnDBProxyTargetGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBProxyTargetGroup_IsConstruct

func CfnDBProxyTargetGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBProxy_CFN_RESOURCE_TYPE_NAME

func CfnDBProxy_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBProxy_IsCfnElement

func CfnDBProxy_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBProxy_IsCfnResource

func CfnDBProxy_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBProxy_IsConstruct

func CfnDBProxy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME

func CfnDBSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBSecurityGroupIngress_IsCfnElement

func CfnDBSecurityGroupIngress_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBSecurityGroupIngress_IsCfnResource

func CfnDBSecurityGroupIngress_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBSecurityGroupIngress_IsConstruct

func CfnDBSecurityGroupIngress_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBSecurityGroup_CFN_RESOURCE_TYPE_NAME

func CfnDBSecurityGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBSecurityGroup_IsCfnElement

func CfnDBSecurityGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBSecurityGroup_IsCfnResource

func CfnDBSecurityGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBSecurityGroup_IsConstruct

func CfnDBSecurityGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDBSubnetGroup_CFN_RESOURCE_TYPE_NAME

func CfnDBSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnDBSubnetGroup_IsCfnElement

func CfnDBSubnetGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDBSubnetGroup_IsCfnResource

func CfnDBSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDBSubnetGroup_IsConstruct

func CfnDBSubnetGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEventSubscription_CFN_RESOURCE_TYPE_NAME

func CfnEventSubscription_CFN_RESOURCE_TYPE_NAME() *string

func CfnEventSubscription_IsCfnElement

func CfnEventSubscription_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnEventSubscription_IsCfnResource

func CfnEventSubscription_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnEventSubscription_IsConstruct

func CfnEventSubscription_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnGlobalCluster_CFN_RESOURCE_TYPE_NAME

func CfnGlobalCluster_CFN_RESOURCE_TYPE_NAME() *string

func CfnGlobalCluster_IsCfnElement

func CfnGlobalCluster_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnGlobalCluster_IsCfnResource

func CfnGlobalCluster_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnGlobalCluster_IsConstruct

func CfnGlobalCluster_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnOptionGroup_CFN_RESOURCE_TYPE_NAME

func CfnOptionGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnOptionGroup_IsCfnElement

func CfnOptionGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnOptionGroup_IsCfnResource

func CfnOptionGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnOptionGroup_IsConstruct

func CfnOptionGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseClusterBase_IsConstruct

func DatabaseClusterBase_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseClusterBase_IsResource

func DatabaseClusterBase_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseClusterFromSnapshot_IsConstruct

func DatabaseClusterFromSnapshot_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseClusterFromSnapshot_IsResource

func DatabaseClusterFromSnapshot_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseCluster_IsConstruct

func DatabaseCluster_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseCluster_IsResource

func DatabaseCluster_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseInstanceBase_IsConstruct

func DatabaseInstanceBase_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseInstanceBase_IsResource

func DatabaseInstanceBase_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseInstanceFromSnapshot_IsConstruct

func DatabaseInstanceFromSnapshot_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseInstanceFromSnapshot_IsResource

func DatabaseInstanceFromSnapshot_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseInstanceReadReplica_IsConstruct

func DatabaseInstanceReadReplica_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseInstanceReadReplica_IsResource

func DatabaseInstanceReadReplica_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseInstance_IsConstruct

func DatabaseInstance_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseInstance_IsResource

func DatabaseInstance_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseProxy_IsConstruct

func DatabaseProxy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseProxy_IsResource

func DatabaseProxy_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseSecret_FromSecretAttributes

func DatabaseSecret_FromSecretAttributes(scope constructs.Construct, id *string, attrs *awssecretsmanager.SecretAttributes) awssecretsmanager.ISecret

Import an existing secret into the Stack. Experimental.

func DatabaseSecret_FromSecretCompleteArn

func DatabaseSecret_FromSecretCompleteArn(scope constructs.Construct, id *string, secretCompleteArn *string) awssecretsmanager.ISecret

Imports a secret by complete ARN.

The complete ARN is the ARN with the Secrets Manager-supplied suffix. Experimental.

func DatabaseSecret_FromSecretNameV2

func DatabaseSecret_FromSecretNameV2(scope constructs.Construct, id *string, secretName *string) awssecretsmanager.ISecret

Imports a secret by secret name.

A secret with this name must exist in the same account & region. Replaces the deprecated `fromSecretName`. Experimental.

func DatabaseSecret_FromSecretPartialArn

func DatabaseSecret_FromSecretPartialArn(scope constructs.Construct, id *string, secretPartialArn *string) awssecretsmanager.ISecret

Imports a secret by partial ARN.

The partial ARN is the ARN without the Secrets Manager-supplied suffix. Experimental.

func DatabaseSecret_IsConstruct

func DatabaseSecret_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DatabaseSecret_IsResource

func DatabaseSecret_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewCfnDBClusterParameterGroup_Override

func NewCfnDBClusterParameterGroup_Override(c CfnDBClusterParameterGroup, scope constructs.Construct, id *string, props *CfnDBClusterParameterGroupProps)

Create a new `AWS::RDS::DBClusterParameterGroup`.

func NewCfnDBCluster_Override

func NewCfnDBCluster_Override(c CfnDBCluster, scope constructs.Construct, id *string, props *CfnDBClusterProps)

Create a new `AWS::RDS::DBCluster`.

func NewCfnDBInstance_Override

func NewCfnDBInstance_Override(c CfnDBInstance, scope constructs.Construct, id *string, props *CfnDBInstanceProps)

Create a new `AWS::RDS::DBInstance`.

func NewCfnDBParameterGroup_Override

func NewCfnDBParameterGroup_Override(c CfnDBParameterGroup, scope constructs.Construct, id *string, props *CfnDBParameterGroupProps)

Create a new `AWS::RDS::DBParameterGroup`.

func NewCfnDBProxyEndpoint_Override

func NewCfnDBProxyEndpoint_Override(c CfnDBProxyEndpoint, scope constructs.Construct, id *string, props *CfnDBProxyEndpointProps)

Create a new `AWS::RDS::DBProxyEndpoint`.

func NewCfnDBProxyTargetGroup_Override

func NewCfnDBProxyTargetGroup_Override(c CfnDBProxyTargetGroup, scope constructs.Construct, id *string, props *CfnDBProxyTargetGroupProps)

Create a new `AWS::RDS::DBProxyTargetGroup`.

func NewCfnDBProxy_Override

func NewCfnDBProxy_Override(c CfnDBProxy, scope constructs.Construct, id *string, props *CfnDBProxyProps)

Create a new `AWS::RDS::DBProxy`.

func NewCfnDBSecurityGroupIngress_Override

func NewCfnDBSecurityGroupIngress_Override(c CfnDBSecurityGroupIngress, scope constructs.Construct, id *string, props *CfnDBSecurityGroupIngressProps)

Create a new `AWS::RDS::DBSecurityGroupIngress`.

func NewCfnDBSecurityGroup_Override

func NewCfnDBSecurityGroup_Override(c CfnDBSecurityGroup, scope constructs.Construct, id *string, props *CfnDBSecurityGroupProps)

Create a new `AWS::RDS::DBSecurityGroup`.

func NewCfnDBSubnetGroup_Override

func NewCfnDBSubnetGroup_Override(c CfnDBSubnetGroup, scope constructs.Construct, id *string, props *CfnDBSubnetGroupProps)

Create a new `AWS::RDS::DBSubnetGroup`.

func NewCfnEventSubscription_Override

func NewCfnEventSubscription_Override(c CfnEventSubscription, scope constructs.Construct, id *string, props *CfnEventSubscriptionProps)

Create a new `AWS::RDS::EventSubscription`.

func NewCfnGlobalCluster_Override

func NewCfnGlobalCluster_Override(c CfnGlobalCluster, scope constructs.Construct, id *string, props *CfnGlobalClusterProps)

Create a new `AWS::RDS::GlobalCluster`.

func NewCfnOptionGroup_Override

func NewCfnOptionGroup_Override(c CfnOptionGroup, scope constructs.Construct, id *string, props *CfnOptionGroupProps)

Create a new `AWS::RDS::OptionGroup`.

func NewCredentials_Override

func NewCredentials_Override(c Credentials)

Experimental.

func NewDatabaseClusterBase_Override

func NewDatabaseClusterBase_Override(d DatabaseClusterBase, scope constructs.Construct, id *string, props *awscdk.ResourceProps)

Experimental.

func NewDatabaseClusterEngine_Override

func NewDatabaseClusterEngine_Override(d DatabaseClusterEngine)

Experimental.

func NewDatabaseClusterFromSnapshot_Override

func NewDatabaseClusterFromSnapshot_Override(d DatabaseClusterFromSnapshot, scope constructs.Construct, id *string, props *DatabaseClusterFromSnapshotProps)

Experimental.

func NewDatabaseCluster_Override

func NewDatabaseCluster_Override(d DatabaseCluster, scope constructs.Construct, id *string, props *DatabaseClusterProps)

Experimental.

func NewDatabaseInstanceBase_Override

func NewDatabaseInstanceBase_Override(d DatabaseInstanceBase, scope constructs.Construct, id *string, props *awscdk.ResourceProps)

Experimental.

func NewDatabaseInstanceEngine_Override

func NewDatabaseInstanceEngine_Override(d DatabaseInstanceEngine)

Experimental.

func NewDatabaseInstanceFromSnapshot_Override

func NewDatabaseInstanceFromSnapshot_Override(d DatabaseInstanceFromSnapshot, scope constructs.Construct, id *string, props *DatabaseInstanceFromSnapshotProps)

Experimental.

func NewDatabaseInstanceReadReplica_Override

func NewDatabaseInstanceReadReplica_Override(d DatabaseInstanceReadReplica, scope constructs.Construct, id *string, props *DatabaseInstanceReadReplicaProps)

Experimental.

func NewDatabaseInstance_Override

func NewDatabaseInstance_Override(d DatabaseInstance, scope constructs.Construct, id *string, props *DatabaseInstanceProps)

Experimental.

func NewDatabaseProxy_Override

func NewDatabaseProxy_Override(d DatabaseProxy, scope constructs.Construct, id *string, props *DatabaseProxyProps)

Experimental.

func NewDatabaseSecret_Override

func NewDatabaseSecret_Override(d DatabaseSecret, scope constructs.Construct, id *string, props *DatabaseSecretProps)

Experimental.

func NewEndpoint_Override

func NewEndpoint_Override(e Endpoint, address *string, port *float64)

Experimental.

func NewOptionGroup_Override

func NewOptionGroup_Override(o OptionGroup, scope constructs.Construct, id *string, props *OptionGroupProps)

Experimental.

func NewParameterGroup_Override

func NewParameterGroup_Override(p ParameterGroup, scope constructs.Construct, id *string, props *ParameterGroupProps)

Experimental.

func NewServerlessCluster_Override

func NewServerlessCluster_Override(s ServerlessCluster, scope constructs.Construct, id *string, props *ServerlessClusterProps)

Experimental.

func NewSnapshotCredentials_Override

func NewSnapshotCredentials_Override(s SnapshotCredentials)

Experimental.

func NewSubnetGroup_Override

func NewSubnetGroup_Override(s SubnetGroup, scope constructs.Construct, id *string, props *SubnetGroupProps)

Experimental.

func OptionGroup_IsConstruct

func OptionGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func OptionGroup_IsResource

func OptionGroup_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func ParameterGroup_IsConstruct

func ParameterGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func ParameterGroup_IsResource

func ParameterGroup_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func ServerlessCluster_IsConstruct

func ServerlessCluster_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func ServerlessCluster_IsResource

func ServerlessCluster_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func SubnetGroup_IsConstruct

func SubnetGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func SubnetGroup_IsResource

func SubnetGroup_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type AuroraCapacityUnit

type AuroraCapacityUnit string

Aurora capacity units (ACUs).

Each ACU is a combination of processing and memory capacity.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.architecture

Experimental.

const (
	AuroraCapacityUnit_ACU_1   AuroraCapacityUnit = "ACU_1"
	AuroraCapacityUnit_ACU_2   AuroraCapacityUnit = "ACU_2"
	AuroraCapacityUnit_ACU_4   AuroraCapacityUnit = "ACU_4"
	AuroraCapacityUnit_ACU_8   AuroraCapacityUnit = "ACU_8"
	AuroraCapacityUnit_ACU_16  AuroraCapacityUnit = "ACU_16"
	AuroraCapacityUnit_ACU_32  AuroraCapacityUnit = "ACU_32"
	AuroraCapacityUnit_ACU_64  AuroraCapacityUnit = "ACU_64"
	AuroraCapacityUnit_ACU_128 AuroraCapacityUnit = "ACU_128"
	AuroraCapacityUnit_ACU_192 AuroraCapacityUnit = "ACU_192"
	AuroraCapacityUnit_ACU_256 AuroraCapacityUnit = "ACU_256"
	AuroraCapacityUnit_ACU_384 AuroraCapacityUnit = "ACU_384"
)

type AuroraClusterEngineProps

type AuroraClusterEngineProps struct {
	// The version of the Aurora cluster engine.
	// Experimental.
	Version AuroraEngineVersion `json:"version"`
}

Creation properties of the plain Aurora database cluster engine.

Used in {@link DatabaseClusterEngine.aurora}.

TODO: EXAMPLE

Experimental.

type AuroraEngineVersion

type AuroraEngineVersion interface {
	AuroraFullVersion() *string
	AuroraMajorVersion() *string
}

The versions for the Aurora cluster engine (those returned by {@link DatabaseClusterEngine.aurora}).

TODO: EXAMPLE

Experimental.

func AuroraEngineVersion_Of

func AuroraEngineVersion_Of(auroraFullVersion *string, auroraMajorVersion *string) AuroraEngineVersion

Create a new AuroraEngineVersion with an arbitrary version. Experimental.

func AuroraEngineVersion_VER_10A

func AuroraEngineVersion_VER_10A() AuroraEngineVersion

func AuroraEngineVersion_VER_1_17_9

func AuroraEngineVersion_VER_1_17_9() AuroraEngineVersion

func AuroraEngineVersion_VER_1_19_0

func AuroraEngineVersion_VER_1_19_0() AuroraEngineVersion

func AuroraEngineVersion_VER_1_19_1

func AuroraEngineVersion_VER_1_19_1() AuroraEngineVersion

func AuroraEngineVersion_VER_1_19_2

func AuroraEngineVersion_VER_1_19_2() AuroraEngineVersion

func AuroraEngineVersion_VER_1_19_5

func AuroraEngineVersion_VER_1_19_5() AuroraEngineVersion

func AuroraEngineVersion_VER_1_19_6

func AuroraEngineVersion_VER_1_19_6() AuroraEngineVersion

func AuroraEngineVersion_VER_1_20_0

func AuroraEngineVersion_VER_1_20_0() AuroraEngineVersion

func AuroraEngineVersion_VER_1_20_1

func AuroraEngineVersion_VER_1_20_1() AuroraEngineVersion

func AuroraEngineVersion_VER_1_21_0

func AuroraEngineVersion_VER_1_21_0() AuroraEngineVersion

func AuroraEngineVersion_VER_1_22_0

func AuroraEngineVersion_VER_1_22_0() AuroraEngineVersion

func AuroraEngineVersion_VER_1_22_1

func AuroraEngineVersion_VER_1_22_1() AuroraEngineVersion

func AuroraEngineVersion_VER_1_22_1_3

func AuroraEngineVersion_VER_1_22_1_3() AuroraEngineVersion

func AuroraEngineVersion_VER_1_22_2

func AuroraEngineVersion_VER_1_22_2() AuroraEngineVersion

type AuroraMysqlClusterEngineProps

type AuroraMysqlClusterEngineProps struct {
	// The version of the Aurora MySQL cluster engine.
	// Experimental.
	Version AuroraMysqlEngineVersion `json:"version"`
}

Creation properties of the Aurora MySQL database cluster engine.

Used in {@link DatabaseClusterEngine.auroraMysql}.

TODO: EXAMPLE

Experimental.

type AuroraMysqlEngineVersion

type AuroraMysqlEngineVersion interface {
	AuroraMysqlFullVersion() *string
	AuroraMysqlMajorVersion() *string
}

The versions for the Aurora MySQL cluster engine (those returned by {@link DatabaseClusterEngine.auroraMysql}).

TODO: EXAMPLE

Experimental.

func AuroraMysqlEngineVersion_Of

func AuroraMysqlEngineVersion_Of(auroraMysqlFullVersion *string, auroraMysqlMajorVersion *string) AuroraMysqlEngineVersion

Create a new AuroraMysqlEngineVersion with an arbitrary version. Experimental.

func AuroraMysqlEngineVersion_VER_2_03_2

func AuroraMysqlEngineVersion_VER_2_03_2() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_03_3

func AuroraMysqlEngineVersion_VER_2_03_3() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_03_4

func AuroraMysqlEngineVersion_VER_2_03_4() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_0

func AuroraMysqlEngineVersion_VER_2_04_0() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_1

func AuroraMysqlEngineVersion_VER_2_04_1() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_2

func AuroraMysqlEngineVersion_VER_2_04_2() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_3

func AuroraMysqlEngineVersion_VER_2_04_3() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_4

func AuroraMysqlEngineVersion_VER_2_04_4() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_5

func AuroraMysqlEngineVersion_VER_2_04_5() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_6

func AuroraMysqlEngineVersion_VER_2_04_6() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_7

func AuroraMysqlEngineVersion_VER_2_04_7() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_04_8

func AuroraMysqlEngineVersion_VER_2_04_8() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_05_0

func AuroraMysqlEngineVersion_VER_2_05_0() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_06_0

func AuroraMysqlEngineVersion_VER_2_06_0() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_07_0

func AuroraMysqlEngineVersion_VER_2_07_0() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_07_1

func AuroraMysqlEngineVersion_VER_2_07_1() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_07_2

func AuroraMysqlEngineVersion_VER_2_07_2() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_08_0

func AuroraMysqlEngineVersion_VER_2_08_0() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_08_1

func AuroraMysqlEngineVersion_VER_2_08_1() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_08_2

func AuroraMysqlEngineVersion_VER_2_08_2() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_09_0

func AuroraMysqlEngineVersion_VER_2_09_0() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_09_1

func AuroraMysqlEngineVersion_VER_2_09_1() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_09_2

func AuroraMysqlEngineVersion_VER_2_09_2() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_10_0

func AuroraMysqlEngineVersion_VER_2_10_0() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_2_10_1

func AuroraMysqlEngineVersion_VER_2_10_1() AuroraMysqlEngineVersion

func AuroraMysqlEngineVersion_VER_5_7_12

func AuroraMysqlEngineVersion_VER_5_7_12() AuroraMysqlEngineVersion

type AuroraPostgresClusterEngineProps

type AuroraPostgresClusterEngineProps struct {
	// The version of the Aurora PostgreSQL cluster engine.
	// Experimental.
	Version AuroraPostgresEngineVersion `json:"version"`
}

Creation properties of the Aurora PostgreSQL database cluster engine.

Used in {@link DatabaseClusterEngine.auroraPostgres}.

TODO: EXAMPLE

Experimental.

type AuroraPostgresEngineFeatures

type AuroraPostgresEngineFeatures struct {
	// Whether this version of the Aurora Postgres cluster engine supports the S3 data export feature.
	// Experimental.
	S3Export *bool `json:"s3Export"`
	// Whether this version of the Aurora Postgres cluster engine supports the S3 data import feature.
	// Experimental.
	S3Import *bool `json:"s3Import"`
}

Features supported by this version of the Aurora Postgres cluster engine.

TODO: EXAMPLE

Experimental.

type AuroraPostgresEngineVersion

type AuroraPostgresEngineVersion interface {
	AuroraPostgresFullVersion() *string
	AuroraPostgresMajorVersion() *string
}

The versions for the Aurora PostgreSQL cluster engine (those returned by {@link DatabaseClusterEngine.auroraPostgres}).

TODO: EXAMPLE

Experimental.

func AuroraPostgresEngineVersion_Of

func AuroraPostgresEngineVersion_Of(auroraPostgresFullVersion *string, auroraPostgresMajorVersion *string, auroraPostgresFeatures *AuroraPostgresEngineFeatures) AuroraPostgresEngineVersion

Create a new AuroraPostgresEngineVersion with an arbitrary version. Experimental.

func AuroraPostgresEngineVersion_VER_10_11

func AuroraPostgresEngineVersion_VER_10_11() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_12

func AuroraPostgresEngineVersion_VER_10_12() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_13

func AuroraPostgresEngineVersion_VER_10_13() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_14

func AuroraPostgresEngineVersion_VER_10_14() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_16

func AuroraPostgresEngineVersion_VER_10_16() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_18

func AuroraPostgresEngineVersion_VER_10_18() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_4

func AuroraPostgresEngineVersion_VER_10_4() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_5

func AuroraPostgresEngineVersion_VER_10_5() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_6

func AuroraPostgresEngineVersion_VER_10_6() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_10_7

func AuroraPostgresEngineVersion_VER_10_7() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_11_11

func AuroraPostgresEngineVersion_VER_11_11() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_11_13

func AuroraPostgresEngineVersion_VER_11_13() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_11_4

func AuroraPostgresEngineVersion_VER_11_4() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_11_6

func AuroraPostgresEngineVersion_VER_11_6() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_11_7

func AuroraPostgresEngineVersion_VER_11_7() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_11_8

func AuroraPostgresEngineVersion_VER_11_8() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_11_9

func AuroraPostgresEngineVersion_VER_11_9() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_12_4

func AuroraPostgresEngineVersion_VER_12_4() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_12_6

func AuroraPostgresEngineVersion_VER_12_6() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_12_8

func AuroraPostgresEngineVersion_VER_12_8() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_13_3

func AuroraPostgresEngineVersion_VER_13_3() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_13_4

func AuroraPostgresEngineVersion_VER_13_4() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_11

func AuroraPostgresEngineVersion_VER_9_6_11() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_12

func AuroraPostgresEngineVersion_VER_9_6_12() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_16

func AuroraPostgresEngineVersion_VER_9_6_16() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_17

func AuroraPostgresEngineVersion_VER_9_6_17() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_18

func AuroraPostgresEngineVersion_VER_9_6_18() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_19

func AuroraPostgresEngineVersion_VER_9_6_19() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_8

func AuroraPostgresEngineVersion_VER_9_6_8() AuroraPostgresEngineVersion

func AuroraPostgresEngineVersion_VER_9_6_9

func AuroraPostgresEngineVersion_VER_9_6_9() AuroraPostgresEngineVersion

type BackupProps

type BackupProps struct {
	// 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'
	// Experimental.
	PreferredWindow *string `json:"preferredWindow"`
	// How many days to retain the backup.
	// Experimental.
	Retention awscdk.Duration `json:"retention"`
}

Backup configuration for RDS databases.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

Experimental.

type CfnDBCluster

type CfnDBCluster interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AssociatedRoles() interface{}
	SetAssociatedRoles(val interface{})
	AttrEndpointAddress() *string
	AttrEndpointPort() *string
	AttrReadEndpointAddress() *string
	AvailabilityZones() *[]*string
	SetAvailabilityZones(val *[]*string)
	BacktrackWindow() *float64
	SetBacktrackWindow(val *float64)
	BackupRetentionPeriod() *float64
	SetBackupRetentionPeriod(val *float64)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CopyTagsToSnapshot() interface{}
	SetCopyTagsToSnapshot(val interface{})
	CreationStack() *[]*string
	DatabaseName() *string
	SetDatabaseName(val *string)
	DbClusterIdentifier() *string
	SetDbClusterIdentifier(val *string)
	DbClusterParameterGroupName() *string
	SetDbClusterParameterGroupName(val *string)
	DbSubnetGroupName() *string
	SetDbSubnetGroupName(val *string)
	DeletionProtection() interface{}
	SetDeletionProtection(val interface{})
	EnableCloudwatchLogsExports() *[]*string
	SetEnableCloudwatchLogsExports(val *[]*string)
	EnableHttpEndpoint() interface{}
	SetEnableHttpEndpoint(val interface{})
	EnableIamDatabaseAuthentication() interface{}
	SetEnableIamDatabaseAuthentication(val interface{})
	Engine() *string
	SetEngine(val *string)
	EngineMode() *string
	SetEngineMode(val *string)
	EngineVersion() *string
	SetEngineVersion(val *string)
	GlobalClusterIdentifier() *string
	SetGlobalClusterIdentifier(val *string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LogicalId() *string
	MasterUsername() *string
	SetMasterUsername(val *string)
	MasterUserPassword() *string
	SetMasterUserPassword(val *string)
	Node() constructs.Node
	Port() *float64
	SetPort(val *float64)
	PreferredBackupWindow() *string
	SetPreferredBackupWindow(val *string)
	PreferredMaintenanceWindow() *string
	SetPreferredMaintenanceWindow(val *string)
	Ref() *string
	ReplicationSourceIdentifier() *string
	SetReplicationSourceIdentifier(val *string)
	RestoreType() *string
	SetRestoreType(val *string)
	ScalingConfiguration() interface{}
	SetScalingConfiguration(val interface{})
	SnapshotIdentifier() *string
	SetSnapshotIdentifier(val *string)
	SourceDbClusterIdentifier() *string
	SetSourceDbClusterIdentifier(val *string)
	SourceRegion() *string
	SetSourceRegion(val *string)
	Stack() awscdk.Stack
	StorageEncrypted() interface{}
	SetStorageEncrypted(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	UseLatestRestorableTime() interface{}
	SetUseLatestRestorableTime(val interface{})
	VpcSecurityGroupIds() *[]*string
	SetVpcSecurityGroupIds(val *[]*string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBCluster`.

TODO: EXAMPLE

func NewCfnDBCluster

func NewCfnDBCluster(scope constructs.Construct, id *string, props *CfnDBClusterProps) CfnDBCluster

Create a new `AWS::RDS::DBCluster`.

type CfnDBClusterParameterGroup

type CfnDBClusterParameterGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	Family() *string
	SetFamily(val *string)
	LogicalId() *string
	Node() constructs.Node
	Parameters() interface{}
	SetParameters(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBClusterParameterGroup`.

TODO: EXAMPLE

func NewCfnDBClusterParameterGroup

func NewCfnDBClusterParameterGroup(scope constructs.Construct, id *string, props *CfnDBClusterParameterGroupProps) CfnDBClusterParameterGroup

Create a new `AWS::RDS::DBClusterParameterGroup`.

type CfnDBClusterParameterGroupProps

type CfnDBClusterParameterGroupProps struct {
	// `AWS::RDS::DBClusterParameterGroup.Description`.
	Description *string `json:"description"`
	// `AWS::RDS::DBClusterParameterGroup.Family`.
	Family *string `json:"family"`
	// `AWS::RDS::DBClusterParameterGroup.Parameters`.
	Parameters interface{} `json:"parameters"`
	// `AWS::RDS::DBClusterParameterGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::RDS::DBClusterParameterGroup`.

TODO: EXAMPLE

type CfnDBClusterProps

type CfnDBClusterProps struct {
	// `AWS::RDS::DBCluster.AssociatedRoles`.
	AssociatedRoles interface{} `json:"associatedRoles"`
	// `AWS::RDS::DBCluster.AvailabilityZones`.
	AvailabilityZones *[]*string `json:"availabilityZones"`
	// `AWS::RDS::DBCluster.BacktrackWindow`.
	BacktrackWindow *float64 `json:"backtrackWindow"`
	// `AWS::RDS::DBCluster.BackupRetentionPeriod`.
	BackupRetentionPeriod *float64 `json:"backupRetentionPeriod"`
	// `AWS::RDS::DBCluster.CopyTagsToSnapshot`.
	CopyTagsToSnapshot interface{} `json:"copyTagsToSnapshot"`
	// `AWS::RDS::DBCluster.DatabaseName`.
	DatabaseName *string `json:"databaseName"`
	// `AWS::RDS::DBCluster.DBClusterIdentifier`.
	DbClusterIdentifier *string `json:"dbClusterIdentifier"`
	// `AWS::RDS::DBCluster.DBClusterParameterGroupName`.
	DbClusterParameterGroupName *string `json:"dbClusterParameterGroupName"`
	// `AWS::RDS::DBCluster.DBSubnetGroupName`.
	DbSubnetGroupName *string `json:"dbSubnetGroupName"`
	// `AWS::RDS::DBCluster.DeletionProtection`.
	DeletionProtection interface{} `json:"deletionProtection"`
	// `AWS::RDS::DBCluster.EnableCloudwatchLogsExports`.
	EnableCloudwatchLogsExports *[]*string `json:"enableCloudwatchLogsExports"`
	// `AWS::RDS::DBCluster.EnableHttpEndpoint`.
	EnableHttpEndpoint interface{} `json:"enableHttpEndpoint"`
	// `AWS::RDS::DBCluster.EnableIAMDatabaseAuthentication`.
	EnableIamDatabaseAuthentication interface{} `json:"enableIamDatabaseAuthentication"`
	// `AWS::RDS::DBCluster.Engine`.
	Engine *string `json:"engine"`
	// `AWS::RDS::DBCluster.EngineMode`.
	EngineMode *string `json:"engineMode"`
	// `AWS::RDS::DBCluster.EngineVersion`.
	EngineVersion *string `json:"engineVersion"`
	// `AWS::RDS::DBCluster.GlobalClusterIdentifier`.
	GlobalClusterIdentifier *string `json:"globalClusterIdentifier"`
	// `AWS::RDS::DBCluster.KmsKeyId`.
	KmsKeyId *string `json:"kmsKeyId"`
	// `AWS::RDS::DBCluster.MasterUsername`.
	MasterUsername *string `json:"masterUsername"`
	// `AWS::RDS::DBCluster.MasterUserPassword`.
	MasterUserPassword *string `json:"masterUserPassword"`
	// `AWS::RDS::DBCluster.Port`.
	Port *float64 `json:"port"`
	// `AWS::RDS::DBCluster.PreferredBackupWindow`.
	PreferredBackupWindow *string `json:"preferredBackupWindow"`
	// `AWS::RDS::DBCluster.PreferredMaintenanceWindow`.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// `AWS::RDS::DBCluster.ReplicationSourceIdentifier`.
	ReplicationSourceIdentifier *string `json:"replicationSourceIdentifier"`
	// `AWS::RDS::DBCluster.RestoreType`.
	RestoreType *string `json:"restoreType"`
	// `AWS::RDS::DBCluster.ScalingConfiguration`.
	ScalingConfiguration interface{} `json:"scalingConfiguration"`
	// `AWS::RDS::DBCluster.SnapshotIdentifier`.
	SnapshotIdentifier *string `json:"snapshotIdentifier"`
	// `AWS::RDS::DBCluster.SourceDBClusterIdentifier`.
	SourceDbClusterIdentifier *string `json:"sourceDbClusterIdentifier"`
	// `AWS::RDS::DBCluster.SourceRegion`.
	SourceRegion *string `json:"sourceRegion"`
	// `AWS::RDS::DBCluster.StorageEncrypted`.
	StorageEncrypted interface{} `json:"storageEncrypted"`
	// `AWS::RDS::DBCluster.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::RDS::DBCluster.UseLatestRestorableTime`.
	UseLatestRestorableTime interface{} `json:"useLatestRestorableTime"`
	// `AWS::RDS::DBCluster.VpcSecurityGroupIds`.
	VpcSecurityGroupIds *[]*string `json:"vpcSecurityGroupIds"`
}

Properties for defining a `AWS::RDS::DBCluster`.

TODO: EXAMPLE

type CfnDBCluster_DBClusterRoleProperty

type CfnDBCluster_DBClusterRoleProperty struct {
	// `CfnDBCluster.DBClusterRoleProperty.FeatureName`.
	FeatureName *string `json:"featureName"`
	// `CfnDBCluster.DBClusterRoleProperty.RoleArn`.
	RoleArn *string `json:"roleArn"`
}

TODO: EXAMPLE

type CfnDBCluster_ScalingConfigurationProperty

type CfnDBCluster_ScalingConfigurationProperty struct {
	// `CfnDBCluster.ScalingConfigurationProperty.AutoPause`.
	AutoPause interface{} `json:"autoPause"`
	// `CfnDBCluster.ScalingConfigurationProperty.MaxCapacity`.
	MaxCapacity *float64 `json:"maxCapacity"`
	// `CfnDBCluster.ScalingConfigurationProperty.MinCapacity`.
	MinCapacity *float64 `json:"minCapacity"`
	// `CfnDBCluster.ScalingConfigurationProperty.SecondsUntilAutoPause`.
	SecondsUntilAutoPause *float64 `json:"secondsUntilAutoPause"`
}

TODO: EXAMPLE

type CfnDBInstance

type CfnDBInstance interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AllocatedStorage() *string
	SetAllocatedStorage(val *string)
	AllowMajorVersionUpgrade() interface{}
	SetAllowMajorVersionUpgrade(val interface{})
	AssociatedRoles() interface{}
	SetAssociatedRoles(val interface{})
	AttrEndpointAddress() *string
	AttrEndpointPort() *string
	AutoMinorVersionUpgrade() interface{}
	SetAutoMinorVersionUpgrade(val interface{})
	AvailabilityZone() *string
	SetAvailabilityZone(val *string)
	BackupRetentionPeriod() *float64
	SetBackupRetentionPeriod(val *float64)
	CaCertificateIdentifier() *string
	SetCaCertificateIdentifier(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CharacterSetName() *string
	SetCharacterSetName(val *string)
	CopyTagsToSnapshot() interface{}
	SetCopyTagsToSnapshot(val interface{})
	CreationStack() *[]*string
	DbClusterIdentifier() *string
	SetDbClusterIdentifier(val *string)
	DbInstanceClass() *string
	SetDbInstanceClass(val *string)
	DbInstanceIdentifier() *string
	SetDbInstanceIdentifier(val *string)
	DbName() *string
	SetDbName(val *string)
	DbParameterGroupName() *string
	SetDbParameterGroupName(val *string)
	DbSecurityGroups() *[]*string
	SetDbSecurityGroups(val *[]*string)
	DbSnapshotIdentifier() *string
	SetDbSnapshotIdentifier(val *string)
	DbSubnetGroupName() *string
	SetDbSubnetGroupName(val *string)
	DeleteAutomatedBackups() interface{}
	SetDeleteAutomatedBackups(val interface{})
	DeletionProtection() interface{}
	SetDeletionProtection(val interface{})
	Domain() *string
	SetDomain(val *string)
	DomainIamRoleName() *string
	SetDomainIamRoleName(val *string)
	EnableCloudwatchLogsExports() *[]*string
	SetEnableCloudwatchLogsExports(val *[]*string)
	EnableIamDatabaseAuthentication() interface{}
	SetEnableIamDatabaseAuthentication(val interface{})
	EnablePerformanceInsights() interface{}
	SetEnablePerformanceInsights(val interface{})
	Engine() *string
	SetEngine(val *string)
	EngineVersion() *string
	SetEngineVersion(val *string)
	Iops() *float64
	SetIops(val *float64)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LicenseModel() *string
	SetLicenseModel(val *string)
	LogicalId() *string
	MasterUsername() *string
	SetMasterUsername(val *string)
	MasterUserPassword() *string
	SetMasterUserPassword(val *string)
	MaxAllocatedStorage() *float64
	SetMaxAllocatedStorage(val *float64)
	MonitoringInterval() *float64
	SetMonitoringInterval(val *float64)
	MonitoringRoleArn() *string
	SetMonitoringRoleArn(val *string)
	MultiAz() interface{}
	SetMultiAz(val interface{})
	Node() constructs.Node
	OptionGroupName() *string
	SetOptionGroupName(val *string)
	PerformanceInsightsKmsKeyId() *string
	SetPerformanceInsightsKmsKeyId(val *string)
	PerformanceInsightsRetentionPeriod() *float64
	SetPerformanceInsightsRetentionPeriod(val *float64)
	Port() *string
	SetPort(val *string)
	PreferredBackupWindow() *string
	SetPreferredBackupWindow(val *string)
	PreferredMaintenanceWindow() *string
	SetPreferredMaintenanceWindow(val *string)
	ProcessorFeatures() interface{}
	SetProcessorFeatures(val interface{})
	PromotionTier() *float64
	SetPromotionTier(val *float64)
	PubliclyAccessible() interface{}
	SetPubliclyAccessible(val interface{})
	Ref() *string
	SourceDbInstanceIdentifier() *string
	SetSourceDbInstanceIdentifier(val *string)
	SourceRegion() *string
	SetSourceRegion(val *string)
	Stack() awscdk.Stack
	StorageEncrypted() interface{}
	SetStorageEncrypted(val interface{})
	StorageType() *string
	SetStorageType(val *string)
	Tags() awscdk.TagManager
	Timezone() *string
	SetTimezone(val *string)
	UpdatedProperites() *map[string]interface{}
	UseDefaultProcessorFeatures() interface{}
	SetUseDefaultProcessorFeatures(val interface{})
	VpcSecurityGroups() *[]*string
	SetVpcSecurityGroups(val *[]*string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBInstance`.

TODO: EXAMPLE

func NewCfnDBInstance

func NewCfnDBInstance(scope constructs.Construct, id *string, props *CfnDBInstanceProps) CfnDBInstance

Create a new `AWS::RDS::DBInstance`.

type CfnDBInstanceProps

type CfnDBInstanceProps struct {
	// `AWS::RDS::DBInstance.AllocatedStorage`.
	AllocatedStorage *string `json:"allocatedStorage"`
	// `AWS::RDS::DBInstance.AllowMajorVersionUpgrade`.
	AllowMajorVersionUpgrade interface{} `json:"allowMajorVersionUpgrade"`
	// `AWS::RDS::DBInstance.AssociatedRoles`.
	AssociatedRoles interface{} `json:"associatedRoles"`
	// `AWS::RDS::DBInstance.AutoMinorVersionUpgrade`.
	AutoMinorVersionUpgrade interface{} `json:"autoMinorVersionUpgrade"`
	// `AWS::RDS::DBInstance.AvailabilityZone`.
	AvailabilityZone *string `json:"availabilityZone"`
	// `AWS::RDS::DBInstance.BackupRetentionPeriod`.
	BackupRetentionPeriod *float64 `json:"backupRetentionPeriod"`
	// `AWS::RDS::DBInstance.CACertificateIdentifier`.
	CaCertificateIdentifier *string `json:"caCertificateIdentifier"`
	// `AWS::RDS::DBInstance.CharacterSetName`.
	CharacterSetName *string `json:"characterSetName"`
	// `AWS::RDS::DBInstance.CopyTagsToSnapshot`.
	CopyTagsToSnapshot interface{} `json:"copyTagsToSnapshot"`
	// `AWS::RDS::DBInstance.DBClusterIdentifier`.
	DbClusterIdentifier *string `json:"dbClusterIdentifier"`
	// `AWS::RDS::DBInstance.DBInstanceClass`.
	DbInstanceClass *string `json:"dbInstanceClass"`
	// `AWS::RDS::DBInstance.DBInstanceIdentifier`.
	DbInstanceIdentifier *string `json:"dbInstanceIdentifier"`
	// `AWS::RDS::DBInstance.DBName`.
	DbName *string `json:"dbName"`
	// `AWS::RDS::DBInstance.DBParameterGroupName`.
	DbParameterGroupName *string `json:"dbParameterGroupName"`
	// `AWS::RDS::DBInstance.DBSecurityGroups`.
	DbSecurityGroups *[]*string `json:"dbSecurityGroups"`
	// `AWS::RDS::DBInstance.DBSnapshotIdentifier`.
	DbSnapshotIdentifier *string `json:"dbSnapshotIdentifier"`
	// `AWS::RDS::DBInstance.DBSubnetGroupName`.
	DbSubnetGroupName *string `json:"dbSubnetGroupName"`
	// `AWS::RDS::DBInstance.DeleteAutomatedBackups`.
	DeleteAutomatedBackups interface{} `json:"deleteAutomatedBackups"`
	// `AWS::RDS::DBInstance.DeletionProtection`.
	DeletionProtection interface{} `json:"deletionProtection"`
	// `AWS::RDS::DBInstance.Domain`.
	Domain *string `json:"domain"`
	// `AWS::RDS::DBInstance.DomainIAMRoleName`.
	DomainIamRoleName *string `json:"domainIamRoleName"`
	// `AWS::RDS::DBInstance.EnableCloudwatchLogsExports`.
	EnableCloudwatchLogsExports *[]*string `json:"enableCloudwatchLogsExports"`
	// `AWS::RDS::DBInstance.EnableIAMDatabaseAuthentication`.
	EnableIamDatabaseAuthentication interface{} `json:"enableIamDatabaseAuthentication"`
	// `AWS::RDS::DBInstance.EnablePerformanceInsights`.
	EnablePerformanceInsights interface{} `json:"enablePerformanceInsights"`
	// `AWS::RDS::DBInstance.Engine`.
	Engine *string `json:"engine"`
	// `AWS::RDS::DBInstance.EngineVersion`.
	EngineVersion *string `json:"engineVersion"`
	// `AWS::RDS::DBInstance.Iops`.
	Iops *float64 `json:"iops"`
	// `AWS::RDS::DBInstance.KmsKeyId`.
	KmsKeyId *string `json:"kmsKeyId"`
	// `AWS::RDS::DBInstance.LicenseModel`.
	LicenseModel *string `json:"licenseModel"`
	// `AWS::RDS::DBInstance.MasterUsername`.
	MasterUsername *string `json:"masterUsername"`
	// `AWS::RDS::DBInstance.MasterUserPassword`.
	MasterUserPassword *string `json:"masterUserPassword"`
	// `AWS::RDS::DBInstance.MaxAllocatedStorage`.
	MaxAllocatedStorage *float64 `json:"maxAllocatedStorage"`
	// `AWS::RDS::DBInstance.MonitoringInterval`.
	MonitoringInterval *float64 `json:"monitoringInterval"`
	// `AWS::RDS::DBInstance.MonitoringRoleArn`.
	MonitoringRoleArn *string `json:"monitoringRoleArn"`
	// `AWS::RDS::DBInstance.MultiAZ`.
	MultiAz interface{} `json:"multiAz"`
	// `AWS::RDS::DBInstance.OptionGroupName`.
	OptionGroupName *string `json:"optionGroupName"`
	// `AWS::RDS::DBInstance.PerformanceInsightsKMSKeyId`.
	PerformanceInsightsKmsKeyId *string `json:"performanceInsightsKmsKeyId"`
	// `AWS::RDS::DBInstance.PerformanceInsightsRetentionPeriod`.
	PerformanceInsightsRetentionPeriod *float64 `json:"performanceInsightsRetentionPeriod"`
	// `AWS::RDS::DBInstance.Port`.
	Port *string `json:"port"`
	// `AWS::RDS::DBInstance.PreferredBackupWindow`.
	PreferredBackupWindow *string `json:"preferredBackupWindow"`
	// `AWS::RDS::DBInstance.PreferredMaintenanceWindow`.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// `AWS::RDS::DBInstance.ProcessorFeatures`.
	ProcessorFeatures interface{} `json:"processorFeatures"`
	// `AWS::RDS::DBInstance.PromotionTier`.
	PromotionTier *float64 `json:"promotionTier"`
	// `AWS::RDS::DBInstance.PubliclyAccessible`.
	PubliclyAccessible interface{} `json:"publiclyAccessible"`
	// `AWS::RDS::DBInstance.SourceDBInstanceIdentifier`.
	SourceDbInstanceIdentifier *string `json:"sourceDbInstanceIdentifier"`
	// `AWS::RDS::DBInstance.SourceRegion`.
	SourceRegion *string `json:"sourceRegion"`
	// `AWS::RDS::DBInstance.StorageEncrypted`.
	StorageEncrypted interface{} `json:"storageEncrypted"`
	// `AWS::RDS::DBInstance.StorageType`.
	StorageType *string `json:"storageType"`
	// `AWS::RDS::DBInstance.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::RDS::DBInstance.Timezone`.
	Timezone *string `json:"timezone"`
	// `AWS::RDS::DBInstance.UseDefaultProcessorFeatures`.
	UseDefaultProcessorFeatures interface{} `json:"useDefaultProcessorFeatures"`
	// `AWS::RDS::DBInstance.VPCSecurityGroups`.
	VpcSecurityGroups *[]*string `json:"vpcSecurityGroups"`
}

Properties for defining a `AWS::RDS::DBInstance`.

TODO: EXAMPLE

type CfnDBInstance_DBInstanceRoleProperty

type CfnDBInstance_DBInstanceRoleProperty struct {
	// `CfnDBInstance.DBInstanceRoleProperty.FeatureName`.
	FeatureName *string `json:"featureName"`
	// `CfnDBInstance.DBInstanceRoleProperty.RoleArn`.
	RoleArn *string `json:"roleArn"`
}

TODO: EXAMPLE

type CfnDBInstance_ProcessorFeatureProperty

type CfnDBInstance_ProcessorFeatureProperty struct {
	// `CfnDBInstance.ProcessorFeatureProperty.Name`.
	Name *string `json:"name"`
	// `CfnDBInstance.ProcessorFeatureProperty.Value`.
	Value *string `json:"value"`
}

TODO: EXAMPLE

type CfnDBParameterGroup

type CfnDBParameterGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	Family() *string
	SetFamily(val *string)
	LogicalId() *string
	Node() constructs.Node
	Parameters() interface{}
	SetParameters(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBParameterGroup`.

TODO: EXAMPLE

func NewCfnDBParameterGroup

func NewCfnDBParameterGroup(scope constructs.Construct, id *string, props *CfnDBParameterGroupProps) CfnDBParameterGroup

Create a new `AWS::RDS::DBParameterGroup`.

type CfnDBParameterGroupProps

type CfnDBParameterGroupProps struct {
	// `AWS::RDS::DBParameterGroup.Description`.
	Description *string `json:"description"`
	// `AWS::RDS::DBParameterGroup.Family`.
	Family *string `json:"family"`
	// `AWS::RDS::DBParameterGroup.Parameters`.
	Parameters interface{} `json:"parameters"`
	// `AWS::RDS::DBParameterGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::RDS::DBParameterGroup`.

TODO: EXAMPLE

type CfnDBProxy

type CfnDBProxy interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrDbProxyArn() *string
	AttrEndpoint() *string
	AttrVpcId() *string
	Auth() interface{}
	SetAuth(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DbProxyName() *string
	SetDbProxyName(val *string)
	DebugLogging() interface{}
	SetDebugLogging(val interface{})
	EngineFamily() *string
	SetEngineFamily(val *string)
	IdleClientTimeout() *float64
	SetIdleClientTimeout(val *float64)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RequireTls() interface{}
	SetRequireTls(val interface{})
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	Tags() *[]*CfnDBProxy_TagFormatProperty
	SetTags(val *[]*CfnDBProxy_TagFormatProperty)
	UpdatedProperites() *map[string]interface{}
	VpcSecurityGroupIds() *[]*string
	SetVpcSecurityGroupIds(val *[]*string)
	VpcSubnetIds() *[]*string
	SetVpcSubnetIds(val *[]*string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBProxy`.

TODO: EXAMPLE

func NewCfnDBProxy

func NewCfnDBProxy(scope constructs.Construct, id *string, props *CfnDBProxyProps) CfnDBProxy

Create a new `AWS::RDS::DBProxy`.

type CfnDBProxyEndpoint

type CfnDBProxyEndpoint interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrDbProxyEndpointArn() *string
	AttrEndpoint() *string
	AttrIsDefault() awscdk.IResolvable
	AttrVpcId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DbProxyEndpointName() *string
	SetDbProxyEndpointName(val *string)
	DbProxyName() *string
	SetDbProxyName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() *[]*CfnDBProxyEndpoint_TagFormatProperty
	SetTags(val *[]*CfnDBProxyEndpoint_TagFormatProperty)
	TargetRole() *string
	SetTargetRole(val *string)
	UpdatedProperites() *map[string]interface{}
	VpcSecurityGroupIds() *[]*string
	SetVpcSecurityGroupIds(val *[]*string)
	VpcSubnetIds() *[]*string
	SetVpcSubnetIds(val *[]*string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBProxyEndpoint`.

TODO: EXAMPLE

func NewCfnDBProxyEndpoint

func NewCfnDBProxyEndpoint(scope constructs.Construct, id *string, props *CfnDBProxyEndpointProps) CfnDBProxyEndpoint

Create a new `AWS::RDS::DBProxyEndpoint`.

type CfnDBProxyEndpointProps

type CfnDBProxyEndpointProps struct {
	// `AWS::RDS::DBProxyEndpoint.DBProxyEndpointName`.
	DbProxyEndpointName *string `json:"dbProxyEndpointName"`
	// `AWS::RDS::DBProxyEndpoint.DBProxyName`.
	DbProxyName *string `json:"dbProxyName"`
	// `AWS::RDS::DBProxyEndpoint.Tags`.
	Tags *[]*CfnDBProxyEndpoint_TagFormatProperty `json:"tags"`
	// `AWS::RDS::DBProxyEndpoint.TargetRole`.
	TargetRole *string `json:"targetRole"`
	// `AWS::RDS::DBProxyEndpoint.VpcSecurityGroupIds`.
	VpcSecurityGroupIds *[]*string `json:"vpcSecurityGroupIds"`
	// `AWS::RDS::DBProxyEndpoint.VpcSubnetIds`.
	VpcSubnetIds *[]*string `json:"vpcSubnetIds"`
}

Properties for defining a `AWS::RDS::DBProxyEndpoint`.

TODO: EXAMPLE

type CfnDBProxyEndpoint_TagFormatProperty

type CfnDBProxyEndpoint_TagFormatProperty struct {
	// `CfnDBProxyEndpoint.TagFormatProperty.Key`.
	Key *string `json:"key"`
	// `CfnDBProxyEndpoint.TagFormatProperty.Value`.
	Value *string `json:"value"`
}

TODO: EXAMPLE

type CfnDBProxyProps

type CfnDBProxyProps struct {
	// `AWS::RDS::DBProxy.Auth`.
	Auth interface{} `json:"auth"`
	// `AWS::RDS::DBProxy.DBProxyName`.
	DbProxyName *string `json:"dbProxyName"`
	// `AWS::RDS::DBProxy.DebugLogging`.
	DebugLogging interface{} `json:"debugLogging"`
	// `AWS::RDS::DBProxy.EngineFamily`.
	EngineFamily *string `json:"engineFamily"`
	// `AWS::RDS::DBProxy.IdleClientTimeout`.
	IdleClientTimeout *float64 `json:"idleClientTimeout"`
	// `AWS::RDS::DBProxy.RequireTLS`.
	RequireTls interface{} `json:"requireTls"`
	// `AWS::RDS::DBProxy.RoleArn`.
	RoleArn *string `json:"roleArn"`
	// `AWS::RDS::DBProxy.Tags`.
	Tags *[]*CfnDBProxy_TagFormatProperty `json:"tags"`
	// `AWS::RDS::DBProxy.VpcSecurityGroupIds`.
	VpcSecurityGroupIds *[]*string `json:"vpcSecurityGroupIds"`
	// `AWS::RDS::DBProxy.VpcSubnetIds`.
	VpcSubnetIds *[]*string `json:"vpcSubnetIds"`
}

Properties for defining a `AWS::RDS::DBProxy`.

TODO: EXAMPLE

type CfnDBProxyTargetGroup

type CfnDBProxyTargetGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrTargetGroupArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConnectionPoolConfigurationInfo() interface{}
	SetConnectionPoolConfigurationInfo(val interface{})
	CreationStack() *[]*string
	DbClusterIdentifiers() *[]*string
	SetDbClusterIdentifiers(val *[]*string)
	DbInstanceIdentifiers() *[]*string
	SetDbInstanceIdentifiers(val *[]*string)
	DbProxyName() *string
	SetDbProxyName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	TargetGroupName() *string
	SetTargetGroupName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBProxyTargetGroup`.

TODO: EXAMPLE

func NewCfnDBProxyTargetGroup

func NewCfnDBProxyTargetGroup(scope constructs.Construct, id *string, props *CfnDBProxyTargetGroupProps) CfnDBProxyTargetGroup

Create a new `AWS::RDS::DBProxyTargetGroup`.

type CfnDBProxyTargetGroupProps

type CfnDBProxyTargetGroupProps struct {
	// `AWS::RDS::DBProxyTargetGroup.ConnectionPoolConfigurationInfo`.
	ConnectionPoolConfigurationInfo interface{} `json:"connectionPoolConfigurationInfo"`
	// `AWS::RDS::DBProxyTargetGroup.DBClusterIdentifiers`.
	DbClusterIdentifiers *[]*string `json:"dbClusterIdentifiers"`
	// `AWS::RDS::DBProxyTargetGroup.DBInstanceIdentifiers`.
	DbInstanceIdentifiers *[]*string `json:"dbInstanceIdentifiers"`
	// `AWS::RDS::DBProxyTargetGroup.DBProxyName`.
	DbProxyName *string `json:"dbProxyName"`
	// `AWS::RDS::DBProxyTargetGroup.TargetGroupName`.
	TargetGroupName *string `json:"targetGroupName"`
}

Properties for defining a `AWS::RDS::DBProxyTargetGroup`.

TODO: EXAMPLE

type CfnDBProxyTargetGroup_ConnectionPoolConfigurationInfoFormatProperty

type CfnDBProxyTargetGroup_ConnectionPoolConfigurationInfoFormatProperty struct {
	// `CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.ConnectionBorrowTimeout`.
	ConnectionBorrowTimeout *float64 `json:"connectionBorrowTimeout"`
	// `CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.InitQuery`.
	InitQuery *string `json:"initQuery"`
	// `CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.MaxConnectionsPercent`.
	MaxConnectionsPercent *float64 `json:"maxConnectionsPercent"`
	// `CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.MaxIdleConnectionsPercent`.
	MaxIdleConnectionsPercent *float64 `json:"maxIdleConnectionsPercent"`
	// `CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.SessionPinningFilters`.
	SessionPinningFilters *[]*string `json:"sessionPinningFilters"`
}

TODO: EXAMPLE

type CfnDBProxy_AuthFormatProperty

type CfnDBProxy_AuthFormatProperty struct {
	// `CfnDBProxy.AuthFormatProperty.AuthScheme`.
	AuthScheme *string `json:"authScheme"`
	// `CfnDBProxy.AuthFormatProperty.Description`.
	Description *string `json:"description"`
	// `CfnDBProxy.AuthFormatProperty.IAMAuth`.
	IamAuth *string `json:"iamAuth"`
	// `CfnDBProxy.AuthFormatProperty.SecretArn`.
	SecretArn *string `json:"secretArn"`
	// `CfnDBProxy.AuthFormatProperty.UserName`.
	UserName *string `json:"userName"`
}

TODO: EXAMPLE

type CfnDBProxy_TagFormatProperty

type CfnDBProxy_TagFormatProperty struct {
	// `CfnDBProxy.TagFormatProperty.Key`.
	Key *string `json:"key"`
	// `CfnDBProxy.TagFormatProperty.Value`.
	Value *string `json:"value"`
}

TODO: EXAMPLE

type CfnDBSecurityGroup

type CfnDBSecurityGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DbSecurityGroupIngress() interface{}
	SetDbSecurityGroupIngress(val interface{})
	Ec2VpcId() *string
	SetEc2VpcId(val *string)
	GroupDescription() *string
	SetGroupDescription(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBSecurityGroup`.

TODO: EXAMPLE

func NewCfnDBSecurityGroup

func NewCfnDBSecurityGroup(scope constructs.Construct, id *string, props *CfnDBSecurityGroupProps) CfnDBSecurityGroup

Create a new `AWS::RDS::DBSecurityGroup`.

type CfnDBSecurityGroupIngress

type CfnDBSecurityGroupIngress interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Cidrip() *string
	SetCidrip(val *string)
	CreationStack() *[]*string
	DbSecurityGroupName() *string
	SetDbSecurityGroupName(val *string)
	Ec2SecurityGroupId() *string
	SetEc2SecurityGroupId(val *string)
	Ec2SecurityGroupName() *string
	SetEc2SecurityGroupName(val *string)
	Ec2SecurityGroupOwnerId() *string
	SetEc2SecurityGroupOwnerId(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBSecurityGroupIngress`.

TODO: EXAMPLE

func NewCfnDBSecurityGroupIngress

func NewCfnDBSecurityGroupIngress(scope constructs.Construct, id *string, props *CfnDBSecurityGroupIngressProps) CfnDBSecurityGroupIngress

Create a new `AWS::RDS::DBSecurityGroupIngress`.

type CfnDBSecurityGroupIngressProps

type CfnDBSecurityGroupIngressProps struct {
	// `AWS::RDS::DBSecurityGroupIngress.CIDRIP`.
	Cidrip *string `json:"cidrip"`
	// `AWS::RDS::DBSecurityGroupIngress.DBSecurityGroupName`.
	DbSecurityGroupName *string `json:"dbSecurityGroupName"`
	// `AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupId`.
	Ec2SecurityGroupId *string `json:"ec2SecurityGroupId"`
	// `AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupName`.
	Ec2SecurityGroupName *string `json:"ec2SecurityGroupName"`
	// `AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupOwnerId`.
	Ec2SecurityGroupOwnerId *string `json:"ec2SecurityGroupOwnerId"`
}

Properties for defining a `AWS::RDS::DBSecurityGroupIngress`.

TODO: EXAMPLE

type CfnDBSecurityGroupProps

type CfnDBSecurityGroupProps struct {
	// `AWS::RDS::DBSecurityGroup.DBSecurityGroupIngress`.
	DbSecurityGroupIngress interface{} `json:"dbSecurityGroupIngress"`
	// `AWS::RDS::DBSecurityGroup.EC2VpcId`.
	Ec2VpcId *string `json:"ec2VpcId"`
	// `AWS::RDS::DBSecurityGroup.GroupDescription`.
	GroupDescription *string `json:"groupDescription"`
	// `AWS::RDS::DBSecurityGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::RDS::DBSecurityGroup`.

TODO: EXAMPLE

type CfnDBSecurityGroup_IngressProperty

type CfnDBSecurityGroup_IngressProperty struct {
	// `CfnDBSecurityGroup.IngressProperty.CIDRIP`.
	Cidrip *string `json:"cidrip"`
	// `CfnDBSecurityGroup.IngressProperty.EC2SecurityGroupId`.
	Ec2SecurityGroupId *string `json:"ec2SecurityGroupId"`
	// `CfnDBSecurityGroup.IngressProperty.EC2SecurityGroupName`.
	Ec2SecurityGroupName *string `json:"ec2SecurityGroupName"`
	// `CfnDBSecurityGroup.IngressProperty.EC2SecurityGroupOwnerId`.
	Ec2SecurityGroupOwnerId *string `json:"ec2SecurityGroupOwnerId"`
}

TODO: EXAMPLE

type CfnDBSubnetGroup

type CfnDBSubnetGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DbSubnetGroupDescription() *string
	SetDbSubnetGroupDescription(val *string)
	DbSubnetGroupName() *string
	SetDbSubnetGroupName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	SubnetIds() *[]*string
	SetSubnetIds(val *[]*string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::DBSubnetGroup`.

TODO: EXAMPLE

func NewCfnDBSubnetGroup

func NewCfnDBSubnetGroup(scope constructs.Construct, id *string, props *CfnDBSubnetGroupProps) CfnDBSubnetGroup

Create a new `AWS::RDS::DBSubnetGroup`.

type CfnDBSubnetGroupProps

type CfnDBSubnetGroupProps struct {
	// `AWS::RDS::DBSubnetGroup.DBSubnetGroupDescription`.
	DbSubnetGroupDescription *string `json:"dbSubnetGroupDescription"`
	// `AWS::RDS::DBSubnetGroup.DBSubnetGroupName`.
	DbSubnetGroupName *string `json:"dbSubnetGroupName"`
	// `AWS::RDS::DBSubnetGroup.SubnetIds`.
	SubnetIds *[]*string `json:"subnetIds"`
	// `AWS::RDS::DBSubnetGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::RDS::DBSubnetGroup`.

TODO: EXAMPLE

type CfnEventSubscription

type CfnEventSubscription interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	EventCategories() *[]*string
	SetEventCategories(val *[]*string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SnsTopicArn() *string
	SetSnsTopicArn(val *string)
	SourceIds() *[]*string
	SetSourceIds(val *[]*string)
	SourceType() *string
	SetSourceType(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::EventSubscription`.

TODO: EXAMPLE

func NewCfnEventSubscription

func NewCfnEventSubscription(scope constructs.Construct, id *string, props *CfnEventSubscriptionProps) CfnEventSubscription

Create a new `AWS::RDS::EventSubscription`.

type CfnEventSubscriptionProps

type CfnEventSubscriptionProps struct {
	// `AWS::RDS::EventSubscription.Enabled`.
	Enabled interface{} `json:"enabled"`
	// `AWS::RDS::EventSubscription.EventCategories`.
	EventCategories *[]*string `json:"eventCategories"`
	// `AWS::RDS::EventSubscription.SnsTopicArn`.
	SnsTopicArn *string `json:"snsTopicArn"`
	// `AWS::RDS::EventSubscription.SourceIds`.
	SourceIds *[]*string `json:"sourceIds"`
	// `AWS::RDS::EventSubscription.SourceType`.
	SourceType *string `json:"sourceType"`
}

Properties for defining a `AWS::RDS::EventSubscription`.

TODO: EXAMPLE

type CfnGlobalCluster

type CfnGlobalCluster interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DeletionProtection() interface{}
	SetDeletionProtection(val interface{})
	Engine() *string
	SetEngine(val *string)
	EngineVersion() *string
	SetEngineVersion(val *string)
	GlobalClusterIdentifier() *string
	SetGlobalClusterIdentifier(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SourceDbClusterIdentifier() *string
	SetSourceDbClusterIdentifier(val *string)
	Stack() awscdk.Stack
	StorageEncrypted() interface{}
	SetStorageEncrypted(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::GlobalCluster`.

TODO: EXAMPLE

func NewCfnGlobalCluster

func NewCfnGlobalCluster(scope constructs.Construct, id *string, props *CfnGlobalClusterProps) CfnGlobalCluster

Create a new `AWS::RDS::GlobalCluster`.

type CfnGlobalClusterProps

type CfnGlobalClusterProps struct {
	// `AWS::RDS::GlobalCluster.DeletionProtection`.
	DeletionProtection interface{} `json:"deletionProtection"`
	// `AWS::RDS::GlobalCluster.Engine`.
	Engine *string `json:"engine"`
	// `AWS::RDS::GlobalCluster.EngineVersion`.
	EngineVersion *string `json:"engineVersion"`
	// `AWS::RDS::GlobalCluster.GlobalClusterIdentifier`.
	GlobalClusterIdentifier *string `json:"globalClusterIdentifier"`
	// `AWS::RDS::GlobalCluster.SourceDBClusterIdentifier`.
	SourceDbClusterIdentifier *string `json:"sourceDbClusterIdentifier"`
	// `AWS::RDS::GlobalCluster.StorageEncrypted`.
	StorageEncrypted interface{} `json:"storageEncrypted"`
}

Properties for defining a `AWS::RDS::GlobalCluster`.

TODO: EXAMPLE

type CfnOptionGroup

type CfnOptionGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EngineName() *string
	SetEngineName(val *string)
	LogicalId() *string
	MajorEngineVersion() *string
	SetMajorEngineVersion(val *string)
	Node() constructs.Node
	OptionConfigurations() interface{}
	SetOptionConfigurations(val interface{})
	OptionGroupDescription() *string
	SetOptionGroupDescription(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RDS::OptionGroup`.

TODO: EXAMPLE

func NewCfnOptionGroup

func NewCfnOptionGroup(scope constructs.Construct, id *string, props *CfnOptionGroupProps) CfnOptionGroup

Create a new `AWS::RDS::OptionGroup`.

type CfnOptionGroupProps

type CfnOptionGroupProps struct {
	// `AWS::RDS::OptionGroup.EngineName`.
	EngineName *string `json:"engineName"`
	// `AWS::RDS::OptionGroup.MajorEngineVersion`.
	MajorEngineVersion *string `json:"majorEngineVersion"`
	// `AWS::RDS::OptionGroup.OptionConfigurations`.
	OptionConfigurations interface{} `json:"optionConfigurations"`
	// `AWS::RDS::OptionGroup.OptionGroupDescription`.
	OptionGroupDescription *string `json:"optionGroupDescription"`
	// `AWS::RDS::OptionGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::RDS::OptionGroup`.

TODO: EXAMPLE

type CfnOptionGroup_OptionConfigurationProperty

type CfnOptionGroup_OptionConfigurationProperty struct {
	// `CfnOptionGroup.OptionConfigurationProperty.DBSecurityGroupMemberships`.
	DbSecurityGroupMemberships *[]*string `json:"dbSecurityGroupMemberships"`
	// `CfnOptionGroup.OptionConfigurationProperty.OptionName`.
	OptionName *string `json:"optionName"`
	// `CfnOptionGroup.OptionConfigurationProperty.OptionSettings`.
	OptionSettings interface{} `json:"optionSettings"`
	// `CfnOptionGroup.OptionConfigurationProperty.OptionVersion`.
	OptionVersion *string `json:"optionVersion"`
	// `CfnOptionGroup.OptionConfigurationProperty.Port`.
	Port *float64 `json:"port"`
	// `CfnOptionGroup.OptionConfigurationProperty.VpcSecurityGroupMemberships`.
	VpcSecurityGroupMemberships *[]*string `json:"vpcSecurityGroupMemberships"`
}

TODO: EXAMPLE

type CfnOptionGroup_OptionSettingProperty

type CfnOptionGroup_OptionSettingProperty struct {
	// `CfnOptionGroup.OptionSettingProperty.Name`.
	Name *string `json:"name"`
	// `CfnOptionGroup.OptionSettingProperty.Value`.
	Value *string `json:"value"`
}

TODO: EXAMPLE

type ClusterEngineBindOptions

type ClusterEngineBindOptions struct {
	// The customer-provided ParameterGroup.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// The role used for S3 exporting.
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// The role used for S3 importing.
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
}

The extra options passed to the {@link IClusterEngine.bindToCluster} method.

TODO: EXAMPLE

Experimental.

type ClusterEngineConfig

type ClusterEngineConfig struct {
	// Features supported by the database engine.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html
	//
	// Experimental.
	Features *ClusterEngineFeatures `json:"features"`
	// The ParameterGroup to use for the cluster.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// The port to use for this cluster, unless the customer specified the port directly.
	// Experimental.
	Port *float64 `json:"port"`
}

The type returned from the {@link IClusterEngine.bindToCluster} method.

TODO: EXAMPLE

Experimental.

type ClusterEngineFeatures

type ClusterEngineFeatures struct {
	// Feature name for the DB instance that the IAM role to export to S3 bucket is to be associated with.
	// Experimental.
	S3Export *string `json:"s3Export"`
	// Feature name for the DB instance that the IAM role to access the S3 bucket for import is to be associated with.
	// Experimental.
	S3Import *string `json:"s3Import"`
}

Represents Database Engine features.

TODO: EXAMPLE

Experimental.

type Credentials

type Credentials interface {
	EncryptionKey() awskms.IKey
	ExcludeCharacters() *string
	Password() awscdk.SecretValue
	ReplicaRegions() *[]*awssecretsmanager.ReplicaRegion
	Secret() awssecretsmanager.ISecret
	SecretName() *string
	Username() *string
	UsernameAsString() *bool
}

Username and password combination.

TODO: EXAMPLE

Experimental.

func Credentials_FromGeneratedSecret

func Credentials_FromGeneratedSecret(username *string, options *CredentialsBaseOptions) Credentials

Creates Credentials with a password generated and stored in Secrets Manager. Experimental.

func Credentials_FromPassword

func Credentials_FromPassword(username *string, password awscdk.SecretValue) Credentials

Creates Credentials from a password.

Do not put passwords in your CDK code directly. Experimental.

func Credentials_FromSecret

func Credentials_FromSecret(secret awssecretsmanager.ISecret, username *string) Credentials

Creates Credentials from an existing Secrets Manager “Secret“ (or “DatabaseSecret“).

The Secret must be a JSON string with a “username“ and “password“ field: ```

{
   ...
   "username": <required: username>,
   "password": <required: password>,
}

``` Experimental.

func Credentials_FromUsername

func Credentials_FromUsername(username *string, options *CredentialsFromUsernameOptions) Credentials

Creates Credentials for the given username, and optional password and key.

If no password is provided, one will be generated and stored in Secrets Manager. Experimental.

type CredentialsBaseOptions

type CredentialsBaseOptions struct {
	// KMS encryption key to encrypt the generated secret.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// The characters to exclude from the generated password.
	//
	// Has no effect if {@link password} has been provided.
	// Experimental.
	ExcludeCharacters *string `json:"excludeCharacters"`
	// A list of regions where to replicate this secret.
	// Experimental.
	ReplicaRegions *[]*awssecretsmanager.ReplicaRegion `json:"replicaRegions"`
	// The name of the secret.
	// Experimental.
	SecretName *string `json:"secretName"`
}

Base options for creating Credentials.

TODO: EXAMPLE

Experimental.

type CredentialsFromUsernameOptions

type CredentialsFromUsernameOptions struct {
	// KMS encryption key to encrypt the generated secret.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// The characters to exclude from the generated password.
	//
	// Has no effect if {@link password} has been provided.
	// Experimental.
	ExcludeCharacters *string `json:"excludeCharacters"`
	// A list of regions where to replicate this secret.
	// Experimental.
	ReplicaRegions *[]*awssecretsmanager.ReplicaRegion `json:"replicaRegions"`
	// The name of the secret.
	// Experimental.
	SecretName *string `json:"secretName"`
	// Password.
	//
	// Do not put passwords in your CDK code directly.
	// Experimental.
	Password awscdk.SecretValue `json:"password"`
}

Options for creating Credentials from a username.

TODO: EXAMPLE

Experimental.

type DatabaseCluster

type DatabaseCluster interface {
	DatabaseClusterBase
	ClusterEndpoint() Endpoint
	ClusterIdentifier() *string
	ClusterReadEndpoint() Endpoint
	Connections() awsec2.Connections
	Engine() IClusterEngine
	Env() *awscdk.ResourceEnvironment
	InstanceEndpoints() *[]Endpoint
	InstanceIdentifiers() *[]*string
	NewCfnProps() *CfnDBClusterProps
	Node() constructs.Node
	PhysicalName() *string
	Secret() awssecretsmanager.ISecret
	SecurityGroups() *[]awsec2.ISecurityGroup
	Stack() awscdk.Stack
	SubnetGroup() ISubnetGroup
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	AddRotationMultiUser(id *string, options *RotationMultiUserOptions) awssecretsmanager.SecretRotation
	AddRotationSingleUser(options *RotationSingleUserOptions) awssecretsmanager.SecretRotation
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDeadlocks(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricEngineUptime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeLocalStorage(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkReceiveThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkTransmitThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricSnapshotStorageUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricTotalBackupStorageBilled(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeBytesUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeReadIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeWriteIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

Create a clustered database with a given number of instances.

TODO: EXAMPLE

Experimental.

func NewDatabaseCluster

func NewDatabaseCluster(scope constructs.Construct, id *string, props *DatabaseClusterProps) DatabaseCluster

Experimental.

type DatabaseClusterAttributes

type DatabaseClusterAttributes struct {
	// Cluster endpoint address.
	// Experimental.
	ClusterEndpointAddress *string `json:"clusterEndpointAddress"`
	// Identifier for the cluster.
	// Experimental.
	ClusterIdentifier *string `json:"clusterIdentifier"`
	// The engine of the existing Cluster.
	// Experimental.
	Engine IClusterEngine `json:"engine"`
	// Endpoint addresses of individual instances.
	// Experimental.
	InstanceEndpointAddresses *[]*string `json:"instanceEndpointAddresses"`
	// Identifier for the instances.
	// Experimental.
	InstanceIdentifiers *[]*string `json:"instanceIdentifiers"`
	// The database port.
	// Experimental.
	Port *float64 `json:"port"`
	// Reader endpoint address.
	// Experimental.
	ReaderEndpointAddress *string `json:"readerEndpointAddress"`
	// The security groups of the database cluster.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
}

Properties that describe an existing cluster instance.

TODO: EXAMPLE

Experimental.

type DatabaseClusterBase

type DatabaseClusterBase interface {
	awscdk.Resource
	IDatabaseCluster
	ClusterEndpoint() Endpoint
	ClusterIdentifier() *string
	ClusterReadEndpoint() Endpoint
	Connections() awsec2.Connections
	Engine() IClusterEngine
	Env() *awscdk.ResourceEnvironment
	InstanceEndpoints() *[]Endpoint
	InstanceIdentifiers() *[]*string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDeadlocks(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricEngineUptime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeLocalStorage(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkReceiveThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkTransmitThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricSnapshotStorageUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricTotalBackupStorageBilled(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeBytesUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeReadIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeWriteIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

A new or imported clustered database. Experimental.

type DatabaseClusterEngine

type DatabaseClusterEngine interface {
}

A database cluster engine.

Provides mapping to the serverless application used for secret rotation.

TODO: EXAMPLE

Experimental.

func NewDatabaseClusterEngine

func NewDatabaseClusterEngine() DatabaseClusterEngine

Experimental.

type DatabaseClusterFromSnapshot

type DatabaseClusterFromSnapshot interface {
	DatabaseClusterBase
	ClusterEndpoint() Endpoint
	ClusterIdentifier() *string
	ClusterReadEndpoint() Endpoint
	Connections() awsec2.Connections
	Engine() IClusterEngine
	Env() *awscdk.ResourceEnvironment
	InstanceEndpoints() *[]Endpoint
	InstanceIdentifiers() *[]*string
	NewCfnProps() *CfnDBClusterProps
	Node() constructs.Node
	PhysicalName() *string
	SecurityGroups() *[]awsec2.ISecurityGroup
	Stack() awscdk.Stack
	SubnetGroup() ISubnetGroup
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDeadlocks(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricEngineUptime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeLocalStorage(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkReceiveThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricNetworkTransmitThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricSnapshotStorageUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricTotalBackupStorageBilled(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeBytesUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeReadIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricVolumeWriteIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

A database cluster restored from a snapshot.

TODO: EXAMPLE

Experimental.

func NewDatabaseClusterFromSnapshot

func NewDatabaseClusterFromSnapshot(scope constructs.Construct, id *string, props *DatabaseClusterFromSnapshotProps) DatabaseClusterFromSnapshot

Experimental.

type DatabaseClusterFromSnapshotProps

type DatabaseClusterFromSnapshotProps struct {
	// What kind of database to start.
	// Experimental.
	Engine IClusterEngine `json:"engine"`
	// Settings for the individual instances that are launched.
	// Experimental.
	InstanceProps *InstanceProps `json:"instanceProps"`
	// The identifier for the DB instance snapshot or DB cluster snapshot to restore from.
	//
	// You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot.
	// However, you can use only the ARN to specify a DB instance snapshot.
	// Experimental.
	SnapshotIdentifier *string `json:"snapshotIdentifier"`
	// The number of seconds to set a cluster's target backtrack window to.
	//
	// This feature is only supported by the Aurora MySQL database engine and
	// cannot be enabled on existing clusters.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html
	//
	// Experimental.
	BacktrackWindow awscdk.Duration `json:"backtrackWindow"`
	// Backup settings.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
	//
	// Experimental.
	Backup *BackupProps `json:"backup"`
	// The list of log types that need to be enabled for exporting to CloudWatch Logs.
	// Experimental.
	CloudwatchLogsExports *[]*string `json:"cloudwatchLogsExports"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `Infinity`.
	// Experimental.
	CloudwatchLogsRetention awslogs.RetentionDays `json:"cloudwatchLogsRetention"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	CloudwatchLogsRetentionRole awsiam.IRole `json:"cloudwatchLogsRetentionRole"`
	// An optional identifier for the cluster.
	// Experimental.
	ClusterIdentifier *string `json:"clusterIdentifier"`
	// Name of a database which is automatically created inside the cluster.
	// Experimental.
	DefaultDatabaseName *string `json:"defaultDatabaseName"`
	// Indicates whether the DB cluster should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
	// Experimental.
	IamAuthentication *bool `json:"iamAuthentication"`
	// Base identifier for instances.
	//
	// Every replica is named by appending the replica number to this string, 1-based.
	// Experimental.
	InstanceIdentifierBase *string `json:"instanceIdentifierBase"`
	// How many replicas/instances to create.
	//
	// Has to be at least 1.
	// Experimental.
	Instances *float64 `json:"instances"`
	// The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
	// Experimental.
	MonitoringInterval awscdk.Duration `json:"monitoringInterval"`
	// Role that will be used to manage DB instances monitoring.
	// Experimental.
	MonitoringRole awsiam.IRole `json:"monitoringRole"`
	// Additional parameters to pass to the database engine.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// What port to listen on.
	// Experimental.
	Port *float64 `json:"port"`
	// A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
	//
	// Example: 'Sun:23:45-Mon:00:15'
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
	//
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ExportRole` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html
	//
	// Experimental.
	S3ExportBuckets *[]awss3.IBucket `json:"s3ExportBuckets"`
	// Role that will be associated with this DB cluster to enable S3 export.
	//
	// This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ExportBuckets` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html
	//
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ImportRole` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html
	//
	// Experimental.
	S3ImportBuckets *[]awss3.IBucket `json:"s3ImportBuckets"`
	// Role that will be associated with this DB cluster to enable S3 import.
	//
	// This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ImportBuckets` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html
	//
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// Existing subnet group for the cluster.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
}

Properties for “DatabaseClusterFromSnapshot“.

TODO: EXAMPLE

Experimental.

type DatabaseClusterProps

type DatabaseClusterProps struct {
	// What kind of database to start.
	// Experimental.
	Engine IClusterEngine `json:"engine"`
	// Settings for the individual instances that are launched.
	// Experimental.
	InstanceProps *InstanceProps `json:"instanceProps"`
	// The number of seconds to set a cluster's target backtrack window to.
	//
	// This feature is only supported by the Aurora MySQL database engine and
	// cannot be enabled on existing clusters.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html
	//
	// Experimental.
	BacktrackWindow awscdk.Duration `json:"backtrackWindow"`
	// Backup settings.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
	//
	// Experimental.
	Backup *BackupProps `json:"backup"`
	// The list of log types that need to be enabled for exporting to CloudWatch Logs.
	// Experimental.
	CloudwatchLogsExports *[]*string `json:"cloudwatchLogsExports"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `Infinity`.
	// Experimental.
	CloudwatchLogsRetention awslogs.RetentionDays `json:"cloudwatchLogsRetention"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	CloudwatchLogsRetentionRole awsiam.IRole `json:"cloudwatchLogsRetentionRole"`
	// An optional identifier for the cluster.
	// Experimental.
	ClusterIdentifier *string `json:"clusterIdentifier"`
	// Whether to copy tags to the snapshot when a snapshot is created.
	// Experimental.
	CopyTagsToSnapshot *bool `json:"copyTagsToSnapshot"`
	// Credentials for the administrative user.
	// Experimental.
	Credentials Credentials `json:"credentials"`
	// Name of a database which is automatically created inside the cluster.
	// Experimental.
	DefaultDatabaseName *string `json:"defaultDatabaseName"`
	// Indicates whether the DB cluster should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
	// Experimental.
	IamAuthentication *bool `json:"iamAuthentication"`
	// Base identifier for instances.
	//
	// Every replica is named by appending the replica number to this string, 1-based.
	// Experimental.
	InstanceIdentifierBase *string `json:"instanceIdentifierBase"`
	// How many replicas/instances to create.
	//
	// Has to be at least 1.
	// Experimental.
	Instances *float64 `json:"instances"`
	// The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
	// Experimental.
	MonitoringInterval awscdk.Duration `json:"monitoringInterval"`
	// Role that will be used to manage DB instances monitoring.
	// Experimental.
	MonitoringRole awsiam.IRole `json:"monitoringRole"`
	// Additional parameters to pass to the database engine.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// What port to listen on.
	// Experimental.
	Port *float64 `json:"port"`
	// A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
	//
	// Example: 'Sun:23:45-Mon:00:15'
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
	//
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ExportRole` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html
	//
	// Experimental.
	S3ExportBuckets *[]awss3.IBucket `json:"s3ExportBuckets"`
	// Role that will be associated with this DB cluster to enable S3 export.
	//
	// This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ExportBuckets` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html
	//
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ImportRole` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html
	//
	// Experimental.
	S3ImportBuckets *[]awss3.IBucket `json:"s3ImportBuckets"`
	// Role that will be associated with this DB cluster to enable S3 import.
	//
	// This feature is only supported by the Aurora database engine.
	//
	// This property must not be used if `s3ImportBuckets` is used.
	//
	// For MySQL:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html
	//
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// Whether to enable storage encryption.
	// Experimental.
	StorageEncrypted *bool `json:"storageEncrypted"`
	// The KMS key for storage encryption.
	//
	// If specified, {@link storageEncrypted} will be set to `true`.
	// Experimental.
	StorageEncryptionKey awskms.IKey `json:"storageEncryptionKey"`
	// Existing subnet group for the cluster.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
}

Properties for a new database cluster.

TODO: EXAMPLE

Experimental.

type DatabaseInstance

type DatabaseInstance interface {
	DatabaseInstanceBase
	IDatabaseInstance
	Connections() awsec2.Connections
	DbInstanceEndpointAddress() *string
	DbInstanceEndpointPort() *string
	EnableIamAuthentication() *bool
	SetEnableIamAuthentication(val *bool)
	Engine() IInstanceEngine
	Env() *awscdk.ResourceEnvironment
	InstanceArn() *string
	InstanceEndpoint() Endpoint
	InstanceIdentifier() *string
	InstanceType() awsec2.InstanceType
	NewCfnProps() *CfnDBInstanceProps
	Node() constructs.Node
	PhysicalName() *string
	Secret() awssecretsmanager.ISecret
	SourceCfnProps() *CfnDBInstanceProps
	Stack() awscdk.Stack
	Vpc() awsec2.IVpc
	VpcPlacement() *awsec2.SubnetSelection
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	AddRotationMultiUser(id *string, options *RotationMultiUserOptions) awssecretsmanager.SecretRotation
	AddRotationSingleUser(options *RotationSingleUserOptions) awssecretsmanager.SecretRotation
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantConnect(grantee awsiam.IGrantable) awsiam.Grant
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeStorageSpace(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricReadIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricWriteIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	SetLogRetention()
	ToString() *string
}

A database instance.

TODO: EXAMPLE

Experimental.

func NewDatabaseInstance

func NewDatabaseInstance(scope constructs.Construct, id *string, props *DatabaseInstanceProps) DatabaseInstance

Experimental.

type DatabaseInstanceAttributes

type DatabaseInstanceAttributes struct {
	// The engine of the existing database Instance.
	// Experimental.
	Engine IInstanceEngine `json:"engine"`
	// The endpoint address.
	// Experimental.
	InstanceEndpointAddress *string `json:"instanceEndpointAddress"`
	// The instance identifier.
	// Experimental.
	InstanceIdentifier *string `json:"instanceIdentifier"`
	// The database port.
	// Experimental.
	Port *float64 `json:"port"`
	// The security groups of the instance.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
}

Properties that describe an existing instance.

TODO: EXAMPLE

Experimental.

type DatabaseInstanceBase

type DatabaseInstanceBase interface {
	awscdk.Resource
	IDatabaseInstance
	Connections() awsec2.Connections
	DbInstanceEndpointAddress() *string
	DbInstanceEndpointPort() *string
	EnableIamAuthentication() *bool
	SetEnableIamAuthentication(val *bool)
	Engine() IInstanceEngine
	Env() *awscdk.ResourceEnvironment
	InstanceArn() *string
	InstanceEndpoint() Endpoint
	InstanceIdentifier() *string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantConnect(grantee awsiam.IGrantable) awsiam.Grant
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeStorageSpace(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricReadIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricWriteIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	ToString() *string
}

A new or imported database instance.

TODO: EXAMPLE

Experimental.

type DatabaseInstanceEngine

type DatabaseInstanceEngine interface {
}

A database instance engine.

Provides mapping to DatabaseEngine used for secret rotation.

TODO: EXAMPLE

Experimental.

func NewDatabaseInstanceEngine

func NewDatabaseInstanceEngine() DatabaseInstanceEngine

Experimental.

type DatabaseInstanceFromSnapshot

type DatabaseInstanceFromSnapshot interface {
	DatabaseInstanceBase
	IDatabaseInstance
	Connections() awsec2.Connections
	DbInstanceEndpointAddress() *string
	DbInstanceEndpointPort() *string
	EnableIamAuthentication() *bool
	SetEnableIamAuthentication(val *bool)
	Engine() IInstanceEngine
	Env() *awscdk.ResourceEnvironment
	InstanceArn() *string
	InstanceEndpoint() Endpoint
	InstanceIdentifier() *string
	InstanceType() awsec2.InstanceType
	NewCfnProps() *CfnDBInstanceProps
	Node() constructs.Node
	PhysicalName() *string
	Secret() awssecretsmanager.ISecret
	SourceCfnProps() *CfnDBInstanceProps
	Stack() awscdk.Stack
	Vpc() awsec2.IVpc
	VpcPlacement() *awsec2.SubnetSelection
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	AddRotationMultiUser(id *string, options *RotationMultiUserOptions) awssecretsmanager.SecretRotation
	AddRotationSingleUser(options *RotationSingleUserOptions) awssecretsmanager.SecretRotation
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantConnect(grantee awsiam.IGrantable) awsiam.Grant
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeStorageSpace(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricReadIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricWriteIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	SetLogRetention()
	ToString() *string
}

A database instance restored from a snapshot.

TODO: EXAMPLE

Experimental.

func NewDatabaseInstanceFromSnapshot

func NewDatabaseInstanceFromSnapshot(scope constructs.Construct, id *string, props *DatabaseInstanceFromSnapshotProps) DatabaseInstanceFromSnapshot

Experimental.

type DatabaseInstanceFromSnapshotProps

type DatabaseInstanceFromSnapshotProps struct {
	// Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
	// Experimental.
	AutoMinorVersionUpgrade *bool `json:"autoMinorVersionUpgrade"`
	// The name of the Availability Zone where the DB instance will be located.
	// Experimental.
	AvailabilityZone *string `json:"availabilityZone"`
	// The number of days during which automatic DB snapshots are retained.
	//
	// Set to zero to disable backups.
	// When creating a read replica, you must enable automatic backups on the source
	// database instance by setting the backup retention to a value other than zero.
	// Experimental.
	BackupRetention awscdk.Duration `json:"backupRetention"`
	// The list of log types that need to be enabled for exporting to CloudWatch Logs.
	// Experimental.
	CloudwatchLogsExports *[]*string `json:"cloudwatchLogsExports"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `Infinity`.
	// Experimental.
	CloudwatchLogsRetention awslogs.RetentionDays `json:"cloudwatchLogsRetention"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	CloudwatchLogsRetentionRole awsiam.IRole `json:"cloudwatchLogsRetentionRole"`
	// Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
	// Experimental.
	CopyTagsToSnapshot *bool `json:"copyTagsToSnapshot"`
	// Indicates whether automated backups should be deleted or retained when you delete a DB instance.
	// Experimental.
	DeleteAutomatedBackups *bool `json:"deleteAutomatedBackups"`
	// Indicates whether the DB instance should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// The Active Directory directory ID to create the DB instance in.
	// Experimental.
	Domain *string `json:"domain"`
	// The IAM role to be used when making API calls to the Directory Service.
	//
	// The role needs the AWS-managed policy
	// AmazonRDSDirectoryServiceAccess or equivalent.
	// Experimental.
	DomainRole awsiam.IRole `json:"domainRole"`
	// Whether to enable Performance Insights for the DB instance.
	// Experimental.
	EnablePerformanceInsights *bool `json:"enablePerformanceInsights"`
	// Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
	// Experimental.
	IamAuthentication *bool `json:"iamAuthentication"`
	// A name for the DB instance.
	//
	// If you specify a name, AWS CloudFormation
	// converts it to lowercase.
	// Experimental.
	InstanceIdentifier *string `json:"instanceIdentifier"`
	// The number of I/O operations per second (IOPS) that the database provisions.
	//
	// The value must be equal to or greater than 1000.
	// Experimental.
	Iops *float64 `json:"iops"`
	// Upper limit to which RDS can scale the storage in GiB(Gibibyte).
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
	//
	// Experimental.
	MaxAllocatedStorage *float64 `json:"maxAllocatedStorage"`
	// The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
	// Experimental.
	MonitoringInterval awscdk.Duration `json:"monitoringInterval"`
	// Role that will be used to manage DB instance monitoring.
	// Experimental.
	MonitoringRole awsiam.IRole `json:"monitoringRole"`
	// Specifies if the database instance is a multiple Availability Zone deployment.
	// Experimental.
	MultiAz *bool `json:"multiAz"`
	// The option group to associate with the instance.
	// Experimental.
	OptionGroup IOptionGroup `json:"optionGroup"`
	// The AWS KMS key for encryption of Performance Insights data.
	// Experimental.
	PerformanceInsightEncryptionKey awskms.IKey `json:"performanceInsightEncryptionKey"`
	// The amount of time, in days, to retain Performance Insights data.
	// Experimental.
	PerformanceInsightRetention PerformanceInsightRetention `json:"performanceInsightRetention"`
	// The port for the instance.
	// Experimental.
	Port *float64 `json:"port"`
	// The daily time range during which automated backups are performed.
	//
	// Constraints:
	// - Must be in the format `hh24:mi-hh24:mi`.
	// - Must be in Universal Coordinated Time (UTC).
	// - Must not conflict with the preferred maintenance window.
	// - Must be at least 30 minutes.
	// Experimental.
	PreferredBackupWindow *string `json:"preferredBackupWindow"`
	// The weekly time range (in UTC) during which system maintenance can occur.
	//
	// Format: `ddd:hh24:mi-ddd:hh24:mi`
	// Constraint: Minimum 30-minute window
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// The number of CPU cores and the number of threads per core.
	// Experimental.
	ProcessorFeatures *ProcessorFeatures `json:"processorFeatures"`
	// Indicates whether the DB instance is an internet-facing instance.
	// Experimental.
	PubliclyAccessible *bool `json:"publiclyAccessible"`
	// The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// S3 buckets that you want to load data into.
	//
	// This property must not be used if `s3ExportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportBuckets *[]awss3.IBucket `json:"s3ExportBuckets"`
	// Role that will be associated with this DB instance to enable S3 export.
	//
	// This property must not be used if `s3ExportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// S3 buckets that you want to load data from.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportBuckets *[]awss3.IBucket `json:"s3ImportBuckets"`
	// Role that will be associated with this DB instance to enable S3 import.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// The security groups to assign to the DB instance.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// The storage type.
	//
	// Storage types supported are gp2, io1, standard.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD
	//
	// Experimental.
	StorageType StorageType `json:"storageType"`
	// Existing subnet group for the instance.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
	// The VPC network where the DB subnet group should be created.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The type of subnets to add to the created DB subnet group.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
	// The allocated storage size, specified in gigabytes (GB).
	// Experimental.
	AllocatedStorage *float64 `json:"allocatedStorage"`
	// Whether to allow major version upgrades.
	// Experimental.
	AllowMajorVersionUpgrade *bool `json:"allowMajorVersionUpgrade"`
	// The name of the database.
	// Experimental.
	DatabaseName *string `json:"databaseName"`
	// The database engine.
	// Experimental.
	Engine IInstanceEngine `json:"engine"`
	// The name of the compute and memory capacity for the instance.
	// Experimental.
	InstanceType awsec2.InstanceType `json:"instanceType"`
	// The license model.
	// Experimental.
	LicenseModel LicenseModel `json:"licenseModel"`
	// The DB parameter group to associate with the instance.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// The time zone of the instance.
	//
	// This is currently supported only by Microsoft Sql Server.
	// Experimental.
	Timezone *string `json:"timezone"`
	// The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
	//
	// If you're restoring from a shared manual DB
	// snapshot, you must specify the ARN of the snapshot.
	// Experimental.
	SnapshotIdentifier *string `json:"snapshotIdentifier"`
	// Master user credentials.
	//
	// Note - It is not possible to change the master username for a snapshot;
	// however, it is possible to provide (or generate) a new password.
	// Experimental.
	Credentials SnapshotCredentials `json:"credentials"`
}

Construction properties for a DatabaseInstanceFromSnapshot.

TODO: EXAMPLE

Experimental.

type DatabaseInstanceNewProps

type DatabaseInstanceNewProps struct {
	// Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
	// Experimental.
	AutoMinorVersionUpgrade *bool `json:"autoMinorVersionUpgrade"`
	// The name of the Availability Zone where the DB instance will be located.
	// Experimental.
	AvailabilityZone *string `json:"availabilityZone"`
	// The number of days during which automatic DB snapshots are retained.
	//
	// Set to zero to disable backups.
	// When creating a read replica, you must enable automatic backups on the source
	// database instance by setting the backup retention to a value other than zero.
	// Experimental.
	BackupRetention awscdk.Duration `json:"backupRetention"`
	// The list of log types that need to be enabled for exporting to CloudWatch Logs.
	// Experimental.
	CloudwatchLogsExports *[]*string `json:"cloudwatchLogsExports"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `Infinity`.
	// Experimental.
	CloudwatchLogsRetention awslogs.RetentionDays `json:"cloudwatchLogsRetention"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	CloudwatchLogsRetentionRole awsiam.IRole `json:"cloudwatchLogsRetentionRole"`
	// Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
	// Experimental.
	CopyTagsToSnapshot *bool `json:"copyTagsToSnapshot"`
	// Indicates whether automated backups should be deleted or retained when you delete a DB instance.
	// Experimental.
	DeleteAutomatedBackups *bool `json:"deleteAutomatedBackups"`
	// Indicates whether the DB instance should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// The Active Directory directory ID to create the DB instance in.
	// Experimental.
	Domain *string `json:"domain"`
	// The IAM role to be used when making API calls to the Directory Service.
	//
	// The role needs the AWS-managed policy
	// AmazonRDSDirectoryServiceAccess or equivalent.
	// Experimental.
	DomainRole awsiam.IRole `json:"domainRole"`
	// Whether to enable Performance Insights for the DB instance.
	// Experimental.
	EnablePerformanceInsights *bool `json:"enablePerformanceInsights"`
	// Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
	// Experimental.
	IamAuthentication *bool `json:"iamAuthentication"`
	// A name for the DB instance.
	//
	// If you specify a name, AWS CloudFormation
	// converts it to lowercase.
	// Experimental.
	InstanceIdentifier *string `json:"instanceIdentifier"`
	// The number of I/O operations per second (IOPS) that the database provisions.
	//
	// The value must be equal to or greater than 1000.
	// Experimental.
	Iops *float64 `json:"iops"`
	// Upper limit to which RDS can scale the storage in GiB(Gibibyte).
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
	//
	// Experimental.
	MaxAllocatedStorage *float64 `json:"maxAllocatedStorage"`
	// The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
	// Experimental.
	MonitoringInterval awscdk.Duration `json:"monitoringInterval"`
	// Role that will be used to manage DB instance monitoring.
	// Experimental.
	MonitoringRole awsiam.IRole `json:"monitoringRole"`
	// Specifies if the database instance is a multiple Availability Zone deployment.
	// Experimental.
	MultiAz *bool `json:"multiAz"`
	// The option group to associate with the instance.
	// Experimental.
	OptionGroup IOptionGroup `json:"optionGroup"`
	// The AWS KMS key for encryption of Performance Insights data.
	// Experimental.
	PerformanceInsightEncryptionKey awskms.IKey `json:"performanceInsightEncryptionKey"`
	// The amount of time, in days, to retain Performance Insights data.
	// Experimental.
	PerformanceInsightRetention PerformanceInsightRetention `json:"performanceInsightRetention"`
	// The port for the instance.
	// Experimental.
	Port *float64 `json:"port"`
	// The daily time range during which automated backups are performed.
	//
	// Constraints:
	// - Must be in the format `hh24:mi-hh24:mi`.
	// - Must be in Universal Coordinated Time (UTC).
	// - Must not conflict with the preferred maintenance window.
	// - Must be at least 30 minutes.
	// Experimental.
	PreferredBackupWindow *string `json:"preferredBackupWindow"`
	// The weekly time range (in UTC) during which system maintenance can occur.
	//
	// Format: `ddd:hh24:mi-ddd:hh24:mi`
	// Constraint: Minimum 30-minute window
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// The number of CPU cores and the number of threads per core.
	// Experimental.
	ProcessorFeatures *ProcessorFeatures `json:"processorFeatures"`
	// Indicates whether the DB instance is an internet-facing instance.
	// Experimental.
	PubliclyAccessible *bool `json:"publiclyAccessible"`
	// The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// S3 buckets that you want to load data into.
	//
	// This property must not be used if `s3ExportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportBuckets *[]awss3.IBucket `json:"s3ExportBuckets"`
	// Role that will be associated with this DB instance to enable S3 export.
	//
	// This property must not be used if `s3ExportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// S3 buckets that you want to load data from.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportBuckets *[]awss3.IBucket `json:"s3ImportBuckets"`
	// Role that will be associated with this DB instance to enable S3 import.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// The security groups to assign to the DB instance.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// The storage type.
	//
	// Storage types supported are gp2, io1, standard.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD
	//
	// Experimental.
	StorageType StorageType `json:"storageType"`
	// Existing subnet group for the instance.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
	// The VPC network where the DB subnet group should be created.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The type of subnets to add to the created DB subnet group.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Construction properties for a DatabaseInstanceNew.

TODO: EXAMPLE

Experimental.

type DatabaseInstanceProps

type DatabaseInstanceProps struct {
	// Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
	// Experimental.
	AutoMinorVersionUpgrade *bool `json:"autoMinorVersionUpgrade"`
	// The name of the Availability Zone where the DB instance will be located.
	// Experimental.
	AvailabilityZone *string `json:"availabilityZone"`
	// The number of days during which automatic DB snapshots are retained.
	//
	// Set to zero to disable backups.
	// When creating a read replica, you must enable automatic backups on the source
	// database instance by setting the backup retention to a value other than zero.
	// Experimental.
	BackupRetention awscdk.Duration `json:"backupRetention"`
	// The list of log types that need to be enabled for exporting to CloudWatch Logs.
	// Experimental.
	CloudwatchLogsExports *[]*string `json:"cloudwatchLogsExports"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `Infinity`.
	// Experimental.
	CloudwatchLogsRetention awslogs.RetentionDays `json:"cloudwatchLogsRetention"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	CloudwatchLogsRetentionRole awsiam.IRole `json:"cloudwatchLogsRetentionRole"`
	// Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
	// Experimental.
	CopyTagsToSnapshot *bool `json:"copyTagsToSnapshot"`
	// Indicates whether automated backups should be deleted or retained when you delete a DB instance.
	// Experimental.
	DeleteAutomatedBackups *bool `json:"deleteAutomatedBackups"`
	// Indicates whether the DB instance should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// The Active Directory directory ID to create the DB instance in.
	// Experimental.
	Domain *string `json:"domain"`
	// The IAM role to be used when making API calls to the Directory Service.
	//
	// The role needs the AWS-managed policy
	// AmazonRDSDirectoryServiceAccess or equivalent.
	// Experimental.
	DomainRole awsiam.IRole `json:"domainRole"`
	// Whether to enable Performance Insights for the DB instance.
	// Experimental.
	EnablePerformanceInsights *bool `json:"enablePerformanceInsights"`
	// Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
	// Experimental.
	IamAuthentication *bool `json:"iamAuthentication"`
	// A name for the DB instance.
	//
	// If you specify a name, AWS CloudFormation
	// converts it to lowercase.
	// Experimental.
	InstanceIdentifier *string `json:"instanceIdentifier"`
	// The number of I/O operations per second (IOPS) that the database provisions.
	//
	// The value must be equal to or greater than 1000.
	// Experimental.
	Iops *float64 `json:"iops"`
	// Upper limit to which RDS can scale the storage in GiB(Gibibyte).
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
	//
	// Experimental.
	MaxAllocatedStorage *float64 `json:"maxAllocatedStorage"`
	// The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
	// Experimental.
	MonitoringInterval awscdk.Duration `json:"monitoringInterval"`
	// Role that will be used to manage DB instance monitoring.
	// Experimental.
	MonitoringRole awsiam.IRole `json:"monitoringRole"`
	// Specifies if the database instance is a multiple Availability Zone deployment.
	// Experimental.
	MultiAz *bool `json:"multiAz"`
	// The option group to associate with the instance.
	// Experimental.
	OptionGroup IOptionGroup `json:"optionGroup"`
	// The AWS KMS key for encryption of Performance Insights data.
	// Experimental.
	PerformanceInsightEncryptionKey awskms.IKey `json:"performanceInsightEncryptionKey"`
	// The amount of time, in days, to retain Performance Insights data.
	// Experimental.
	PerformanceInsightRetention PerformanceInsightRetention `json:"performanceInsightRetention"`
	// The port for the instance.
	// Experimental.
	Port *float64 `json:"port"`
	// The daily time range during which automated backups are performed.
	//
	// Constraints:
	// - Must be in the format `hh24:mi-hh24:mi`.
	// - Must be in Universal Coordinated Time (UTC).
	// - Must not conflict with the preferred maintenance window.
	// - Must be at least 30 minutes.
	// Experimental.
	PreferredBackupWindow *string `json:"preferredBackupWindow"`
	// The weekly time range (in UTC) during which system maintenance can occur.
	//
	// Format: `ddd:hh24:mi-ddd:hh24:mi`
	// Constraint: Minimum 30-minute window
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// The number of CPU cores and the number of threads per core.
	// Experimental.
	ProcessorFeatures *ProcessorFeatures `json:"processorFeatures"`
	// Indicates whether the DB instance is an internet-facing instance.
	// Experimental.
	PubliclyAccessible *bool `json:"publiclyAccessible"`
	// The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// S3 buckets that you want to load data into.
	//
	// This property must not be used if `s3ExportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportBuckets *[]awss3.IBucket `json:"s3ExportBuckets"`
	// Role that will be associated with this DB instance to enable S3 export.
	//
	// This property must not be used if `s3ExportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// S3 buckets that you want to load data from.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportBuckets *[]awss3.IBucket `json:"s3ImportBuckets"`
	// Role that will be associated with this DB instance to enable S3 import.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// The security groups to assign to the DB instance.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// The storage type.
	//
	// Storage types supported are gp2, io1, standard.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD
	//
	// Experimental.
	StorageType StorageType `json:"storageType"`
	// Existing subnet group for the instance.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
	// The VPC network where the DB subnet group should be created.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The type of subnets to add to the created DB subnet group.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
	// The allocated storage size, specified in gigabytes (GB).
	// Experimental.
	AllocatedStorage *float64 `json:"allocatedStorage"`
	// Whether to allow major version upgrades.
	// Experimental.
	AllowMajorVersionUpgrade *bool `json:"allowMajorVersionUpgrade"`
	// The name of the database.
	// Experimental.
	DatabaseName *string `json:"databaseName"`
	// The database engine.
	// Experimental.
	Engine IInstanceEngine `json:"engine"`
	// The name of the compute and memory capacity for the instance.
	// Experimental.
	InstanceType awsec2.InstanceType `json:"instanceType"`
	// The license model.
	// Experimental.
	LicenseModel LicenseModel `json:"licenseModel"`
	// The DB parameter group to associate with the instance.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// The time zone of the instance.
	//
	// This is currently supported only by Microsoft Sql Server.
	// Experimental.
	Timezone *string `json:"timezone"`
	// For supported engines, specifies the character set to associate with the DB instance.
	// Experimental.
	CharacterSetName *string `json:"characterSetName"`
	// Credentials for the administrative user.
	// Experimental.
	Credentials Credentials `json:"credentials"`
	// Indicates whether the DB instance is encrypted.
	// Experimental.
	StorageEncrypted *bool `json:"storageEncrypted"`
	// The KMS key that's used to encrypt the DB instance.
	// Experimental.
	StorageEncryptionKey awskms.IKey `json:"storageEncryptionKey"`
}

Construction properties for a DatabaseInstance.

TODO: EXAMPLE

Experimental.

type DatabaseInstanceReadReplica

type DatabaseInstanceReadReplica interface {
	DatabaseInstanceBase
	IDatabaseInstance
	Connections() awsec2.Connections
	DbInstanceEndpointAddress() *string
	DbInstanceEndpointPort() *string
	EnableIamAuthentication() *bool
	SetEnableIamAuthentication(val *bool)
	Engine() IInstanceEngine
	Env() *awscdk.ResourceEnvironment
	InstanceArn() *string
	InstanceEndpoint() Endpoint
	InstanceIdentifier() *string
	InstanceType() awsec2.InstanceType
	NewCfnProps() *CfnDBInstanceProps
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	Vpc() awsec2.IVpc
	VpcPlacement() *awsec2.SubnetSelection
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantConnect(grantee awsiam.IGrantable) awsiam.Grant
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricFreeStorageSpace(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricReadIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricWriteIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	SetLogRetention()
	ToString() *string
}

A read replica database instance.

TODO: EXAMPLE

Experimental.

func NewDatabaseInstanceReadReplica

func NewDatabaseInstanceReadReplica(scope constructs.Construct, id *string, props *DatabaseInstanceReadReplicaProps) DatabaseInstanceReadReplica

Experimental.

type DatabaseInstanceReadReplicaProps

type DatabaseInstanceReadReplicaProps struct {
	// Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
	// Experimental.
	AutoMinorVersionUpgrade *bool `json:"autoMinorVersionUpgrade"`
	// The name of the Availability Zone where the DB instance will be located.
	// Experimental.
	AvailabilityZone *string `json:"availabilityZone"`
	// The number of days during which automatic DB snapshots are retained.
	//
	// Set to zero to disable backups.
	// When creating a read replica, you must enable automatic backups on the source
	// database instance by setting the backup retention to a value other than zero.
	// Experimental.
	BackupRetention awscdk.Duration `json:"backupRetention"`
	// The list of log types that need to be enabled for exporting to CloudWatch Logs.
	// Experimental.
	CloudwatchLogsExports *[]*string `json:"cloudwatchLogsExports"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `Infinity`.
	// Experimental.
	CloudwatchLogsRetention awslogs.RetentionDays `json:"cloudwatchLogsRetention"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	CloudwatchLogsRetentionRole awsiam.IRole `json:"cloudwatchLogsRetentionRole"`
	// Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
	// Experimental.
	CopyTagsToSnapshot *bool `json:"copyTagsToSnapshot"`
	// Indicates whether automated backups should be deleted or retained when you delete a DB instance.
	// Experimental.
	DeleteAutomatedBackups *bool `json:"deleteAutomatedBackups"`
	// Indicates whether the DB instance should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// The Active Directory directory ID to create the DB instance in.
	// Experimental.
	Domain *string `json:"domain"`
	// The IAM role to be used when making API calls to the Directory Service.
	//
	// The role needs the AWS-managed policy
	// AmazonRDSDirectoryServiceAccess or equivalent.
	// Experimental.
	DomainRole awsiam.IRole `json:"domainRole"`
	// Whether to enable Performance Insights for the DB instance.
	// Experimental.
	EnablePerformanceInsights *bool `json:"enablePerformanceInsights"`
	// Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
	// Experimental.
	IamAuthentication *bool `json:"iamAuthentication"`
	// A name for the DB instance.
	//
	// If you specify a name, AWS CloudFormation
	// converts it to lowercase.
	// Experimental.
	InstanceIdentifier *string `json:"instanceIdentifier"`
	// The number of I/O operations per second (IOPS) that the database provisions.
	//
	// The value must be equal to or greater than 1000.
	// Experimental.
	Iops *float64 `json:"iops"`
	// Upper limit to which RDS can scale the storage in GiB(Gibibyte).
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
	//
	// Experimental.
	MaxAllocatedStorage *float64 `json:"maxAllocatedStorage"`
	// The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
	// Experimental.
	MonitoringInterval awscdk.Duration `json:"monitoringInterval"`
	// Role that will be used to manage DB instance monitoring.
	// Experimental.
	MonitoringRole awsiam.IRole `json:"monitoringRole"`
	// Specifies if the database instance is a multiple Availability Zone deployment.
	// Experimental.
	MultiAz *bool `json:"multiAz"`
	// The option group to associate with the instance.
	// Experimental.
	OptionGroup IOptionGroup `json:"optionGroup"`
	// The AWS KMS key for encryption of Performance Insights data.
	// Experimental.
	PerformanceInsightEncryptionKey awskms.IKey `json:"performanceInsightEncryptionKey"`
	// The amount of time, in days, to retain Performance Insights data.
	// Experimental.
	PerformanceInsightRetention PerformanceInsightRetention `json:"performanceInsightRetention"`
	// The port for the instance.
	// Experimental.
	Port *float64 `json:"port"`
	// The daily time range during which automated backups are performed.
	//
	// Constraints:
	// - Must be in the format `hh24:mi-hh24:mi`.
	// - Must be in Universal Coordinated Time (UTC).
	// - Must not conflict with the preferred maintenance window.
	// - Must be at least 30 minutes.
	// Experimental.
	PreferredBackupWindow *string `json:"preferredBackupWindow"`
	// The weekly time range (in UTC) during which system maintenance can occur.
	//
	// Format: `ddd:hh24:mi-ddd:hh24:mi`
	// Constraint: Minimum 30-minute window
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// The number of CPU cores and the number of threads per core.
	// Experimental.
	ProcessorFeatures *ProcessorFeatures `json:"processorFeatures"`
	// Indicates whether the DB instance is an internet-facing instance.
	// Experimental.
	PubliclyAccessible *bool `json:"publiclyAccessible"`
	// The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// S3 buckets that you want to load data into.
	//
	// This property must not be used if `s3ExportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportBuckets *[]awss3.IBucket `json:"s3ExportBuckets"`
	// Role that will be associated with this DB instance to enable S3 export.
	//
	// This property must not be used if `s3ExportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// S3 buckets that you want to load data from.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportBuckets *[]awss3.IBucket `json:"s3ImportBuckets"`
	// Role that will be associated with this DB instance to enable S3 import.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// The security groups to assign to the DB instance.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// The storage type.
	//
	// Storage types supported are gp2, io1, standard.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD
	//
	// Experimental.
	StorageType StorageType `json:"storageType"`
	// Existing subnet group for the instance.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
	// The VPC network where the DB subnet group should be created.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The type of subnets to add to the created DB subnet group.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
	// The name of the compute and memory capacity classes.
	// Experimental.
	InstanceType awsec2.InstanceType `json:"instanceType"`
	// The source database instance.
	//
	// Each DB instance can have a limited number of read replicas. For more
	// information, see https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html.
	// Experimental.
	SourceDatabaseInstance IDatabaseInstance `json:"sourceDatabaseInstance"`
	// Indicates whether the DB instance is encrypted.
	// Experimental.
	StorageEncrypted *bool `json:"storageEncrypted"`
	// The KMS key that's used to encrypt the DB instance.
	// Experimental.
	StorageEncryptionKey awskms.IKey `json:"storageEncryptionKey"`
}

Construction properties for a DatabaseInstanceReadReplica.

TODO: EXAMPLE

Experimental.

type DatabaseInstanceSourceProps

type DatabaseInstanceSourceProps struct {
	// Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
	// Experimental.
	AutoMinorVersionUpgrade *bool `json:"autoMinorVersionUpgrade"`
	// The name of the Availability Zone where the DB instance will be located.
	// Experimental.
	AvailabilityZone *string `json:"availabilityZone"`
	// The number of days during which automatic DB snapshots are retained.
	//
	// Set to zero to disable backups.
	// When creating a read replica, you must enable automatic backups on the source
	// database instance by setting the backup retention to a value other than zero.
	// Experimental.
	BackupRetention awscdk.Duration `json:"backupRetention"`
	// The list of log types that need to be enabled for exporting to CloudWatch Logs.
	// Experimental.
	CloudwatchLogsExports *[]*string `json:"cloudwatchLogsExports"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `Infinity`.
	// Experimental.
	CloudwatchLogsRetention awslogs.RetentionDays `json:"cloudwatchLogsRetention"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	CloudwatchLogsRetentionRole awsiam.IRole `json:"cloudwatchLogsRetentionRole"`
	// Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
	// Experimental.
	CopyTagsToSnapshot *bool `json:"copyTagsToSnapshot"`
	// Indicates whether automated backups should be deleted or retained when you delete a DB instance.
	// Experimental.
	DeleteAutomatedBackups *bool `json:"deleteAutomatedBackups"`
	// Indicates whether the DB instance should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// The Active Directory directory ID to create the DB instance in.
	// Experimental.
	Domain *string `json:"domain"`
	// The IAM role to be used when making API calls to the Directory Service.
	//
	// The role needs the AWS-managed policy
	// AmazonRDSDirectoryServiceAccess or equivalent.
	// Experimental.
	DomainRole awsiam.IRole `json:"domainRole"`
	// Whether to enable Performance Insights for the DB instance.
	// Experimental.
	EnablePerformanceInsights *bool `json:"enablePerformanceInsights"`
	// Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
	// Experimental.
	IamAuthentication *bool `json:"iamAuthentication"`
	// A name for the DB instance.
	//
	// If you specify a name, AWS CloudFormation
	// converts it to lowercase.
	// Experimental.
	InstanceIdentifier *string `json:"instanceIdentifier"`
	// The number of I/O operations per second (IOPS) that the database provisions.
	//
	// The value must be equal to or greater than 1000.
	// Experimental.
	Iops *float64 `json:"iops"`
	// Upper limit to which RDS can scale the storage in GiB(Gibibyte).
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
	//
	// Experimental.
	MaxAllocatedStorage *float64 `json:"maxAllocatedStorage"`
	// The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
	// Experimental.
	MonitoringInterval awscdk.Duration `json:"monitoringInterval"`
	// Role that will be used to manage DB instance monitoring.
	// Experimental.
	MonitoringRole awsiam.IRole `json:"monitoringRole"`
	// Specifies if the database instance is a multiple Availability Zone deployment.
	// Experimental.
	MultiAz *bool `json:"multiAz"`
	// The option group to associate with the instance.
	// Experimental.
	OptionGroup IOptionGroup `json:"optionGroup"`
	// The AWS KMS key for encryption of Performance Insights data.
	// Experimental.
	PerformanceInsightEncryptionKey awskms.IKey `json:"performanceInsightEncryptionKey"`
	// The amount of time, in days, to retain Performance Insights data.
	// Experimental.
	PerformanceInsightRetention PerformanceInsightRetention `json:"performanceInsightRetention"`
	// The port for the instance.
	// Experimental.
	Port *float64 `json:"port"`
	// The daily time range during which automated backups are performed.
	//
	// Constraints:
	// - Must be in the format `hh24:mi-hh24:mi`.
	// - Must be in Universal Coordinated Time (UTC).
	// - Must not conflict with the preferred maintenance window.
	// - Must be at least 30 minutes.
	// Experimental.
	PreferredBackupWindow *string `json:"preferredBackupWindow"`
	// The weekly time range (in UTC) during which system maintenance can occur.
	//
	// Format: `ddd:hh24:mi-ddd:hh24:mi`
	// Constraint: Minimum 30-minute window
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// The number of CPU cores and the number of threads per core.
	// Experimental.
	ProcessorFeatures *ProcessorFeatures `json:"processorFeatures"`
	// Indicates whether the DB instance is an internet-facing instance.
	// Experimental.
	PubliclyAccessible *bool `json:"publiclyAccessible"`
	// The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// S3 buckets that you want to load data into.
	//
	// This property must not be used if `s3ExportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportBuckets *[]awss3.IBucket `json:"s3ExportBuckets"`
	// Role that will be associated with this DB instance to enable S3 export.
	//
	// This property must not be used if `s3ExportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
	//
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// S3 buckets that you want to load data from.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportRole` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportBuckets *[]awss3.IBucket `json:"s3ImportBuckets"`
	// Role that will be associated with this DB instance to enable S3 import.
	//
	// This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
	//
	// This property must not be used if `s3ImportBuckets` is used.
	//
	// For Microsoft SQL Server:
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
	//
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// The security groups to assign to the DB instance.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// The storage type.
	//
	// Storage types supported are gp2, io1, standard.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD
	//
	// Experimental.
	StorageType StorageType `json:"storageType"`
	// Existing subnet group for the instance.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
	// The VPC network where the DB subnet group should be created.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The type of subnets to add to the created DB subnet group.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
	// The allocated storage size, specified in gigabytes (GB).
	// Experimental.
	AllocatedStorage *float64 `json:"allocatedStorage"`
	// Whether to allow major version upgrades.
	// Experimental.
	AllowMajorVersionUpgrade *bool `json:"allowMajorVersionUpgrade"`
	// The name of the database.
	// Experimental.
	DatabaseName *string `json:"databaseName"`
	// The database engine.
	// Experimental.
	Engine IInstanceEngine `json:"engine"`
	// The name of the compute and memory capacity for the instance.
	// Experimental.
	InstanceType awsec2.InstanceType `json:"instanceType"`
	// The license model.
	// Experimental.
	LicenseModel LicenseModel `json:"licenseModel"`
	// The DB parameter group to associate with the instance.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// The time zone of the instance.
	//
	// This is currently supported only by Microsoft Sql Server.
	// Experimental.
	Timezone *string `json:"timezone"`
}

Construction properties for a DatabaseInstanceSource.

TODO: EXAMPLE

Experimental.

type DatabaseProxy

type DatabaseProxy interface {
	awscdk.Resource
	awsec2.IConnectable
	IDatabaseProxy
	awssecretsmanager.ISecretAttachmentTarget
	Connections() awsec2.Connections
	DbProxyArn() *string
	DbProxyName() *string
	Endpoint() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantConnect(grantee awsiam.IGrantable, dbUser *string) awsiam.Grant
	ToString() *string
}

RDS Database Proxy.

TODO: EXAMPLE

Experimental.

func NewDatabaseProxy

func NewDatabaseProxy(scope constructs.Construct, id *string, props *DatabaseProxyProps) DatabaseProxy

Experimental.

type DatabaseProxyAttributes

type DatabaseProxyAttributes struct {
	// DB Proxy ARN.
	// Experimental.
	DbProxyArn *string `json:"dbProxyArn"`
	// DB Proxy Name.
	// Experimental.
	DbProxyName *string `json:"dbProxyName"`
	// Endpoint.
	// Experimental.
	Endpoint *string `json:"endpoint"`
	// The security groups of the instance.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
}

Properties that describe an existing DB Proxy.

TODO: EXAMPLE

Experimental.

type DatabaseProxyOptions

type DatabaseProxyOptions struct {
	// The duration for a proxy to wait for a connection to become available in the connection pool.
	//
	// Only applies when the proxy has opened its maximum number of connections and all connections are busy with client
	// sessions.
	//
	// Value must be between 1 second and 1 hour, or `Duration.seconds(0)` to represent unlimited.
	// Experimental.
	BorrowTimeout awscdk.Duration `json:"borrowTimeout"`
	// The identifier for the proxy.
	//
	// This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
	// An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens;
	// it can't end with a hyphen or contain two consecutive hyphens.
	// Experimental.
	DbProxyName *string `json:"dbProxyName"`
	// Whether the proxy includes detailed information about SQL statements in its logs.
	//
	// This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections.
	// The debug information includes the text of SQL statements that you submit through the proxy.
	// Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive
	// information that appears in the logs.
	// Experimental.
	DebugLogging *bool `json:"debugLogging"`
	// Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
	// Experimental.
	IamAuth *bool `json:"iamAuth"`
	// The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
	//
	// You can set this value higher or lower than the connection timeout limit for the associated database.
	// Experimental.
	IdleClientTimeout awscdk.Duration `json:"idleClientTimeout"`
	// One or more SQL statements for the proxy to run when opening each new database connection.
	//
	// Typically used with SET statements to make sure that each connection has identical settings such as time zone
	// and character set.
	// For multiple statements, use semicolons as the separator.
	// You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
	//
	// not currently supported for PostgreSQL.
	// Experimental.
	InitQuery *string `json:"initQuery"`
	// The maximum size of the connection pool for each target in a target group.
	//
	// For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB
	// cluster used by the target group.
	//
	// 1-100
	// Experimental.
	MaxConnectionsPercent *float64 `json:"maxConnectionsPercent"`
	// Controls how actively the proxy closes idle database connections in the connection pool.
	//
	// A high value enables the proxy to leave a high percentage of idle connections open.
	// A low value causes the proxy to close idle client connections and return the underlying database connections
	// to the connection pool.
	// For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance
	// or Aurora DB cluster used by the target group.
	//
	// between 0 and MaxConnectionsPercent
	// Experimental.
	MaxIdleConnectionsPercent *float64 `json:"maxIdleConnectionsPercent"`
	// A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
	//
	// By enabling this setting, you can enforce encrypted TLS connections to the proxy.
	// Experimental.
	RequireTLS *bool `json:"requireTLS"`
	// IAM role that the proxy uses to access secrets in AWS Secrets Manager.
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
	//
	// These secrets are stored within Amazon Secrets Manager.
	// One or more secrets are required.
	// Experimental.
	Secrets *[]awssecretsmanager.ISecret `json:"secrets"`
	// One or more VPC security groups to associate with the new proxy.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
	//
	// Including an item in the list exempts that class of SQL operations from the pinning behavior.
	// Experimental.
	SessionPinningFilters *[]SessionPinningFilter `json:"sessionPinningFilters"`
	// The VPC to associate with the new proxy.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The subnets used by the proxy.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Options for a new DatabaseProxy.

TODO: EXAMPLE

Experimental.

type DatabaseProxyProps

type DatabaseProxyProps struct {
	// The duration for a proxy to wait for a connection to become available in the connection pool.
	//
	// Only applies when the proxy has opened its maximum number of connections and all connections are busy with client
	// sessions.
	//
	// Value must be between 1 second and 1 hour, or `Duration.seconds(0)` to represent unlimited.
	// Experimental.
	BorrowTimeout awscdk.Duration `json:"borrowTimeout"`
	// The identifier for the proxy.
	//
	// This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
	// An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens;
	// it can't end with a hyphen or contain two consecutive hyphens.
	// Experimental.
	DbProxyName *string `json:"dbProxyName"`
	// Whether the proxy includes detailed information about SQL statements in its logs.
	//
	// This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections.
	// The debug information includes the text of SQL statements that you submit through the proxy.
	// Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive
	// information that appears in the logs.
	// Experimental.
	DebugLogging *bool `json:"debugLogging"`
	// Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
	// Experimental.
	IamAuth *bool `json:"iamAuth"`
	// The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
	//
	// You can set this value higher or lower than the connection timeout limit for the associated database.
	// Experimental.
	IdleClientTimeout awscdk.Duration `json:"idleClientTimeout"`
	// One or more SQL statements for the proxy to run when opening each new database connection.
	//
	// Typically used with SET statements to make sure that each connection has identical settings such as time zone
	// and character set.
	// For multiple statements, use semicolons as the separator.
	// You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
	//
	// not currently supported for PostgreSQL.
	// Experimental.
	InitQuery *string `json:"initQuery"`
	// The maximum size of the connection pool for each target in a target group.
	//
	// For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB
	// cluster used by the target group.
	//
	// 1-100
	// Experimental.
	MaxConnectionsPercent *float64 `json:"maxConnectionsPercent"`
	// Controls how actively the proxy closes idle database connections in the connection pool.
	//
	// A high value enables the proxy to leave a high percentage of idle connections open.
	// A low value causes the proxy to close idle client connections and return the underlying database connections
	// to the connection pool.
	// For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance
	// or Aurora DB cluster used by the target group.
	//
	// between 0 and MaxConnectionsPercent
	// Experimental.
	MaxIdleConnectionsPercent *float64 `json:"maxIdleConnectionsPercent"`
	// A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
	//
	// By enabling this setting, you can enforce encrypted TLS connections to the proxy.
	// Experimental.
	RequireTLS *bool `json:"requireTLS"`
	// IAM role that the proxy uses to access secrets in AWS Secrets Manager.
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
	//
	// These secrets are stored within Amazon Secrets Manager.
	// One or more secrets are required.
	// Experimental.
	Secrets *[]awssecretsmanager.ISecret `json:"secrets"`
	// One or more VPC security groups to associate with the new proxy.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
	//
	// Including an item in the list exempts that class of SQL operations from the pinning behavior.
	// Experimental.
	SessionPinningFilters *[]SessionPinningFilter `json:"sessionPinningFilters"`
	// The VPC to associate with the new proxy.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The subnets used by the proxy.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
	// DB proxy target: Instance or Cluster.
	// Experimental.
	ProxyTarget ProxyTarget `json:"proxyTarget"`
}

Construction properties for a DatabaseProxy.

TODO: EXAMPLE

Experimental.

type DatabaseSecret

type DatabaseSecret interface {
	awssecretsmanager.Secret
	ArnForPolicies() *string
	AutoCreatePolicy() *bool
	EncryptionKey() awskms.IKey
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	SecretArn() *string
	SecretFullArn() *string
	SecretName() *string
	SecretValue() awscdk.SecretValue
	Stack() awscdk.Stack
	AddReplicaRegion(region *string, encryptionKey awskms.IKey)
	AddRotationSchedule(id *string, options *awssecretsmanager.RotationScheduleOptions) awssecretsmanager.RotationSchedule
	AddToResourcePolicy(statement awsiam.PolicyStatement) *awsiam.AddToResourcePolicyResult
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Attach(target awssecretsmanager.ISecretAttachmentTarget) awssecretsmanager.ISecret
	DenyAccountRootDelete()
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantRead(grantee awsiam.IGrantable, versionStages *[]*string) awsiam.Grant
	GrantWrite(grantee awsiam.IGrantable) awsiam.Grant
	SecretValueFromJson(jsonField *string) awscdk.SecretValue
	ToString() *string
}

A database secret.

TODO: EXAMPLE

Experimental.

func NewDatabaseSecret

func NewDatabaseSecret(scope constructs.Construct, id *string, props *DatabaseSecretProps) DatabaseSecret

Experimental.

type DatabaseSecretProps

type DatabaseSecretProps struct {
	// The username.
	// Experimental.
	Username *string `json:"username"`
	// The KMS key to use to encrypt the secret.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// Characters to not include in the generated password.
	// Experimental.
	ExcludeCharacters *string `json:"excludeCharacters"`
	// The master secret which will be used to rotate this secret.
	// Experimental.
	MasterSecret awssecretsmanager.ISecret `json:"masterSecret"`
	// Whether to replace this secret when the criteria for the password change.
	//
	// This is achieved by overriding the logical id of the AWS::SecretsManager::Secret
	// with a hash of the options that influence the password generation. This
	// way a new secret will be created when the password is regenerated and the
	// cluster or instance consuming this secret will have its credentials updated.
	// Experimental.
	ReplaceOnPasswordCriteriaChanges *bool `json:"replaceOnPasswordCriteriaChanges"`
	// A list of regions where to replicate this secret.
	// Experimental.
	ReplicaRegions *[]*awssecretsmanager.ReplicaRegion `json:"replicaRegions"`
	// A name for the secret.
	// Experimental.
	SecretName *string `json:"secretName"`
}

Construction properties for a DatabaseSecret.

TODO: EXAMPLE

Experimental.

type Endpoint

type Endpoint interface {
	Hostname() *string
	Port() *float64
	SocketAddress() *string
}

Connection endpoint of a database cluster or instance.

Consists of a combination of hostname and port.

TODO: EXAMPLE

Experimental.

func NewEndpoint

func NewEndpoint(address *string, port *float64) Endpoint

Experimental.

type EngineVersion

type EngineVersion struct {
	// The full version string of the engine, for example, "5.6.mysql_aurora.1.22.1". It can be undefined, which means RDS should use whatever version it deems appropriate for the given engine type.
	// Experimental.
	FullVersion *string `json:"fullVersion"`
	// The major version of the engine, for example, "5.6". Used in specifying the ParameterGroup family and OptionGroup version for this engine.
	// Experimental.
	MajorVersion *string `json:"majorVersion"`
}

A version of an engine - for either a cluster, or instance.

TODO: EXAMPLE

Experimental.

type IClusterEngine

type IClusterEngine interface {
	IEngine
	// Method called when the engine is used to create a new cluster.
	// Experimental.
	BindToCluster(scope constructs.Construct, options *ClusterEngineBindOptions) *ClusterEngineConfig
	// The application used by this engine to perform rotation for a multi-user scenario.
	// Experimental.
	MultiUserRotationApplication() awssecretsmanager.SecretRotationApplication
	// The application used by this engine to perform rotation for a single-user scenario.
	// Experimental.
	SingleUserRotationApplication() awssecretsmanager.SecretRotationApplication
	// The log types that are available with this engine type.
	// Experimental.
	SupportedLogTypes() *[]*string
}

The interface representing a database cluster (as opposed to instance) engine. Experimental.

func DatabaseClusterEngine_AURORA

func DatabaseClusterEngine_AURORA() IClusterEngine

func DatabaseClusterEngine_AURORA_MYSQL

func DatabaseClusterEngine_AURORA_MYSQL() IClusterEngine

func DatabaseClusterEngine_AURORA_POSTGRESQL

func DatabaseClusterEngine_AURORA_POSTGRESQL() IClusterEngine

func DatabaseClusterEngine_Aurora

func DatabaseClusterEngine_Aurora(props *AuroraClusterEngineProps) IClusterEngine

Creates a new plain Aurora database cluster engine. Experimental.

func DatabaseClusterEngine_AuroraMysql

func DatabaseClusterEngine_AuroraMysql(props *AuroraMysqlClusterEngineProps) IClusterEngine

Creates a new Aurora MySQL database cluster engine. Experimental.

func DatabaseClusterEngine_AuroraPostgres

func DatabaseClusterEngine_AuroraPostgres(props *AuroraPostgresClusterEngineProps) IClusterEngine

Creates a new Aurora PostgreSQL database cluster engine. Experimental.

type IDatabaseCluster

type IDatabaseCluster interface {
	awsec2.IConnectable
	awscdk.IResource
	awssecretsmanager.ISecretAttachmentTarget
	// Add a new db proxy to this cluster.
	// Experimental.
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	// Return the given named metric for this DBCluster.
	// Experimental.
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The percentage of CPU utilization.
	//
	// Average over 5 minutes
	// Experimental.
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The number of database connections in use.
	//
	// Average over 5 minutes
	// Experimental.
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The average number of deadlocks in the database per second.
	//
	// Average over 5 minutes
	// Experimental.
	MetricDeadlocks(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of time that the instance has been running, in seconds.
	//
	// Average over 5 minutes
	// Experimental.
	MetricEngineUptime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of available random access memory, in bytes.
	//
	// Average over 5 minutes
	// Experimental.
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of local storage available, in bytes.
	//
	// Average over 5 minutes
	// Experimental.
	MetricFreeLocalStorage(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of network throughput received from clients by each instance, in bytes per second.
	//
	// Average over 5 minutes
	// Experimental.
	MetricNetworkReceiveThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.
	//
	// Average over 5 minutes
	// Experimental.
	MetricNetworkThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of network throughput sent to clients by each instance, in bytes per second.
	//
	// Average over 5 minutes
	// Experimental.
	MetricNetworkTransmitThroughput(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.
	//
	// Average over 5 minutes
	// Experimental.
	MetricSnapshotStorageUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The total amount of backup storage in bytes for which you are billed.
	//
	// Average over 5 minutes
	// Experimental.
	MetricTotalBackupStorageBilled(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of storage used by your Aurora DB instance, in bytes.
	//
	// Average over 5 minutes
	// Experimental.
	MetricVolumeBytesUsed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.
	//
	// Average over 5 minutes
	// Experimental.
	MetricVolumeReadIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.
	//
	// Average over 5 minutes
	// Experimental.
	MetricVolumeWriteIOPs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The endpoint to use for read/write operations.
	// Experimental.
	ClusterEndpoint() Endpoint
	// Identifier of the cluster.
	// Experimental.
	ClusterIdentifier() *string
	// Endpoint to use for load-balanced read-only operations.
	// Experimental.
	ClusterReadEndpoint() Endpoint
	// The engine of this Cluster.
	//
	// May be not known for imported Clusters if it wasn't provided explicitly.
	// Experimental.
	Engine() IClusterEngine
	// Endpoints which address each individual replica.
	// Experimental.
	InstanceEndpoints() *[]Endpoint
	// Identifiers of the replicas.
	// Experimental.
	InstanceIdentifiers() *[]*string
}

Create a clustered database with a given number of instances. Experimental.

func DatabaseCluster_FromDatabaseClusterAttributes

func DatabaseCluster_FromDatabaseClusterAttributes(scope constructs.Construct, id *string, attrs *DatabaseClusterAttributes) IDatabaseCluster

Import an existing DatabaseCluster from properties. Experimental.

type IDatabaseInstance

type IDatabaseInstance interface {
	awsec2.IConnectable
	awscdk.IResource
	awssecretsmanager.ISecretAttachmentTarget
	// Add a new db proxy to this instance.
	// Experimental.
	AddProxy(id *string, options *DatabaseProxyOptions) DatabaseProxy
	// Grant the given identity connection access to the database.
	// Experimental.
	GrantConnect(grantee awsiam.IGrantable) awsiam.Grant
	// Return the given named metric for this DBInstance.
	// Experimental.
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The percentage of CPU utilization.
	//
	// Average over 5 minutes
	// Experimental.
	MetricCPUUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The number of database connections in use.
	//
	// Average over 5 minutes
	// Experimental.
	MetricDatabaseConnections(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of available random access memory.
	//
	// Average over 5 minutes
	// Experimental.
	MetricFreeableMemory(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The amount of available storage space.
	//
	// Average over 5 minutes
	// Experimental.
	MetricFreeStorageSpace(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The average number of disk write I/O operations per second.
	//
	// Average over 5 minutes
	// Experimental.
	MetricReadIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The average number of disk read I/O operations per second.
	//
	// Average over 5 minutes
	// Experimental.
	MetricWriteIOPS(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Defines a CloudWatch event rule which triggers for instance events.
	//
	// Use
	// `rule.addEventPattern(pattern)` to specify a filter.
	// Experimental.
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// The instance endpoint address.
	// Experimental.
	DbInstanceEndpointAddress() *string
	// The instance endpoint port.
	// Experimental.
	DbInstanceEndpointPort() *string
	// The engine of this database Instance.
	//
	// May be not known for imported Instances if it wasn't provided explicitly,
	// or for read replicas.
	// Experimental.
	Engine() IInstanceEngine
	// The instance arn.
	// Experimental.
	InstanceArn() *string
	// The instance endpoint.
	// Experimental.
	InstanceEndpoint() Endpoint
	// The instance identifier.
	// Experimental.
	InstanceIdentifier() *string
}

A database instance. Experimental.

func DatabaseInstanceBase_FromDatabaseInstanceAttributes

func DatabaseInstanceBase_FromDatabaseInstanceAttributes(scope constructs.Construct, id *string, attrs *DatabaseInstanceAttributes) IDatabaseInstance

Import an existing database instance. Experimental.

func DatabaseInstanceFromSnapshot_FromDatabaseInstanceAttributes

func DatabaseInstanceFromSnapshot_FromDatabaseInstanceAttributes(scope constructs.Construct, id *string, attrs *DatabaseInstanceAttributes) IDatabaseInstance

Import an existing database instance. Experimental.

func DatabaseInstanceReadReplica_FromDatabaseInstanceAttributes

func DatabaseInstanceReadReplica_FromDatabaseInstanceAttributes(scope constructs.Construct, id *string, attrs *DatabaseInstanceAttributes) IDatabaseInstance

Import an existing database instance. Experimental.

func DatabaseInstance_FromDatabaseInstanceAttributes

func DatabaseInstance_FromDatabaseInstanceAttributes(scope constructs.Construct, id *string, attrs *DatabaseInstanceAttributes) IDatabaseInstance

Import an existing database instance. Experimental.

type IDatabaseProxy

type IDatabaseProxy interface {
	awscdk.IResource
	// Grant the given identity connection access to the proxy.
	// Experimental.
	GrantConnect(grantee awsiam.IGrantable, dbUser *string) awsiam.Grant
	// DB Proxy ARN.
	// Experimental.
	DbProxyArn() *string
	// DB Proxy Name.
	// Experimental.
	DbProxyName() *string
	// Endpoint.
	// Experimental.
	Endpoint() *string
}

DB Proxy. Experimental.

func DatabaseProxy_FromDatabaseProxyAttributes

func DatabaseProxy_FromDatabaseProxyAttributes(scope constructs.Construct, id *string, attrs *DatabaseProxyAttributes) IDatabaseProxy

Import an existing database proxy. Experimental.

type IEngine

type IEngine interface {
	// The default name of the master database user if one was not provided explicitly.
	//
	// The global default of 'admin' will be used if this is `undefined`.
	// Note that 'admin' is a reserved word in PostgreSQL and cannot be used.
	// Experimental.
	DefaultUsername() *string
	// The family this engine belongs to, like "MYSQL", or "POSTGRESQL".
	//
	// This property is used when creating a Database Proxy.
	// Most engines don't belong to any family
	// (and because of that, you can't create Database Proxies for their Clusters or Instances).
	// Experimental.
	EngineFamily() *string
	// The type of the engine, for example "mysql".
	// Experimental.
	EngineType() *string
	// The exact version of the engine that is used, for example "5.1.42".
	// Experimental.
	EngineVersion() *EngineVersion
	// The family to use for ParameterGroups using this engine.
	//
	// This is usually equal to "<engineType><engineMajorVersion>",
	// but can sometimes be a variation of that.
	// You can pass this property when creating new ParameterGroup.
	// Experimental.
	ParameterGroupFamily() *string
}

A common interface for database engines.

Don't implement this interface directly, instead implement one of the known sub-interfaces, like IClusterEngine and IInstanceEngine. Experimental.

type IInstanceEngine

type IInstanceEngine interface {
	IEngine
	// Method called when the engine is used to create a new instance.
	// Experimental.
	BindToInstance(scope constructs.Construct, options *InstanceEngineBindOptions) *InstanceEngineConfig
	// The application used by this engine to perform rotation for a multi-user scenario.
	// Experimental.
	MultiUserRotationApplication() awssecretsmanager.SecretRotationApplication
	// The application used by this engine to perform rotation for a single-user scenario.
	// Experimental.
	SingleUserRotationApplication() awssecretsmanager.SecretRotationApplication
	// Whether this engine supports automatic backups of a read replica instance.
	// Experimental.
	SupportsReadReplicaBackups() *bool
}

Interface representing a database instance (as opposed to cluster) engine. Experimental.

func DatabaseInstanceEngine_MariaDb

func DatabaseInstanceEngine_MariaDb(props *MariaDbInstanceEngineProps) IInstanceEngine

Creates a new MariaDB instance engine. Experimental.

func DatabaseInstanceEngine_Mysql

func DatabaseInstanceEngine_Mysql(props *MySqlInstanceEngineProps) IInstanceEngine

Creates a new MySQL instance engine. Experimental.

func DatabaseInstanceEngine_OracleEe

func DatabaseInstanceEngine_OracleEe(props *OracleEeInstanceEngineProps) IInstanceEngine

Creates a new Oracle Enterprise Edition instance engine. Experimental.

func DatabaseInstanceEngine_OracleSe2

func DatabaseInstanceEngine_OracleSe2(props *OracleSe2InstanceEngineProps) IInstanceEngine

Creates a new Oracle Standard Edition 1 instance engine. Experimental.

func DatabaseInstanceEngine_Postgres

func DatabaseInstanceEngine_Postgres(props *PostgresInstanceEngineProps) IInstanceEngine

Creates a new PostgreSQL instance engine. Experimental.

func DatabaseInstanceEngine_SqlServerEe

func DatabaseInstanceEngine_SqlServerEe(props *SqlServerEeInstanceEngineProps) IInstanceEngine

Creates a new SQL Server Enterprise Edition instance engine. Experimental.

func DatabaseInstanceEngine_SqlServerEx

func DatabaseInstanceEngine_SqlServerEx(props *SqlServerExInstanceEngineProps) IInstanceEngine

Creates a new SQL Server Express Edition instance engine. Experimental.

func DatabaseInstanceEngine_SqlServerSe

func DatabaseInstanceEngine_SqlServerSe(props *SqlServerSeInstanceEngineProps) IInstanceEngine

Creates a new SQL Server Standard Edition instance engine. Experimental.

func DatabaseInstanceEngine_SqlServerWeb

func DatabaseInstanceEngine_SqlServerWeb(props *SqlServerWebInstanceEngineProps) IInstanceEngine

Creates a new SQL Server Web Edition instance engine. Experimental.

type IOptionGroup

type IOptionGroup interface {
	awscdk.IResource
	// Adds a configuration to this OptionGroup.
	//
	// This method is a no-op for an imported OptionGroup.
	//
	// Returns: true if the OptionConfiguration was successfully added.
	// Experimental.
	AddConfiguration(configuration *OptionConfiguration) *bool
	// The name of the option group.
	// Experimental.
	OptionGroupName() *string
}

An option group. Experimental.

func OptionGroup_FromOptionGroupName

func OptionGroup_FromOptionGroupName(scope constructs.Construct, id *string, optionGroupName *string) IOptionGroup

Import an existing option group. Experimental.

type IParameterGroup

type IParameterGroup interface {
	awscdk.IResource
	// Adds a parameter to this group.
	//
	// If this is an imported parameter group,
	// this method does nothing.
	//
	// Returns: true if the parameter was actually added
	// (i.e., this ParameterGroup is not imported),
	// false otherwise
	// Experimental.
	AddParameter(key *string, value *string) *bool
	// Method called when this Parameter Group is used when defining a database cluster.
	// Experimental.
	BindToCluster(options *ParameterGroupClusterBindOptions) *ParameterGroupClusterConfig
	// Method called when this Parameter Group is used when defining a database instance.
	// Experimental.
	BindToInstance(options *ParameterGroupInstanceBindOptions) *ParameterGroupInstanceConfig
}

A parameter group.

Represents both a cluster parameter group, and an instance parameter group. Experimental.

func ParameterGroup_FromParameterGroupName

func ParameterGroup_FromParameterGroupName(scope constructs.Construct, id *string, parameterGroupName *string) IParameterGroup

Imports a parameter group. Experimental.

type IServerlessCluster

type IServerlessCluster interface {
	awsec2.IConnectable
	awscdk.IResource
	awssecretsmanager.ISecretAttachmentTarget
	// Grant the given identity to access to the Data API.
	// Experimental.
	GrantDataApiAccess(grantee awsiam.IGrantable) awsiam.Grant
	// The ARN of the cluster.
	// Experimental.
	ClusterArn() *string
	// The endpoint to use for read/write operations.
	// Experimental.
	ClusterEndpoint() Endpoint
	// Identifier of the cluster.
	// Experimental.
	ClusterIdentifier() *string
	// Endpoint to use for load-balanced read-only operations.
	// Experimental.
	ClusterReadEndpoint() Endpoint
}

Interface representing a serverless database cluster. Experimental.

func ServerlessCluster_FromServerlessClusterAttributes

func ServerlessCluster_FromServerlessClusterAttributes(scope constructs.Construct, id *string, attrs *ServerlessClusterAttributes) IServerlessCluster

Import an existing DatabaseCluster from properties. Experimental.

type ISubnetGroup

type ISubnetGroup interface {
	awscdk.IResource
	// The name of the subnet group.
	// Experimental.
	SubnetGroupName() *string
}

Interface for a subnet group. Experimental.

func SubnetGroup_FromSubnetGroupName

func SubnetGroup_FromSubnetGroupName(scope constructs.Construct, id *string, subnetGroupName *string) ISubnetGroup

Imports an existing subnet group by name. Experimental.

type InstanceEngineBindOptions

type InstanceEngineBindOptions struct {
	// The Active Directory directory ID to create the DB instance in.
	// Experimental.
	Domain *string `json:"domain"`
	// The option group of the database.
	// Experimental.
	OptionGroup IOptionGroup `json:"optionGroup"`
	// The role used for S3 exporting.
	// Experimental.
	S3ExportRole awsiam.IRole `json:"s3ExportRole"`
	// The role used for S3 importing.
	// Experimental.
	S3ImportRole awsiam.IRole `json:"s3ImportRole"`
	// The timezone of the database, set by the customer.
	// Experimental.
	Timezone *string `json:"timezone"`
}

The options passed to {@link IInstanceEngine.bind}.

TODO: EXAMPLE

Experimental.

type InstanceEngineConfig

type InstanceEngineConfig struct {
	// Features supported by the database engine.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html
	//
	// Experimental.
	Features *InstanceEngineFeatures `json:"features"`
	// Option group of the database.
	// Experimental.
	OptionGroup IOptionGroup `json:"optionGroup"`
}

The type returned from the {@link IInstanceEngine.bind} method.

TODO: EXAMPLE

Experimental.

type InstanceEngineFeatures

type InstanceEngineFeatures struct {
	// Feature name for the DB instance that the IAM role to export to S3 bucket is to be associated with.
	// Experimental.
	S3Export *string `json:"s3Export"`
	// Feature name for the DB instance that the IAM role to access the S3 bucket for import is to be associated with.
	// Experimental.
	S3Import *string `json:"s3Import"`
}

Represents Database Engine features.

TODO: EXAMPLE

Experimental.

type InstanceProps

type InstanceProps struct {
	// What subnets to run the RDS instances in.
	//
	// Must be at least 2 subnets in two different AZs.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// Whether to allow upgrade of major version for the DB instance.
	// Experimental.
	AllowMajorVersionUpgrade *bool `json:"allowMajorVersionUpgrade"`
	// Whether to enable automatic upgrade of minor version for the DB instance.
	// Experimental.
	AutoMinorVersionUpgrade *bool `json:"autoMinorVersionUpgrade"`
	// Whether to remove automated backups immediately after the DB instance is deleted for the DB instance.
	// Experimental.
	DeleteAutomatedBackups *bool `json:"deleteAutomatedBackups"`
	// Whether to enable Performance Insights for the DB instance.
	// Experimental.
	EnablePerformanceInsights *bool `json:"enablePerformanceInsights"`
	// What type of instance to start for the replicas.
	// Experimental.
	InstanceType awsec2.InstanceType `json:"instanceType"`
	// The DB parameter group to associate with the instance.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// The AWS KMS key for encryption of Performance Insights data.
	// Experimental.
	PerformanceInsightEncryptionKey awskms.IKey `json:"performanceInsightEncryptionKey"`
	// The amount of time, in days, to retain Performance Insights data.
	// Experimental.
	PerformanceInsightRetention PerformanceInsightRetention `json:"performanceInsightRetention"`
	// Indicates whether the DB instance is an internet-facing instance.
	// Experimental.
	PubliclyAccessible *bool `json:"publiclyAccessible"`
	// Security group.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// Where to place the instances within the VPC.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Instance properties for database instances.

TODO: EXAMPLE

Experimental.

type LicenseModel

type LicenseModel string

The license model. Experimental.

const (
	LicenseModel_BRING_YOUR_OWN_LICENSE LicenseModel = "BRING_YOUR_OWN_LICENSE"
	LicenseModel_GENERAL_PUBLIC_LICENSE LicenseModel = "GENERAL_PUBLIC_LICENSE"
	LicenseModel_LICENSE_INCLUDED       LicenseModel = "LICENSE_INCLUDED"
)

type MariaDbEngineVersion

type MariaDbEngineVersion interface {
	MariaDbFullVersion() *string
	MariaDbMajorVersion() *string
}

The versions for the MariaDB instance engines (those returned by {@link DatabaseInstanceEngine.mariaDb}).

TODO: EXAMPLE

Experimental.

func MariaDbEngineVersion_Of

func MariaDbEngineVersion_Of(mariaDbFullVersion *string, mariaDbMajorVersion *string) MariaDbEngineVersion

Create a new MariaDbEngineVersion with an arbitrary version. Experimental.

func MariaDbEngineVersion_VER_10_2

func MariaDbEngineVersion_VER_10_2() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_11

func MariaDbEngineVersion_VER_10_2_11() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_12

func MariaDbEngineVersion_VER_10_2_12() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_15

func MariaDbEngineVersion_VER_10_2_15() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_21

func MariaDbEngineVersion_VER_10_2_21() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_32

func MariaDbEngineVersion_VER_10_2_32() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_37

func MariaDbEngineVersion_VER_10_2_37() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_39

func MariaDbEngineVersion_VER_10_2_39() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_2_40

func MariaDbEngineVersion_VER_10_2_40() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_3

func MariaDbEngineVersion_VER_10_3() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_3_13

func MariaDbEngineVersion_VER_10_3_13() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_3_20

func MariaDbEngineVersion_VER_10_3_20() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_3_23

func MariaDbEngineVersion_VER_10_3_23() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_3_28

func MariaDbEngineVersion_VER_10_3_28() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_3_31

func MariaDbEngineVersion_VER_10_3_31() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_3_8

func MariaDbEngineVersion_VER_10_3_8() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_4

func MariaDbEngineVersion_VER_10_4() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_4_13

func MariaDbEngineVersion_VER_10_4_13() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_4_18

func MariaDbEngineVersion_VER_10_4_18() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_4_21

func MariaDbEngineVersion_VER_10_4_21() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_4_8

func MariaDbEngineVersion_VER_10_4_8() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_5

func MariaDbEngineVersion_VER_10_5() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_5_12

func MariaDbEngineVersion_VER_10_5_12() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_5_8

func MariaDbEngineVersion_VER_10_5_8() MariaDbEngineVersion

func MariaDbEngineVersion_VER_10_5_9

func MariaDbEngineVersion_VER_10_5_9() MariaDbEngineVersion

type MariaDbInstanceEngineProps

type MariaDbInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version MariaDbEngineVersion `json:"version"`
}

Properties for MariaDB instance engines.

Used in {@link DatabaseInstanceEngine.mariaDb}.

TODO: EXAMPLE

Experimental.

type MySqlInstanceEngineProps

type MySqlInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version MysqlEngineVersion `json:"version"`
}

Properties for MySQL instance engines.

Used in {@link DatabaseInstanceEngine.mysql}.

TODO: EXAMPLE

Experimental.

type MysqlEngineVersion

type MysqlEngineVersion interface {
	MysqlFullVersion() *string
	MysqlMajorVersion() *string
}

The versions for the MySQL instance engines (those returned by {@link DatabaseInstanceEngine.mysql}).

TODO: EXAMPLE

Experimental.

func MysqlEngineVersion_Of

func MysqlEngineVersion_Of(mysqlFullVersion *string, mysqlMajorVersion *string) MysqlEngineVersion

Create a new MysqlEngineVersion with an arbitrary version. Experimental.

func MysqlEngineVersion_VER_5_7

func MysqlEngineVersion_VER_5_7() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_16

func MysqlEngineVersion_VER_5_7_16() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_17

func MysqlEngineVersion_VER_5_7_17() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_19

func MysqlEngineVersion_VER_5_7_19() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_21

func MysqlEngineVersion_VER_5_7_21() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_22

func MysqlEngineVersion_VER_5_7_22() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_23

func MysqlEngineVersion_VER_5_7_23() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_24

func MysqlEngineVersion_VER_5_7_24() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_25

func MysqlEngineVersion_VER_5_7_25() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_26

func MysqlEngineVersion_VER_5_7_26() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_28

func MysqlEngineVersion_VER_5_7_28() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_30

func MysqlEngineVersion_VER_5_7_30() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_31

func MysqlEngineVersion_VER_5_7_31() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_33

func MysqlEngineVersion_VER_5_7_33() MysqlEngineVersion

func MysqlEngineVersion_VER_5_7_34

func MysqlEngineVersion_VER_5_7_34() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0

func MysqlEngineVersion_VER_8_0() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_11

func MysqlEngineVersion_VER_8_0_11() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_13

func MysqlEngineVersion_VER_8_0_13() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_15

func MysqlEngineVersion_VER_8_0_15() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_16

func MysqlEngineVersion_VER_8_0_16() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_17

func MysqlEngineVersion_VER_8_0_17() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_19

func MysqlEngineVersion_VER_8_0_19() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_20

func MysqlEngineVersion_VER_8_0_20() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_21

func MysqlEngineVersion_VER_8_0_21() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_23

func MysqlEngineVersion_VER_8_0_23() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_25

func MysqlEngineVersion_VER_8_0_25() MysqlEngineVersion

func MysqlEngineVersion_VER_8_0_26

func MysqlEngineVersion_VER_8_0_26() MysqlEngineVersion

type OptionConfiguration

type OptionConfiguration struct {
	// The name of the option.
	// Experimental.
	Name *string `json:"name"`
	// The port number that this option uses.
	//
	// If `port` is specified then `vpc`
	// must also be specified.
	// Experimental.
	Port *float64 `json:"port"`
	// Optional list of security groups to use for this option, if `vpc` is specified.
	//
	// If no groups are provided, a default one will be created.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// The settings for the option.
	// Experimental.
	Settings *map[string]*string `json:"settings"`
	// The version for the option.
	// Experimental.
	Version *string `json:"version"`
	// The VPC where a security group should be created for this option.
	//
	// If `vpc`
	// is specified then `port` must also be specified.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
}

Configuration properties for an option.

TODO: EXAMPLE

Experimental.

type OptionGroup

type OptionGroup interface {
	awscdk.Resource
	IOptionGroup
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	OptionConnections() *map[string]awsec2.Connections
	OptionGroupName() *string
	PhysicalName() *string
	Stack() awscdk.Stack
	AddConfiguration(configuration *OptionConfiguration) *bool
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

An option group.

TODO: EXAMPLE

Experimental.

func NewOptionGroup

func NewOptionGroup(scope constructs.Construct, id *string, props *OptionGroupProps) OptionGroup

Experimental.

type OptionGroupProps

type OptionGroupProps struct {
	// The configurations for this option group.
	// Experimental.
	Configurations *[]*OptionConfiguration `json:"configurations"`
	// The database engine that this option group is associated with.
	// Experimental.
	Engine IInstanceEngine `json:"engine"`
	// A description of the option group.
	// Experimental.
	Description *string `json:"description"`
}

Construction properties for an OptionGroup.

TODO: EXAMPLE

Experimental.

type OracleEeInstanceEngineProps

type OracleEeInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version OracleEngineVersion `json:"version"`
}

Properties for Oracle Enterprise Edition instance engines.

Used in {@link DatabaseInstanceEngine.oracleEe}.

TODO: EXAMPLE

Experimental.

type OracleEngineVersion

type OracleEngineVersion interface {
	OracleFullVersion() *string
	OracleMajorVersion() *string
}

The versions for the Oracle instance engines (those returned by {@link DatabaseInstanceEngine.oracleSe2} and {@link DatabaseInstanceEngine.oracleEe}).

TODO: EXAMPLE

Experimental.

func OracleEngineVersion_Of

func OracleEngineVersion_Of(oracleFullVersion *string, oracleMajorVersion *string) OracleEngineVersion

Creates a new OracleEngineVersion with an arbitrary version. Experimental.

func OracleEngineVersion_VER_12_1

func OracleEngineVersion_VER_12_1() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V1

func OracleEngineVersion_VER_12_1_0_2_V1() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V10

func OracleEngineVersion_VER_12_1_0_2_V10() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V11

func OracleEngineVersion_VER_12_1_0_2_V11() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V12

func OracleEngineVersion_VER_12_1_0_2_V12() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V13

func OracleEngineVersion_VER_12_1_0_2_V13() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V14

func OracleEngineVersion_VER_12_1_0_2_V14() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V15

func OracleEngineVersion_VER_12_1_0_2_V15() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V16

func OracleEngineVersion_VER_12_1_0_2_V16() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V17

func OracleEngineVersion_VER_12_1_0_2_V17() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V18

func OracleEngineVersion_VER_12_1_0_2_V18() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V19

func OracleEngineVersion_VER_12_1_0_2_V19() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V2

func OracleEngineVersion_VER_12_1_0_2_V2() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V20

func OracleEngineVersion_VER_12_1_0_2_V20() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V21

func OracleEngineVersion_VER_12_1_0_2_V21() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V22

func OracleEngineVersion_VER_12_1_0_2_V22() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V23

func OracleEngineVersion_VER_12_1_0_2_V23() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V24

func OracleEngineVersion_VER_12_1_0_2_V24() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V3

func OracleEngineVersion_VER_12_1_0_2_V3() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V4

func OracleEngineVersion_VER_12_1_0_2_V4() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V5

func OracleEngineVersion_VER_12_1_0_2_V5() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V6

func OracleEngineVersion_VER_12_1_0_2_V6() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V7

func OracleEngineVersion_VER_12_1_0_2_V7() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V8

func OracleEngineVersion_VER_12_1_0_2_V8() OracleEngineVersion

func OracleEngineVersion_VER_12_1_0_2_V9

func OracleEngineVersion_VER_12_1_0_2_V9() OracleEngineVersion

func OracleEngineVersion_VER_12_2

func OracleEngineVersion_VER_12_2() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2018_10_R1

func OracleEngineVersion_VER_12_2_0_1_2018_10_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2019_01_R1

func OracleEngineVersion_VER_12_2_0_1_2019_01_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2019_04_R1

func OracleEngineVersion_VER_12_2_0_1_2019_04_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2019_07_R1

func OracleEngineVersion_VER_12_2_0_1_2019_07_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2019_10_R1

func OracleEngineVersion_VER_12_2_0_1_2019_10_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2020_01_R1

func OracleEngineVersion_VER_12_2_0_1_2020_01_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2020_04_R1

func OracleEngineVersion_VER_12_2_0_1_2020_04_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2020_07_R1

func OracleEngineVersion_VER_12_2_0_1_2020_07_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2020_10_R1

func OracleEngineVersion_VER_12_2_0_1_2020_10_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2021_01_R1

func OracleEngineVersion_VER_12_2_0_1_2021_01_R1() OracleEngineVersion

func OracleEngineVersion_VER_12_2_0_1_2021_04_R1

func OracleEngineVersion_VER_12_2_0_1_2021_04_R1() OracleEngineVersion

func OracleEngineVersion_VER_18

func OracleEngineVersion_VER_18() OracleEngineVersion

func OracleEngineVersion_VER_18_0_0_0_2019_07_R1

func OracleEngineVersion_VER_18_0_0_0_2019_07_R1() OracleEngineVersion

func OracleEngineVersion_VER_18_0_0_0_2019_10_R1

func OracleEngineVersion_VER_18_0_0_0_2019_10_R1() OracleEngineVersion

func OracleEngineVersion_VER_18_0_0_0_2020_01_R1

func OracleEngineVersion_VER_18_0_0_0_2020_01_R1() OracleEngineVersion

func OracleEngineVersion_VER_18_0_0_0_2020_04_R1

func OracleEngineVersion_VER_18_0_0_0_2020_04_R1() OracleEngineVersion

func OracleEngineVersion_VER_18_0_0_0_2020_07_R1

func OracleEngineVersion_VER_18_0_0_0_2020_07_R1() OracleEngineVersion

func OracleEngineVersion_VER_19

func OracleEngineVersion_VER_19() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2019_07_R1

func OracleEngineVersion_VER_19_0_0_0_2019_07_R1() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2019_10_R1

func OracleEngineVersion_VER_19_0_0_0_2019_10_R1() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2020_01_R1

func OracleEngineVersion_VER_19_0_0_0_2020_01_R1() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2020_04_R1

func OracleEngineVersion_VER_19_0_0_0_2020_04_R1() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2020_07_R1

func OracleEngineVersion_VER_19_0_0_0_2020_07_R1() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2020_10_R1

func OracleEngineVersion_VER_19_0_0_0_2020_10_R1() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2021_01_R1

func OracleEngineVersion_VER_19_0_0_0_2021_01_R1() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2021_01_R2

func OracleEngineVersion_VER_19_0_0_0_2021_01_R2() OracleEngineVersion

func OracleEngineVersion_VER_19_0_0_0_2021_04_R1

func OracleEngineVersion_VER_19_0_0_0_2021_04_R1() OracleEngineVersion

type OracleSe2InstanceEngineProps

type OracleSe2InstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version OracleEngineVersion `json:"version"`
}

Properties for Oracle Standard Edition 2 instance engines.

Used in {@link DatabaseInstanceEngine.oracleSe2}.

TODO: EXAMPLE

Experimental.

type ParameterGroup

type ParameterGroup interface {
	awscdk.Resource
	IParameterGroup
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddParameter(key *string, value *string) *bool
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BindToCluster(_options *ParameterGroupClusterBindOptions) *ParameterGroupClusterConfig
	BindToInstance(_options *ParameterGroupInstanceBindOptions) *ParameterGroupInstanceConfig
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A parameter group.

Represents both a cluster parameter group, and an instance parameter group.

TODO: EXAMPLE

Experimental.

func NewParameterGroup

func NewParameterGroup(scope constructs.Construct, id *string, props *ParameterGroupProps) ParameterGroup

Experimental.

type ParameterGroupClusterBindOptions

type ParameterGroupClusterBindOptions struct {
}

Options for {@link IParameterGroup.bindToCluster}. Empty for now, but can be extended later.

TODO: EXAMPLE

Experimental.

type ParameterGroupClusterConfig

type ParameterGroupClusterConfig struct {
	// The name of this parameter group.
	// Experimental.
	ParameterGroupName *string `json:"parameterGroupName"`
}

The type returned from {@link IParameterGroup.bindToCluster}.

TODO: EXAMPLE

Experimental.

type ParameterGroupInstanceBindOptions

type ParameterGroupInstanceBindOptions struct {
}

Options for {@link IParameterGroup.bindToInstance}. Empty for now, but can be extended later.

TODO: EXAMPLE

Experimental.

type ParameterGroupInstanceConfig

type ParameterGroupInstanceConfig struct {
	// The name of this parameter group.
	// Experimental.
	ParameterGroupName *string `json:"parameterGroupName"`
}

The type returned from {@link IParameterGroup.bindToInstance}.

TODO: EXAMPLE

Experimental.

type ParameterGroupProps

type ParameterGroupProps struct {
	// Description for this parameter group.
	// Experimental.
	Description *string `json:"description"`
	// The database engine for this parameter group.
	// Experimental.
	Engine IEngine `json:"engine"`
	// The parameters in this parameter group.
	// Experimental.
	Parameters *map[string]*string `json:"parameters"`
}

Properties for a parameter group.

TODO: EXAMPLE

Experimental.

type PerformanceInsightRetention

type PerformanceInsightRetention string

The retention period for Performance Insight. Experimental.

const (
	PerformanceInsightRetention_DEFAULT   PerformanceInsightRetention = "DEFAULT"
	PerformanceInsightRetention_LONG_TERM PerformanceInsightRetention = "LONG_TERM"
)

type PostgresEngineFeatures

type PostgresEngineFeatures struct {
	// Whether this version of the Postgres engine supports the S3 data export feature.
	// Experimental.
	S3Export *bool `json:"s3Export"`
	// Whether this version of the Postgres engine supports the S3 data import feature.
	// Experimental.
	S3Import *bool `json:"s3Import"`
}

Features supported by the Postgres database engine.

TODO: EXAMPLE

Experimental.

type PostgresEngineVersion

type PostgresEngineVersion interface {
	PostgresFullVersion() *string
	PostgresMajorVersion() *string
}

The versions for the PostgreSQL instance engines (those returned by {@link DatabaseInstanceEngine.postgres}).

TODO: EXAMPLE

Experimental.

func PostgresEngineVersion_Of

func PostgresEngineVersion_Of(postgresFullVersion *string, postgresMajorVersion *string, postgresFeatures *PostgresEngineFeatures) PostgresEngineVersion

Create a new PostgresEngineVersion with an arbitrary version. Experimental.

func PostgresEngineVersion_VER_10

func PostgresEngineVersion_VER_10() PostgresEngineVersion

func PostgresEngineVersion_VER_10_1

func PostgresEngineVersion_VER_10_1() PostgresEngineVersion

func PostgresEngineVersion_VER_10_10

func PostgresEngineVersion_VER_10_10() PostgresEngineVersion

func PostgresEngineVersion_VER_10_11

func PostgresEngineVersion_VER_10_11() PostgresEngineVersion

func PostgresEngineVersion_VER_10_12

func PostgresEngineVersion_VER_10_12() PostgresEngineVersion

func PostgresEngineVersion_VER_10_13

func PostgresEngineVersion_VER_10_13() PostgresEngineVersion

func PostgresEngineVersion_VER_10_14

func PostgresEngineVersion_VER_10_14() PostgresEngineVersion

func PostgresEngineVersion_VER_10_15

func PostgresEngineVersion_VER_10_15() PostgresEngineVersion

func PostgresEngineVersion_VER_10_16

func PostgresEngineVersion_VER_10_16() PostgresEngineVersion

func PostgresEngineVersion_VER_10_17

func PostgresEngineVersion_VER_10_17() PostgresEngineVersion

func PostgresEngineVersion_VER_10_18

func PostgresEngineVersion_VER_10_18() PostgresEngineVersion

func PostgresEngineVersion_VER_10_3

func PostgresEngineVersion_VER_10_3() PostgresEngineVersion

func PostgresEngineVersion_VER_10_4

func PostgresEngineVersion_VER_10_4() PostgresEngineVersion

func PostgresEngineVersion_VER_10_5

func PostgresEngineVersion_VER_10_5() PostgresEngineVersion

func PostgresEngineVersion_VER_10_6

func PostgresEngineVersion_VER_10_6() PostgresEngineVersion

func PostgresEngineVersion_VER_10_7

func PostgresEngineVersion_VER_10_7() PostgresEngineVersion

func PostgresEngineVersion_VER_10_9

func PostgresEngineVersion_VER_10_9() PostgresEngineVersion

func PostgresEngineVersion_VER_11

func PostgresEngineVersion_VER_11() PostgresEngineVersion

func PostgresEngineVersion_VER_11_1

func PostgresEngineVersion_VER_11_1() PostgresEngineVersion

func PostgresEngineVersion_VER_11_10

func PostgresEngineVersion_VER_11_10() PostgresEngineVersion

func PostgresEngineVersion_VER_11_11

func PostgresEngineVersion_VER_11_11() PostgresEngineVersion

func PostgresEngineVersion_VER_11_12

func PostgresEngineVersion_VER_11_12() PostgresEngineVersion

func PostgresEngineVersion_VER_11_13

func PostgresEngineVersion_VER_11_13() PostgresEngineVersion

func PostgresEngineVersion_VER_11_2

func PostgresEngineVersion_VER_11_2() PostgresEngineVersion

func PostgresEngineVersion_VER_11_4

func PostgresEngineVersion_VER_11_4() PostgresEngineVersion

func PostgresEngineVersion_VER_11_5

func PostgresEngineVersion_VER_11_5() PostgresEngineVersion

func PostgresEngineVersion_VER_11_6

func PostgresEngineVersion_VER_11_6() PostgresEngineVersion

func PostgresEngineVersion_VER_11_7

func PostgresEngineVersion_VER_11_7() PostgresEngineVersion

func PostgresEngineVersion_VER_11_8

func PostgresEngineVersion_VER_11_8() PostgresEngineVersion

func PostgresEngineVersion_VER_11_9

func PostgresEngineVersion_VER_11_9() PostgresEngineVersion

func PostgresEngineVersion_VER_12

func PostgresEngineVersion_VER_12() PostgresEngineVersion

func PostgresEngineVersion_VER_12_2

func PostgresEngineVersion_VER_12_2() PostgresEngineVersion

func PostgresEngineVersion_VER_12_3

func PostgresEngineVersion_VER_12_3() PostgresEngineVersion

func PostgresEngineVersion_VER_12_4

func PostgresEngineVersion_VER_12_4() PostgresEngineVersion

func PostgresEngineVersion_VER_12_5

func PostgresEngineVersion_VER_12_5() PostgresEngineVersion

func PostgresEngineVersion_VER_12_6

func PostgresEngineVersion_VER_12_6() PostgresEngineVersion

func PostgresEngineVersion_VER_12_7

func PostgresEngineVersion_VER_12_7() PostgresEngineVersion

func PostgresEngineVersion_VER_12_8

func PostgresEngineVersion_VER_12_8() PostgresEngineVersion

func PostgresEngineVersion_VER_13

func PostgresEngineVersion_VER_13() PostgresEngineVersion

func PostgresEngineVersion_VER_13_1

func PostgresEngineVersion_VER_13_1() PostgresEngineVersion

func PostgresEngineVersion_VER_13_2

func PostgresEngineVersion_VER_13_2() PostgresEngineVersion

func PostgresEngineVersion_VER_13_3

func PostgresEngineVersion_VER_13_3() PostgresEngineVersion

func PostgresEngineVersion_VER_13_4

func PostgresEngineVersion_VER_13_4() PostgresEngineVersion

type PostgresInstanceEngineProps

type PostgresInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version PostgresEngineVersion `json:"version"`
}

Properties for PostgreSQL instance engines.

Used in {@link DatabaseInstanceEngine.postgres}.

TODO: EXAMPLE

Experimental.

type ProcessorFeatures

type ProcessorFeatures struct {
	// The number of CPU core.
	// Experimental.
	CoreCount *float64 `json:"coreCount"`
	// The number of threads per core.
	// Experimental.
	ThreadsPerCore *float64 `json:"threadsPerCore"`
}

The processor features.

TODO: EXAMPLE

Experimental.

type ProxyTarget

type ProxyTarget interface {
	Bind(proxy DatabaseProxy) *ProxyTargetConfig
}

Proxy target: Instance or Cluster.

A target group is a collection of databases that the proxy can connect to. Currently, you can specify only one RDS DB instance or Aurora DB cluster.

TODO: EXAMPLE

Experimental.

func ProxyTarget_FromCluster

func ProxyTarget_FromCluster(cluster IDatabaseCluster) ProxyTarget

From cluster. Experimental.

func ProxyTarget_FromInstance

func ProxyTarget_FromInstance(instance IDatabaseInstance) ProxyTarget

From instance. Experimental.

type ProxyTargetConfig

type ProxyTargetConfig struct {
	// The database clusters to which this proxy connects.
	//
	// Either this or `dbInstances` will be set and the other `undefined`.
	// Experimental.
	DbClusters *[]IDatabaseCluster `json:"dbClusters"`
	// The database instances to which this proxy connects.
	//
	// Either this or `dbClusters` will be set and the other `undefined`.
	// Experimental.
	DbInstances *[]IDatabaseInstance `json:"dbInstances"`
	// The engine family of the database instance or cluster this proxy connects with.
	// Experimental.
	EngineFamily *string `json:"engineFamily"`
}

The result of binding a `ProxyTarget` to a `DatabaseProxy`.

TODO: EXAMPLE

Experimental.

type RotationMultiUserOptions

type RotationMultiUserOptions struct {
	// The secret to rotate.
	//
	// It must be a JSON string with the following format:
	// “`
	// {
	//    "engine": <required: database engine>,
	//    "host": <required: instance host name>,
	//    "username": <required: username>,
	//    "password": <required: password>,
	//    "dbname": <optional: database name>,
	//    "port": <optional: if not specified, default port will be used>,
	//    "masterarn": <required: the arn of the master secret which will be used to create users/change passwords>
	// }
	// “`
	// Experimental.
	Secret awssecretsmanager.ISecret `json:"secret"`
	// Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
	// Experimental.
	AutomaticallyAfter awscdk.Duration `json:"automaticallyAfter"`
	// The VPC interface endpoint to use for the Secrets Manager API.
	//
	// If you enable private DNS hostnames for your VPC private endpoint (the default), you don't
	// need to specify an endpoint. The standard Secrets Manager DNS hostname the Secrets Manager
	// CLI and SDKs use by default (https://secretsmanager.<region>.amazonaws.com) automatically
	// resolves to your VPC endpoint.
	// Experimental.
	Endpoint awsec2.IInterfaceVpcEndpoint `json:"endpoint"`
	// Specifies characters to not include in generated passwords.
	// Experimental.
	ExcludeCharacters *string `json:"excludeCharacters"`
	// Where to place the rotation Lambda function.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Options to add the multi user rotation.

TODO: EXAMPLE

Experimental.

type RotationSingleUserOptions

type RotationSingleUserOptions struct {
	// Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
	// Experimental.
	AutomaticallyAfter awscdk.Duration `json:"automaticallyAfter"`
	// The VPC interface endpoint to use for the Secrets Manager API.
	//
	// If you enable private DNS hostnames for your VPC private endpoint (the default), you don't
	// need to specify an endpoint. The standard Secrets Manager DNS hostname the Secrets Manager
	// CLI and SDKs use by default (https://secretsmanager.<region>.amazonaws.com) automatically
	// resolves to your VPC endpoint.
	// Experimental.
	Endpoint awsec2.IInterfaceVpcEndpoint `json:"endpoint"`
	// Specifies characters to not include in generated passwords.
	// Experimental.
	ExcludeCharacters *string `json:"excludeCharacters"`
	// Where to place the rotation Lambda function.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Options to add the multi user rotation.

TODO: EXAMPLE

Experimental.

type ServerlessCluster

type ServerlessCluster interface {
	awscdk.Resource
	IServerlessCluster
	ClusterArn() *string
	ClusterEndpoint() Endpoint
	ClusterIdentifier() *string
	ClusterReadEndpoint() Endpoint
	Connections() awsec2.Connections
	EnableDataApi() *bool
	SetEnableDataApi(val *bool)
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Secret() awssecretsmanager.ISecret
	Stack() awscdk.Stack
	AddRotationMultiUser(id *string, options *RotationMultiUserOptions) awssecretsmanager.SecretRotation
	AddRotationSingleUser(options *RotationSingleUserOptions) awssecretsmanager.SecretRotation
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantDataApiAccess(grantee awsiam.IGrantable) awsiam.Grant
	ToString() *string
}

Create an Aurora Serverless Cluster.

TODO: EXAMPLE

Experimental.

func NewServerlessCluster

func NewServerlessCluster(scope constructs.Construct, id *string, props *ServerlessClusterProps) ServerlessCluster

Experimental.

type ServerlessClusterAttributes

type ServerlessClusterAttributes struct {
	// Cluster endpoint address.
	// Experimental.
	ClusterEndpointAddress *string `json:"clusterEndpointAddress"`
	// Identifier for the cluster.
	// Experimental.
	ClusterIdentifier *string `json:"clusterIdentifier"`
	// The database port.
	// Experimental.
	Port *float64 `json:"port"`
	// Reader endpoint address.
	// Experimental.
	ReaderEndpointAddress *string `json:"readerEndpointAddress"`
	// The secret attached to the database cluster.
	// Experimental.
	Secret awssecretsmanager.ISecret `json:"secret"`
	// The security groups of the database cluster.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
}

Properties that describe an existing cluster instance.

TODO: EXAMPLE

Experimental.

type ServerlessClusterProps

type ServerlessClusterProps struct {
	// What kind of database to start.
	// Experimental.
	Engine IClusterEngine `json:"engine"`
	// The VPC that this Aurora Serverless cluster has been created in.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The number of days during which automatic DB snapshots are retained.
	//
	// Automatic backup retention cannot be disabled on serverless clusters.
	// Must be a value from 1 day to 35 days.
	// Experimental.
	BackupRetention awscdk.Duration `json:"backupRetention"`
	// An optional identifier for the cluster.
	// Experimental.
	ClusterIdentifier *string `json:"clusterIdentifier"`
	// Credentials for the administrative user.
	// Experimental.
	Credentials Credentials `json:"credentials"`
	// Name of a database which is automatically created inside the cluster.
	// Experimental.
	DefaultDatabaseName *string `json:"defaultDatabaseName"`
	// Indicates whether the DB cluster should have deletion protection enabled.
	// Experimental.
	DeletionProtection *bool `json:"deletionProtection"`
	// Whether to enable the Data API.
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
	//
	// Experimental.
	EnableDataApi *bool `json:"enableDataApi"`
	// Additional parameters to pass to the database engine.
	// Experimental.
	ParameterGroup IParameterGroup `json:"parameterGroup"`
	// The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// Scaling configuration of an Aurora Serverless database cluster.
	// Experimental.
	Scaling *ServerlessScalingOptions `json:"scaling"`
	// Security group.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// The KMS key for storage encryption.
	// Experimental.
	StorageEncryptionKey awskms.IKey `json:"storageEncryptionKey"`
	// Existing subnet group for the cluster.
	// Experimental.
	SubnetGroup ISubnetGroup `json:"subnetGroup"`
	// Where to place the instances within the VPC.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Properties to configure an Aurora Serverless Cluster.

TODO: EXAMPLE

Experimental.

type ServerlessScalingOptions

type ServerlessScalingOptions struct {
	// The time before an Aurora Serverless database cluster is paused.
	//
	// A database cluster can be paused only when it is idle (it has no connections).
	// Auto pause time must be between 5 minutes and 1 day.
	//
	// If a DB cluster is paused for more than seven days, the DB cluster might be
	// backed up with a snapshot. In this case, the DB cluster is restored when there
	// is a request to connect to it.
	//
	// Set to 0 to disable
	// Experimental.
	AutoPause awscdk.Duration `json:"autoPause"`
	// The maximum capacity for an Aurora Serverless database cluster.
	// Experimental.
	MaxCapacity AuroraCapacityUnit `json:"maxCapacity"`
	// The minimum capacity for an Aurora Serverless database cluster.
	// Experimental.
	MinCapacity AuroraCapacityUnit `json:"minCapacity"`
}

Options for configuring scaling on an Aurora Serverless cluster.

TODO: EXAMPLE

Experimental.

type SessionPinningFilter

type SessionPinningFilter interface {
	FilterName() *string
}

SessionPinningFilter.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy-pinning

Experimental.

func SessionPinningFilter_EXCLUDE_VARIABLE_SETS

func SessionPinningFilter_EXCLUDE_VARIABLE_SETS() SessionPinningFilter

func SessionPinningFilter_Of

func SessionPinningFilter_Of(filterName *string) SessionPinningFilter

custom filter. Experimental.

type SnapshotCredentials

type SnapshotCredentials interface {
	EncryptionKey() awskms.IKey
	ExcludeCharacters() *string
	GeneratePassword() *bool
	Password() awscdk.SecretValue
	ReplaceOnPasswordCriteriaChanges() *bool
	ReplicaRegions() *[]*awssecretsmanager.ReplicaRegion
	Secret() awssecretsmanager.Secret
	Username() *string
}

Credentials to update the password for a “DatabaseInstanceFromSnapshot“.

TODO: EXAMPLE

Experimental.

func SnapshotCredentials_FromGeneratedSecret

func SnapshotCredentials_FromGeneratedSecret(username *string, options *SnapshotCredentialsFromGeneratedPasswordOptions) SnapshotCredentials

Generate a new password for the snapshot, using the existing username and an optional encryption key.

The new credentials are stored in Secrets Manager.

Note - The username must match the existing master username of the snapshot. Experimental.

func SnapshotCredentials_FromPassword

func SnapshotCredentials_FromPassword(password awscdk.SecretValue) SnapshotCredentials

Update the snapshot login with an existing password. Experimental.

func SnapshotCredentials_FromSecret

func SnapshotCredentials_FromSecret(secret awssecretsmanager.Secret) SnapshotCredentials

Update the snapshot login with an existing password from a Secret.

The Secret must be a JSON string with a “password“ field: ```

{
   ...
   "password": <required: password>,
}

``` Experimental.

type SnapshotCredentialsFromGeneratedPasswordOptions

type SnapshotCredentialsFromGeneratedPasswordOptions struct {
	// KMS encryption key to encrypt the generated secret.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// The characters to exclude from the generated password.
	// Experimental.
	ExcludeCharacters *string `json:"excludeCharacters"`
	// A list of regions where to replicate this secret.
	// Experimental.
	ReplicaRegions *[]*awssecretsmanager.ReplicaRegion `json:"replicaRegions"`
}

Options used in the {@link SnapshotCredentials.fromGeneratedPassword} method.

TODO: EXAMPLE

Experimental.

type SqlServerEeInstanceEngineProps

type SqlServerEeInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version SqlServerEngineVersion `json:"version"`
}

Properties for SQL Server Enterprise Edition instance engines.

Used in {@link DatabaseInstanceEngine.sqlServerEe}.

TODO: EXAMPLE

Experimental.

type SqlServerEngineVersion

type SqlServerEngineVersion interface {
	SqlServerFullVersion() *string
	SqlServerMajorVersion() *string
}

The versions for the SQL Server instance engines (those returned by {@link DatabaseInstanceEngine.sqlServerSe}, {@link DatabaseInstanceEngine.sqlServerEx}, {@link DatabaseInstanceEngine.sqlServerWeb} and {@link DatabaseInstanceEngine.sqlServerEe}).

TODO: EXAMPLE

Experimental.

func SqlServerEngineVersion_Of

func SqlServerEngineVersion_Of(sqlServerFullVersion *string, sqlServerMajorVersion *string) SqlServerEngineVersion

Create a new SqlServerEngineVersion with an arbitrary version. Experimental.

func SqlServerEngineVersion_VER_11

func SqlServerEngineVersion_VER_11() SqlServerEngineVersion

func SqlServerEngineVersion_VER_11_00_5058_0_V1

func SqlServerEngineVersion_VER_11_00_5058_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_11_00_6020_0_V1

func SqlServerEngineVersion_VER_11_00_6020_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_11_00_6594_0_V1

func SqlServerEngineVersion_VER_11_00_6594_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_11_00_7462_6_V1

func SqlServerEngineVersion_VER_11_00_7462_6_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_11_00_7493_4_V1

func SqlServerEngineVersion_VER_11_00_7493_4_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_12

func SqlServerEngineVersion_VER_12() SqlServerEngineVersion

func SqlServerEngineVersion_VER_12_00_5000_0_V1

func SqlServerEngineVersion_VER_12_00_5000_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_12_00_5546_0_V1

func SqlServerEngineVersion_VER_12_00_5546_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_12_00_5571_0_V1

func SqlServerEngineVersion_VER_12_00_5571_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_12_00_6293_0_V1

func SqlServerEngineVersion_VER_12_00_6293_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_12_00_6329_1_V1

func SqlServerEngineVersion_VER_12_00_6329_1_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13

func SqlServerEngineVersion_VER_13() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_2164_0_V1

func SqlServerEngineVersion_VER_13_00_2164_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_4422_0_V1

func SqlServerEngineVersion_VER_13_00_4422_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_4451_0_V1

func SqlServerEngineVersion_VER_13_00_4451_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_4466_4_V1

func SqlServerEngineVersion_VER_13_00_4466_4_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_4522_0_V1

func SqlServerEngineVersion_VER_13_00_4522_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5216_0_V1

func SqlServerEngineVersion_VER_13_00_5216_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5292_0_V1

func SqlServerEngineVersion_VER_13_00_5292_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5366_0_V1

func SqlServerEngineVersion_VER_13_00_5366_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5426_0_V1

func SqlServerEngineVersion_VER_13_00_5426_0_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5598_27_V1

func SqlServerEngineVersion_VER_13_00_5598_27_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5820_21_V1

func SqlServerEngineVersion_VER_13_00_5820_21_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5850_14_V1

func SqlServerEngineVersion_VER_13_00_5850_14_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_13_00_5882_1_V1

func SqlServerEngineVersion_VER_13_00_5882_1_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14

func SqlServerEngineVersion_VER_14() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_1000_169_V1

func SqlServerEngineVersion_VER_14_00_1000_169_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3015_40_V1

func SqlServerEngineVersion_VER_14_00_3015_40_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3035_2_V1

func SqlServerEngineVersion_VER_14_00_3035_2_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3049_1_V1

func SqlServerEngineVersion_VER_14_00_3049_1_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3192_2_V1

func SqlServerEngineVersion_VER_14_00_3192_2_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3223_3_V1

func SqlServerEngineVersion_VER_14_00_3223_3_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3281_6_V1

func SqlServerEngineVersion_VER_14_00_3281_6_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3294_2_V1

func SqlServerEngineVersion_VER_14_00_3294_2_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3356_20_V1

func SqlServerEngineVersion_VER_14_00_3356_20_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_14_00_3381_3_V1

func SqlServerEngineVersion_VER_14_00_3381_3_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_15

func SqlServerEngineVersion_VER_15() SqlServerEngineVersion

func SqlServerEngineVersion_VER_15_00_4043_16_V1

func SqlServerEngineVersion_VER_15_00_4043_16_V1() SqlServerEngineVersion

func SqlServerEngineVersion_VER_15_00_4073_23_V1

func SqlServerEngineVersion_VER_15_00_4073_23_V1() SqlServerEngineVersion

type SqlServerExInstanceEngineProps

type SqlServerExInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version SqlServerEngineVersion `json:"version"`
}

Properties for SQL Server Express Edition instance engines.

Used in {@link DatabaseInstanceEngine.sqlServerEx}.

TODO: EXAMPLE

Experimental.

type SqlServerSeInstanceEngineProps

type SqlServerSeInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version SqlServerEngineVersion `json:"version"`
}

Properties for SQL Server Standard Edition instance engines.

Used in {@link DatabaseInstanceEngine.sqlServerSe}.

TODO: EXAMPLE

Experimental.

type SqlServerWebInstanceEngineProps

type SqlServerWebInstanceEngineProps struct {
	// The exact version of the engine to use.
	// Experimental.
	Version SqlServerEngineVersion `json:"version"`
}

Properties for SQL Server Web Edition instance engines.

Used in {@link DatabaseInstanceEngine.sqlServerWeb}.

TODO: EXAMPLE

Experimental.

type StorageType

type StorageType string

The type of storage. Experimental.

const (
	StorageType_GP2      StorageType = "GP2"
	StorageType_IO1      StorageType = "IO1"
	StorageType_STANDARD StorageType = "STANDARD"
)

type SubnetGroup

type SubnetGroup interface {
	awscdk.Resource
	ISubnetGroup
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	SubnetGroupName() *string
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

Class for creating a RDS DB subnet group.

TODO: EXAMPLE

Experimental.

func NewSubnetGroup

func NewSubnetGroup(scope constructs.Construct, id *string, props *SubnetGroupProps) SubnetGroup

Experimental.

type SubnetGroupProps

type SubnetGroupProps struct {
	// Description of the subnet group.
	// Experimental.
	Description *string `json:"description"`
	// The removal policy to apply when the subnet group are removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// The name of the subnet group.
	// Experimental.
	SubnetGroupName *string `json:"subnetGroupName"`
	// The VPC to place the subnet group in.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// Which subnets within the VPC to associate with this group.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Properties for creating a SubnetGroup.

TODO: EXAMPLE

Experimental.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL