class CfnCloudAutonomousVmCluster (construct)

Language	Type name
.NET	Amazon.CDK.aws_odb.CfnCloudAutonomousVmCluster
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsodb#CfnCloudAutonomousVmCluster
Java	software.amazon.awscdk.services.odb.CfnCloudAutonomousVmCluster
Python	aws_cdk.aws_odb.CfnCloudAutonomousVmCluster
TypeScript	aws-cdk-lib » aws_odb » CfnCloudAutonomousVmCluster

Implements IConstruct, IDependable, IInspectable, ITaggableV2

The AWS::ODB::CloudAutonomousVmCluster resource creates an Autonomous VM cluster.

An Autonomous VM cluster provides the infrastructure for running Autonomous Databases.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_odb as odb } from 'aws-cdk-lib';
const cfnCloudAutonomousVmCluster = new odb.CfnCloudAutonomousVmCluster(this, 'MyCfnCloudAutonomousVmCluster', /* all optional props */ {
  autonomousDataStorageSizeInTBs: 123,
  cloudExadataInfrastructureId: 'cloudExadataInfrastructureId',
  cpuCoreCountPerNode: 123,
  dbServers: ['dbServers'],
  description: 'description',
  displayName: 'displayName',
  isMtlsEnabledVmCluster: false,
  licenseModel: 'licenseModel',
  maintenanceWindow: {
    daysOfWeek: ['daysOfWeek'],
    hoursOfDay: [123],
    leadTimeInWeeks: 123,
    months: ['months'],
    preference: 'preference',
    weeksOfMonth: [123],
  },
  memoryPerOracleComputeUnitInGBs: 123,
  odbNetworkId: 'odbNetworkId',
  scanListenerPortNonTls: 123,
  scanListenerPortTls: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeZone: 'timeZone',
  totalContainerDatabases: 123,
});

Initializer

new CfnCloudAutonomousVmCluster(scope: Construct, id: string, props?: CfnCloudAutonomousVmClusterProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnCloudAutonomousVmClusterProps — Resource properties.

Construct Props

Name	Type	Description
autonomousDataStorageSizeInTBs?	number	The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
cloudExadataInfrastructureId?	string	The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
cpuCoreCountPerNode?	number	The number of CPU cores enabled per node in the Autonomous VM cluster.
dbServers?	string[]	The list of database servers associated with the Autonomous VM cluster.
description?	string	The user-provided description of the Autonomous VM cluster.
displayName?	string	The display name of the Autonomous VM cluster.
isMtlsEnabledVmCluster?	boolean | IResolvable	Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
licenseModel?	string	The Oracle license model that applies to the Autonomous VM cluster.
maintenanceWindow?	IResolvable | MaintenanceWindowProperty	The scheduling details for the maintenance window.
memoryPerOracleComputeUnitInGBs?	number	The amount of memory allocated per Oracle Compute Unit, in GB.
odbNetworkId?	string	The unique identifier of the ODB network associated with this Autonomous VM cluster.
scanListenerPortNonTls?	number	The SCAN listener port for non-TLS (TCP) protocol.
scanListenerPortTls?	number	The SCAN listener port for TLS (TCP) protocol.
tags?	CfnTag[]	Tags to assign to the Autonomous Vm Cluster.
timeZone?	string	The time zone of the Autonomous VM cluster.
totalContainerDatabases?	number	The total number of Autonomous Container Databases that can be created with the allocated local storage.

---

autonomousDataStorageSizeInTBs?

Type: number (optional)

The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.

Required when creating an Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-autonomousdatastoragesizeintbs

---

cloudExadataInfrastructureId?

Type: string (optional)

The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.

Required when creating an Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-cloudexadatainfrastructureid

---

cpuCoreCountPerNode?

Type: number (optional)

The number of CPU cores enabled per node in the Autonomous VM cluster.

Required when creating an Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-cpucorecountpernode

---

dbServers?

Type: string[] (optional)

The list of database servers associated with the Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-dbservers

---

description?

Type: string (optional)

The user-provided description of the Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-description

---

displayName?

Type: string (optional)

The display name of the Autonomous VM cluster.

Required when creating an Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-displayname

---

isMtlsEnabledVmCluster?

Type: boolean | IResolvable (optional)

Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-ismtlsenabledvmcluster

---

licenseModel?

Type: string (optional)

The Oracle license model that applies to the Autonomous VM cluster.

Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-licensemodel

---

maintenanceWindow?

Type: IResolvable | MaintenanceWindowProperty (optional)

The scheduling details for the maintenance window.

Patching and system updates take place during the maintenance window.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow

---

memoryPerOracleComputeUnitInGBs?

Type: number (optional)

The amount of memory allocated per Oracle Compute Unit, in GB.

Required when creating an Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-memoryperoraclecomputeunitingbs

---

odbNetworkId?

Type: string (optional)

The unique identifier of the ODB network associated with this Autonomous VM cluster.

Required when creating an Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-odbnetworkid

---

scanListenerPortNonTls?

Type: number (optional)

The SCAN listener port for non-TLS (TCP) protocol.

The default is 1521.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-scanlistenerportnontls

---

scanListenerPortTls?

Type: number (optional)

The SCAN listener port for TLS (TCP) protocol.

The default is 2484.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-scanlistenerporttls

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the Autonomous Vm Cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-tags

---

timeZone?

Type: string (optional)

The time zone of the Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-timezone

---

totalContainerDatabases?

Type: number (optional)

The total number of Autonomous Container Databases that can be created with the allocated local storage.

Required when creating an Autonomous VM cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-totalcontainerdatabases

Properties

Name	Type	Description
attrAutonomousDataStoragePercentage	IResolvable	The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.
attrAvailableAutonomousDataStorageSizeInTBs	IResolvable	The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB.
attrAvailableContainerDatabases	number	The number of Autonomous CDBs that you can create with the currently available storage.
attrAvailableCpus	IResolvable	The number of CPU cores available for allocation to Autonomous Databases.
attrCloudAutonomousVmClusterArn	string	The Amazon Resource Name (ARN) for the Autonomous VM cluster.
attrCloudAutonomousVmClusterId	string	The unique identifier of the Autonomous VM cluster.
attrComputeModel	string	The compute model of the Autonomous VM cluster: ECPU or OCPU.
attrCpuCoreCount	number	The total number of CPU cores in the Autonomous VM cluster.
attrCpuPercentage	IResolvable	The percentage of total CPU cores currently in use in the Autonomous VM cluster.
attrDataStorageSizeInGBs	IResolvable	The total data storage allocated to the Autonomous VM cluster, in GB.
attrDataStorageSizeInTBs	IResolvable	The total data storage allocated to the Autonomous VM cluster, in TB.
attrDbNodeStorageSizeInGBs	number	The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB).
attrDomain	string	The domain name for the Autonomous VM cluster.
attrExadataStorageInTBsLowestScaledValue	IResolvable	The minimum value to which you can scale down the Exadata storage, in TB.
attrHostname	string	The hostname for the Autonomous VM cluster.
attrMaxAcdsLowestScaledValue	number	The minimum value to which you can scale down the maximum number of Autonomous CDBs.
attrMemorySizeInGBs	number	The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB).
attrNodeCount	number	The number of database server nodes in the Autonomous VM cluster.
attrNonProvisionableAutonomousContainerDatabases	number	The number of Autonomous CDBs that can't be provisioned because of resource constraints.
attrOciResourceAnchorName	string	The name of the OCI resource anchor associated with this Autonomous VM cluster.
attrOciUrl	string	The URL for accessing the OCI console page for this Autonomous VM cluster.
attrOcid	string	The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.
attrProvisionableAutonomousContainerDatabases	number	The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster.
attrProvisionedAutonomousContainerDatabases	number	The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster.
attrProvisionedCpus	IResolvable	The number of CPU cores currently provisioned in the Autonomous VM cluster.
attrReclaimableCpus	IResolvable	The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases.
attrReservedCpus	IResolvable	The number of CPU cores reserved for system operations and redundancy.
attrShape	string	The shape of the Exadata infrastructure for the Autonomous VM cluster.
cdkTagManager	TagManager	Tag Manager which manages the tags for this resource.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
autonomousDataStorageSizeInTBs?	number	The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
cloudExadataInfrastructureId?	string	The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
cpuCoreCountPerNode?	number	The number of CPU cores enabled per node in the Autonomous VM cluster.
dbServers?	string[]	The list of database servers associated with the Autonomous VM cluster.
description?	string	The user-provided description of the Autonomous VM cluster.
displayName?	string	The display name of the Autonomous VM cluster.
isMtlsEnabledVmCluster?	boolean | IResolvable	Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
licenseModel?	string	The Oracle license model that applies to the Autonomous VM cluster.
maintenanceWindow?	IResolvable | MaintenanceWindowProperty	The scheduling details for the maintenance window.
memoryPerOracleComputeUnitInGBs?	number	The amount of memory allocated per Oracle Compute Unit, in GB.
odbNetworkId?	string	The unique identifier of the ODB network associated with this Autonomous VM cluster.
scanListenerPortNonTls?	number	The SCAN listener port for non-TLS (TCP) protocol.
scanListenerPortTls?	number	The SCAN listener port for TLS (TCP) protocol.
tags?	CfnTag[]	Tags to assign to the Autonomous Vm Cluster.
timeZone?	string	The time zone of the Autonomous VM cluster.
totalContainerDatabases?	number	The total number of Autonomous Container Databases that can be created with the allocated local storage.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrAutonomousDataStoragePercentage

Type: IResolvable

The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.

---

attrAvailableAutonomousDataStorageSizeInTBs

Type: IResolvable

The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB.

---

attrAvailableContainerDatabases

Type: number

The number of Autonomous CDBs that you can create with the currently available storage.

---

attrAvailableCpus

Type: IResolvable

The number of CPU cores available for allocation to Autonomous Databases.

---

attrCloudAutonomousVmClusterArn

Type: string

The Amazon Resource Name (ARN) for the Autonomous VM cluster.

---

attrCloudAutonomousVmClusterId

Type: string

The unique identifier of the Autonomous VM cluster.

---

attrComputeModel

Type: string

The compute model of the Autonomous VM cluster: ECPU or OCPU.

---

attrCpuCoreCount

Type: number

The total number of CPU cores in the Autonomous VM cluster.

---

attrCpuPercentage

Type: IResolvable

The percentage of total CPU cores currently in use in the Autonomous VM cluster.

---

attrDataStorageSizeInGBs

Type: IResolvable

The total data storage allocated to the Autonomous VM cluster, in GB.

---

attrDataStorageSizeInTBs

Type: IResolvable

The total data storage allocated to the Autonomous VM cluster, in TB.

---

attrDbNodeStorageSizeInGBs

Type: number

The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB).

---

attrDomain

Type: string

The domain name for the Autonomous VM cluster.

---

attrExadataStorageInTBsLowestScaledValue

Type: IResolvable

The minimum value to which you can scale down the Exadata storage, in TB.

---

attrHostname

Type: string

The hostname for the Autonomous VM cluster.

---

attrMaxAcdsLowestScaledValue

Type: number

The minimum value to which you can scale down the maximum number of Autonomous CDBs.

---

attrMemorySizeInGBs

Type: number

The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB).

---

attrNodeCount

Type: number

The number of database server nodes in the Autonomous VM cluster.

---

attrNonProvisionableAutonomousContainerDatabases

Type: number

The number of Autonomous CDBs that can't be provisioned because of resource constraints.

---

attrOciResourceAnchorName

Type: string

The name of the OCI resource anchor associated with this Autonomous VM cluster.

---

attrOciUrl

Type: string

The URL for accessing the OCI console page for this Autonomous VM cluster.

---

attrOcid

Type: string

The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.

---

attrProvisionableAutonomousContainerDatabases

Type: number

The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster.

---

attrProvisionedAutonomousContainerDatabases

Type: number

The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster.

---

attrProvisionedCpus

Type: IResolvable

The number of CPU cores currently provisioned in the Autonomous VM cluster.

---

attrReclaimableCpus

Type: IResolvable

The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases.

---

attrReservedCpus

Type: IResolvable

The number of CPU cores reserved for system operations and redundancy.

---

attrShape

Type: string

The shape of the Exadata infrastructure for the Autonomous VM cluster.

---

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

---

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: Node

The tree node.

---

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).

---

autonomousDataStorageSizeInTBs?

Type: number (optional)

The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.

---

cloudExadataInfrastructureId?

Type: string (optional)

The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.

---

cpuCoreCountPerNode?

Type: number (optional)

The number of CPU cores enabled per node in the Autonomous VM cluster.

---

dbServers?

Type: string[] (optional)

The list of database servers associated with the Autonomous VM cluster.

---

description?

Type: string (optional)

The user-provided description of the Autonomous VM cluster.

---

displayName?

Type: string (optional)

The display name of the Autonomous VM cluster.

---

isMtlsEnabledVmCluster?

Type: boolean | IResolvable (optional)

Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.

---

licenseModel?

Type: string (optional)

The Oracle license model that applies to the Autonomous VM cluster.

---

maintenanceWindow?

Type: IResolvable | MaintenanceWindowProperty (optional)

The scheduling details for the maintenance window.

---

memoryPerOracleComputeUnitInGBs?

Type: number (optional)

The amount of memory allocated per Oracle Compute Unit, in GB.

---

odbNetworkId?

Type: string (optional)

The unique identifier of the ODB network associated with this Autonomous VM cluster.

---

scanListenerPortNonTls?

Type: number (optional)

The SCAN listener port for non-TLS (TCP) protocol.

---

scanListenerPortTls?

Type: number (optional)

The SCAN listener port for TLS (TCP) protocol.

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the Autonomous Vm Cluster.

---

timeZone?

Type: string (optional)

The time zone of the Autonomous VM cluster.

---

totalContainerDatabases?

Type: number (optional)

The total number of Autonomous Container Databases that can be created with the allocated local storage.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
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, typeHint?)	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.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
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).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

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.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

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

---

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

• policy RemovalPolicy
• options RemovalPolicyOptions

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

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.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

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.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

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 }