class CfnCloudVmCluster (construct)

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

Implements IConstruct, IDependable, IInspectable, ITaggableV2

The AWS::ODB::CloudVmCluster resource creates a VM cluster on the specified Exadata infrastructure in the Oracle Database.

A VM cluster provides the compute resources for Oracle Database workloads.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.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 cfnCloudVmCluster = new odb.CfnCloudVmCluster(this, 'MyCfnCloudVmCluster', /* all optional props */ {
  cloudExadataInfrastructureId: 'cloudExadataInfrastructureId',
  clusterName: 'clusterName',
  cpuCoreCount: 123,
  dataCollectionOptions: {
    isDiagnosticsEventsEnabled: false,
    isHealthMonitoringEnabled: false,
    isIncidentLogsEnabled: false,
  },
  dataStorageSizeInTBs: 123,
  dbNodeStorageSizeInGBs: 123,
  dbServers: ['dbServers'],
  displayName: 'displayName',
  giVersion: 'giVersion',
  hostname: 'hostname',
  isLocalBackupEnabled: false,
  isSparseDiskgroupEnabled: false,
  licenseModel: 'licenseModel',
  memorySizeInGBs: 123,
  odbNetworkId: 'odbNetworkId',
  scanListenerPortTcp: 123,
  sshPublicKeys: ['sshPublicKeys'],
  systemVersion: 'systemVersion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeZone: 'timeZone',
});

Initializer

new CfnCloudVmCluster(scope: Construct, id: string, props?: CfnCloudVmClusterProps)

Parameters

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

Construct Props

Name	Type	Description
cloudExadataInfrastructureId?	string	The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
clusterName?	string	The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount?	number	The number of CPU cores enabled on the VM cluster.
dataCollectionOptions?	IResolvable | DataCollectionOptionsProperty	The set of diagnostic collection options enabled for the VM cluster.
dataStorageSizeInTBs?	number	The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs?	number	The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers?	string[]	The list of database servers for the VM cluster.
displayName?	string	The user-friendly name for the VM cluster.
giVersion?	string	The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname?	string	The host name for the VM cluster.
isLocalBackupEnabled?	boolean | IResolvable	Specifies whether database backups to local Exadata storage are enabled for the VM cluster.
isSparseDiskgroupEnabled?	boolean | IResolvable	Specifies whether the VM cluster is configured with a sparse disk group.
licenseModel?	string	The Oracle license model applied to the VM cluster.
memorySizeInGBs?	number	The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
odbNetworkId?	string	The unique identifier of the ODB network for the VM cluster.
scanListenerPortTcp?	number	The port number for TCP connections to the single client access name (SCAN) listener.
sshPublicKeys?	string[]	The public key portion of one or more key pairs used for SSH access to the VM cluster.
systemVersion?	string	The operating system version of the image chosen for the VM cluster.
tags?	CfnTag[]	Tags to assign to the Vm Cluster.
timeZone?	string	The time zone of the VM cluster.

---

cloudExadataInfrastructureId?

Type: string (optional)

The unique identifier of the Exadata infrastructure that this VM cluster belongs to.

Required when creating a VM cluster.

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

---

clusterName?

Type: string (optional)

The name of the Grid Infrastructure (GI) cluster.

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

---

cpuCoreCount?

Type: number (optional)

The number of CPU cores enabled on the VM cluster.

Required when creating a VM cluster.

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

---

dataCollectionOptions?

Type: IResolvable | DataCollectionOptionsProperty (optional)

The set of diagnostic collection options enabled for the VM cluster.

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

---

dataStorageSizeInTBs?

Type: number (optional)

The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.

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

---

dbNodeStorageSizeInGBs?

Type: number (optional)

The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.

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

---

dbServers?

Type: string[] (optional)

The list of database servers for the VM cluster.

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

---

displayName?

Type: string (optional)

The user-friendly name for the VM cluster.

Required when creating a VM cluster.

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

---

giVersion?

Type: string (optional)

The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.

Required when creating a VM cluster.

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

---

hostname?

Type: string (optional)

The host name for the VM cluster.

Required when creating a VM cluster.

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

---

isLocalBackupEnabled?

Type: boolean | IResolvable (optional)

Specifies whether database backups to local Exadata storage are enabled for the VM cluster.

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

---

isSparseDiskgroupEnabled?

Type: boolean | IResolvable (optional)

Specifies whether the VM cluster is configured with a sparse disk group.

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

---

licenseModel?

Type: string (optional)

The Oracle license model applied to the VM cluster.

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

---

memorySizeInGBs?

Type: number (optional)

The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.

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

---

odbNetworkId?

Type: string (optional)

The unique identifier of the ODB network for the VM cluster.

Required when creating a VM cluster.

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

---

scanListenerPortTcp?

Type: number (optional)

The port number for TCP connections to the single client access name (SCAN) listener.

Valid values: 1024–8999 with the following exceptions: 2484 , 6100 , 6200 , 7060 , 7070 , 7085 , and 7879

Default: 1521

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

---

sshPublicKeys?

Type: string[] (optional)

The public key portion of one or more key pairs used for SSH access to the VM cluster.

Required when creating a VM cluster.

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

---

systemVersion?

Type: string (optional)

The operating system version of the image chosen for the VM cluster.

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

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the Vm Cluster.

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

---

timeZone?

Type: string (optional)

The time zone of the VM cluster.

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

Properties

Name	Type	Description
attrCloudVmClusterArn	string	The Amazon Resource Name (ARN) of the VM cluster.
attrCloudVmClusterId	string	The unique identifier of the VM cluster.
attrComputeModel	string	The OCI model compute model used when you create or clone an instance: ECPU or OCPU.
attrDiskRedundancy	string	The type of redundancy configured for the VM cluster.
attrDomain	string	The domain of the VM cluster.
attrListenerPort	number	The port number configured for the listener on the VM cluster.
attrNodeCount	number	The number of nodes in the VM cluster.
attrOciResourceAnchorName	string	The name of the OCI resource anchor for the VM cluster.
attrOciUrl	string	The HTTPS link to the VM cluster in OCI.
attrOcid	string	The OCID of the VM cluster.
attrScanDnsName	string	The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
attrScanIpIds	string[]	The OCID of the SCAN IP addresses that are associated with the VM cluster.
attrShape	string	The hardware model name of the Exadata infrastructure that's running the VM cluster.
attrStorageSizeInGBs	number	The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
attrVipIds	string[]	The virtual IP (VIP) addresses that are associated with the 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.
cloudExadataInfrastructureId?	string	The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
clusterName?	string	The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount?	number	The number of CPU cores enabled on the VM cluster.
dataCollectionOptions?	IResolvable | DataCollectionOptionsProperty	The set of diagnostic collection options enabled for the VM cluster.
dataStorageSizeInTBs?	number	The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs?	number	The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers?	string[]	The list of database servers for the VM cluster.
displayName?	string	The user-friendly name for the VM cluster.
giVersion?	string	The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname?	string	The host name for the VM cluster.
isLocalBackupEnabled?	boolean | IResolvable	Specifies whether database backups to local Exadata storage are enabled for the VM cluster.
isSparseDiskgroupEnabled?	boolean | IResolvable	Specifies whether the VM cluster is configured with a sparse disk group.
licenseModel?	string	The Oracle license model applied to the VM cluster.
memorySizeInGBs?	number	The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
odbNetworkId?	string	The unique identifier of the ODB network for the VM cluster.
scanListenerPortTcp?	number	The port number for TCP connections to the single client access name (SCAN) listener.
sshPublicKeys?	string[]	The public key portion of one or more key pairs used for SSH access to the VM cluster.
systemVersion?	string	The operating system version of the image chosen for the VM cluster.
tags?	CfnTag[]	Tags to assign to the Vm Cluster.
timeZone?	string	The time zone of the VM cluster.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrCloudVmClusterArn

Type: string

The Amazon Resource Name (ARN) of the VM cluster.

---

attrCloudVmClusterId

Type: string

The unique identifier of the VM cluster.

---

attrComputeModel

Type: string

The OCI model compute model used when you create or clone an instance: ECPU or OCPU.

An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.

---

attrDiskRedundancy

Type: string

The type of redundancy configured for the VM cluster.

NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

---

attrDomain

Type: string

The domain of the VM cluster.

---

attrListenerPort

Type: number

The port number configured for the listener on the VM cluster.

---

attrNodeCount

Type: number

The number of nodes in the VM cluster.

---

attrOciResourceAnchorName

Type: string

The name of the OCI resource anchor for the VM cluster.

---

attrOciUrl

Type: string

The HTTPS link to the VM cluster in OCI.

---

attrOcid

Type: string

The OCID of the VM cluster.

---

attrScanDnsName

Type: string

The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.

---

attrScanIpIds

Type: string[]

The OCID of the SCAN IP addresses that are associated with the VM cluster.

---

attrShape

Type: string

The hardware model name of the Exadata infrastructure that's running the VM cluster.

---

attrStorageSizeInGBs

Type: number

The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.

---

attrVipIds

Type: string[]

The virtual IP (VIP) addresses that are associated with the VM cluster.

Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the 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).

---

cloudExadataInfrastructureId?

Type: string (optional)

The unique identifier of the Exadata infrastructure that this VM cluster belongs to.

---

clusterName?

Type: string (optional)

The name of the Grid Infrastructure (GI) cluster.

---

cpuCoreCount?

Type: number (optional)

The number of CPU cores enabled on the VM cluster.

---

dataCollectionOptions?

Type: IResolvable | DataCollectionOptionsProperty (optional)

The set of diagnostic collection options enabled for the VM cluster.

---

dataStorageSizeInTBs?

Type: number (optional)

The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.

---

dbNodeStorageSizeInGBs?

Type: number (optional)

The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.

---

dbServers?

Type: string[] (optional)

The list of database servers for the VM cluster.

---

displayName?

Type: string (optional)

The user-friendly name for the VM cluster.

---

giVersion?

Type: string (optional)

The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.

---

hostname?

Type: string (optional)

The host name for the VM cluster.

---

isLocalBackupEnabled?

Type: boolean | IResolvable (optional)

Specifies whether database backups to local Exadata storage are enabled for the VM cluster.

---

isSparseDiskgroupEnabled?

Type: boolean | IResolvable (optional)

Specifies whether the VM cluster is configured with a sparse disk group.

---

licenseModel?

Type: string (optional)

The Oracle license model applied to the VM cluster.

---

memorySizeInGBs?

Type: number (optional)

The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.

---

odbNetworkId?

Type: string (optional)

The unique identifier of the ODB network for the VM cluster.

---

scanListenerPortTcp?

Type: number (optional)

The port number for TCP connections to the single client access name (SCAN) listener.

---

sshPublicKeys?

Type: string[] (optional)

The public key portion of one or more key pairs used for SSH access to the VM cluster.

---

systemVersion?

Type: string (optional)

The operating system version of the image chosen for the VM cluster.

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the Vm Cluster.

---

timeZone?

Type: string (optional)

The time zone of the VM cluster.

---

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 }