1.204.0

class CfnDBCluster (construct)

LanguageType name
.NETAmazon.CDK.AWS.Neptune.CfnDBCluster
Javasoftware.amazon.awscdk.services.neptune.CfnDBCluster
Pythonaws_cdk.aws_neptune.CfnDBCluster
TypeScript @aws-cdk/aws-neptune » CfnDBCluster

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Neptune::DBCluster.

The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.

Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.

If no DeletionPolicy is set for AWS::Neptune::DBCluster resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy should be set to Snapshot . For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute .

You can use AWS::Neptune::DBCluster.DeletionProtection to help guard against unintended deletion of your DB cluster.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as neptune from '@aws-cdk/aws-neptune';
const cfnDBCluster = new neptune.CfnDBCluster(this, 'MyCfnDBCluster', /* all optional props */ {
  associatedRoles: [{
    roleArn: 'roleArn',

    // the properties below are optional
    featureName: 'featureName',
  }],
  availabilityZones: ['availabilityZones'],
  backupRetentionPeriod: 123,
  copyTagsToSnapshot: false,
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  dbInstanceParameterGroupName: 'dbInstanceParameterGroupName',
  dbSubnetGroupName: 'dbSubnetGroupName',
  deletionProtection: false,
  enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],
  engineVersion: 'engineVersion',
  iamAuthEnabled: false,
  kmsKeyId: 'kmsKeyId',
  port: 123,
  preferredBackupWindow: 'preferredBackupWindow',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  restoreToTime: 'restoreToTime',
  restoreType: 'restoreType',
  serverlessScalingConfiguration: {
    maxCapacity: 123,
    minCapacity: 123,
  },
  snapshotIdentifier: 'snapshotIdentifier',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  useLatestRestorableTime: false,
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});

Initializer

new CfnDBCluster(scope: Construct, id: string, props?: CfnDBClusterProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnDBClusterProps — - resource properties.

Create a new AWS::Neptune::DBCluster.

Construct Props

NameTypeDescription
associatedRoles?IResolvable | DBClusterRoleProperty | IResolvable[]Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
availabilityZones?string[]Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
backupRetentionPeriod?numberSpecifies the number of days for which automatic DB snapshots are retained.
copyTagsToSnapshot?boolean | IResolvableIf set to true , tags are copied to any snapshot of the DB cluster that is created..
dbClusterIdentifier?stringContains a user-supplied DB cluster identifier.
dbClusterParameterGroupName?stringProvides the name of the DB cluster parameter group.
dbInstanceParameterGroupName?stringThe name of the DB parameter group to apply to all instances of the DB cluster.
dbSubnetGroupName?stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
deletionProtection?boolean | IResolvableIndicates whether or not the DB cluster has deletion protection enabled.
enableCloudwatchLogsExports?string[]Specifies a list of log types that are enabled for export to CloudWatch Logs.
engineVersion?stringIndicates the database engine version.
iamAuthEnabled?boolean | IResolvableTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
kmsKeyId?stringIf StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.
port?numberAWS::Neptune::DBCluster.Port.
preferredBackupWindow?stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
preferredMaintenanceWindow?stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
restoreToTime?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
restoreType?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
serverlessScalingConfiguration?IResolvable | ServerlessScalingConfigurationPropertyAWS::Neptune::DBCluster.ServerlessScalingConfiguration.
snapshotIdentifier?stringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
sourceDbClusterIdentifier?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
storageEncrypted?boolean | IResolvableIndicates whether the DB cluster is encrypted.
tags?CfnTag[]The tags assigned to this cluster.
useLatestRestorableTime?boolean | IResolvableCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
vpcSecurityGroupIds?string[]Provides a list of VPC security groups that the DB cluster belongs to.

associatedRoles?

Type: IResolvable | DBClusterRoleProperty | IResolvable[] (optional)

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

availabilityZones?

Type: string[] (optional)

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backupRetentionPeriod?

Type: number (optional)

Specifies the number of days for which automatic DB snapshots are retained.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

copyTagsToSnapshot?

Type: boolean | IResolvable (optional)

If set to true , tags are copied to any snapshot of the DB cluster that is created..

dbClusterIdentifier?

Type: string (optional)

Contains a user-supplied DB cluster identifier.

This identifier is the unique key that identifies a DB cluster.

dbClusterParameterGroupName?

Type: string (optional)

Provides the name of the DB cluster parameter group.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

dbInstanceParameterGroupName?

Type: string (optional)

The name of the DB parameter group to apply to all instances of the DB cluster.

Used only in case of a major engine version upgrade request

Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window.

Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

  • The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.

dbSubnetGroupName?

Type: string (optional)

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletionProtection?

Type: boolean | IResolvable (optional)

Indicates whether or not the DB cluster has deletion protection enabled.

The database can't be deleted when deletion protection is enabled.

enableCloudwatchLogsExports?

Type: string[] (optional)

Specifies a list of log types that are enabled for export to CloudWatch Logs.

engineVersion?

Type: string (optional)

Indicates the database engine version.

iamAuthEnabled?

Type: boolean | IResolvable (optional)

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kmsKeyId?

Type: string (optional)

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

port?

Type: number (optional)

AWS::Neptune::DBCluster.Port.

preferredBackupWindow?

Type: string (optional)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

An update may require some interruption.

preferredMaintenanceWindow?

Type: string (optional)

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

restoreToTime?

Type: string (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

restoreType?

Type: string (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

serverlessScalingConfiguration?

Type: IResolvable | ServerlessScalingConfigurationProperty (optional)

AWS::Neptune::DBCluster.ServerlessScalingConfiguration.

snapshotIdentifier?

Type: string (optional)

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.

sourceDbClusterIdentifier?

Type: string (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

storageEncrypted?

Type: boolean | IResolvable (optional)

Indicates whether the DB cluster is encrypted.

If you specify the DBClusterIdentifier , DBSnapshotIdentifier , or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.

If you specify the KmsKeyId , you must enable encryption by setting StorageEncrypted to true.

tags?

Type: CfnTag[] (optional)

The tags assigned to this cluster.

useLatestRestorableTime?

Type: boolean | IResolvable (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

vpcSecurityGroupIds?

Type: string[] (optional)

Provides a list of VPC security groups that the DB cluster belongs to.

Properties

NameTypeDescription
attrClusterResourceIdstringThe resource id for the DB cluster.
attrEndpointstringThe connection endpoint for the DB cluster.
attrPortstringThe port number on which the DB cluster accepts connections.
attrReadEndpointstringThe reader endpoint for the DB cluster.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerThe tags assigned to this cluster.
associatedRoles?IResolvable | DBClusterRoleProperty | IResolvable[]Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
availabilityZones?string[]Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
backupRetentionPeriod?numberSpecifies the number of days for which automatic DB snapshots are retained.
copyTagsToSnapshot?boolean | IResolvableIf set to true , tags are copied to any snapshot of the DB cluster that is created..
dbClusterIdentifier?stringContains a user-supplied DB cluster identifier.
dbClusterParameterGroupName?stringProvides the name of the DB cluster parameter group.
dbInstanceParameterGroupName?stringThe name of the DB parameter group to apply to all instances of the DB cluster.
dbSubnetGroupName?stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
deletionProtection?boolean | IResolvableIndicates whether or not the DB cluster has deletion protection enabled.
enableCloudwatchLogsExports?string[]Specifies a list of log types that are enabled for export to CloudWatch Logs.
engineVersion?stringIndicates the database engine version.
iamAuthEnabled?boolean | IResolvableTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
kmsKeyId?stringIf StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.
port?numberAWS::Neptune::DBCluster.Port.
preferredBackupWindow?stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
preferredMaintenanceWindow?stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
restoreToTime?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
restoreType?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
serverlessScalingConfiguration?IResolvable | ServerlessScalingConfigurationPropertyAWS::Neptune::DBCluster.ServerlessScalingConfiguration.
snapshotIdentifier?stringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
sourceDbClusterIdentifier?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
storageEncrypted?boolean | IResolvableIndicates whether the DB cluster is encrypted.
useLatestRestorableTime?boolean | IResolvableCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
vpcSecurityGroupIds?string[]Provides a list of VPC security groups that the DB cluster belongs to.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrClusterResourceId

Type: string

The resource id for the DB cluster.

For example: cluster-ABCD1234EFGH5678IJKL90MNOP . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

attrEndpoint

Type: string

The connection endpoint for the DB cluster.

For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

attrPort

Type: string

The port number on which the DB cluster accepts connections.

For example: 8182 .

attrReadEndpoint

Type: string

The reader endpoint for the DB cluster.

For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

The tags assigned to this cluster.

associatedRoles?

Type: IResolvable | DBClusterRoleProperty | IResolvable[] (optional)

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

availabilityZones?

Type: string[] (optional)

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backupRetentionPeriod?

Type: number (optional)

Specifies the number of days for which automatic DB snapshots are retained.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

copyTagsToSnapshot?

Type: boolean | IResolvable (optional)

If set to true , tags are copied to any snapshot of the DB cluster that is created..

dbClusterIdentifier?

Type: string (optional)

Contains a user-supplied DB cluster identifier.

This identifier is the unique key that identifies a DB cluster.

dbClusterParameterGroupName?

Type: string (optional)

Provides the name of the DB cluster parameter group.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

dbInstanceParameterGroupName?

Type: string (optional)

The name of the DB parameter group to apply to all instances of the DB cluster.

Used only in case of a major engine version upgrade request

Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window.

Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

  • The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.

dbSubnetGroupName?

Type: string (optional)

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletionProtection?

Type: boolean | IResolvable (optional)

Indicates whether or not the DB cluster has deletion protection enabled.

The database can't be deleted when deletion protection is enabled.

enableCloudwatchLogsExports?

Type: string[] (optional)

Specifies a list of log types that are enabled for export to CloudWatch Logs.

engineVersion?

Type: string (optional)

Indicates the database engine version.

iamAuthEnabled?

Type: boolean | IResolvable (optional)

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kmsKeyId?

Type: string (optional)

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

port?

Type: number (optional)

AWS::Neptune::DBCluster.Port.

preferredBackupWindow?

Type: string (optional)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

An update may require some interruption.

preferredMaintenanceWindow?

Type: string (optional)

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

restoreToTime?

Type: string (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

restoreType?

Type: string (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

serverlessScalingConfiguration?

Type: IResolvable | ServerlessScalingConfigurationProperty (optional)

AWS::Neptune::DBCluster.ServerlessScalingConfiguration.

snapshotIdentifier?

Type: string (optional)

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.

sourceDbClusterIdentifier?

Type: string (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

storageEncrypted?

Type: boolean | IResolvable (optional)

Indicates whether the DB cluster is encrypted.

If you specify the DBClusterIdentifier , DBSnapshotIdentifier , or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.

If you specify the KmsKeyId , you must enable encryption by setting StorageEncrypted to true.

useLatestRestorableTime?

Type: boolean | IResolvable (optional)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

vpcSecurityGroupIds?

Type: string[] (optional)

Provides a list of VPC security groups that the DB cluster belongs to.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

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

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

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

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

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

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →