class CfnCloudExadataInfrastructure (construct)

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

Implements IConstruct, IDependable, IInspectable, ITaggableV2

The AWS::ODB::CloudExadataInfrastructure resource creates an Exadata infrastructure.

An Exadata infrastructure provides the underlying compute and storage resources for Oracle Database workloads.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.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 cfnCloudExadataInfrastructure = new odb.CfnCloudExadataInfrastructure(this, 'MyCfnCloudExadataInfrastructure', /* all optional props */ {
  availabilityZone: 'availabilityZone',
  availabilityZoneId: 'availabilityZoneId',
  computeCount: 123,
  customerContactsToSendToOci: [{
    email: 'email',
  }],
  databaseServerType: 'databaseServerType',
  displayName: 'displayName',
  shape: 'shape',
  storageCount: 123,
  storageServerType: 'storageServerType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnCloudExadataInfrastructure(scope: Construct, id: string, props?: CfnCloudExadataInfrastructureProps)

Parameters

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

Construct Props

Name	Type	Description
availabilityZone?	string	The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
availabilityZoneId?	string	The AZ ID of the AZ where the Exadata infrastructure is located.
computeCount?	number	The number of database servers for the Exadata infrastructure.
customerContactsToSendToOci?	IResolvable | IResolvable | CustomerContactProperty[]	The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
databaseServerType?	string	The database server model type of the Exadata infrastructure.
displayName?	string	The user-friendly name for the Exadata infrastructure.
shape?	string	The model name of the Exadata infrastructure.
storageCount?	number	The number of storage servers that are activated for the Exadata infrastructure.
storageServerType?	string	The storage server model type of the Exadata infrastructure.
tags?	CfnTag[]	Tags to assign to the Exadata Infrastructure.

---

availabilityZone?

Type: string (optional)

The name of the Availability Zone (AZ) where the Exadata infrastructure is located.

Required when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.

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

---

availabilityZoneId?

Type: string (optional)

The AZ ID of the AZ where the Exadata infrastructure is located.

Required when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.

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

---

computeCount?

Type: number (optional)

The number of database servers for the Exadata infrastructure.

Required when creating an Exadata infrastructure.

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

---

customerContactsToSendToOci?

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

The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.

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

---

databaseServerType?

Type: string (optional)

The database server model type of the Exadata infrastructure.

For the list of valid model names, use the ListDbSystemShapes operation.

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

---

displayName?

Type: string (optional)

The user-friendly name for the Exadata infrastructure.

Required when creating an Exadata infrastructure.

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

---

shape?

Type: string (optional)

The model name of the Exadata infrastructure.

Required when creating an Exadata infrastructure.

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

---

storageCount?

Type: number (optional)

The number of storage servers that are activated for the Exadata infrastructure.

Required when creating an Exadata infrastructure.

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

---

storageServerType?

Type: string (optional)

The storage server model type of the Exadata infrastructure.

For the list of valid model names, use the ListDbSystemShapes operation.

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

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the Exadata Infrastructure.

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

Properties

Name	Type	Description
attrActivatedStorageCount	number	The number of storage servers requested for the Exadata infrastructure.
attrAdditionalStorageCount	number	The number of storage servers requested for the Exadata infrastructure.
attrAvailableStorageSizeInGBs	number	The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.
attrCloudExadataInfrastructureArn	string	The Amazon Resource Name (ARN) for the Exadata infrastructure.
attrCloudExadataInfrastructureId	string	The unique identifier for the Exadata infrastructure.
attrComputeModel	string	The OCI model compute model used when you create or clone an instance: ECPU or OCPU.
attrCpuCount	number	The total number of CPU cores that are allocated to the Exadata infrastructure.
attrDataStorageSizeInTBs	IResolvable	The size of the Exadata infrastructure's data disk group, in terabytes (TB).
attrDbNodeStorageSizeInGBs	number	The size of the Exadata infrastructure's local node storage, in gigabytes (GB).
attrDbServerIds	string[]	The list of database server identifiers for the Exadata infrastructure.
attrDbServerVersion	string	The software version of the database servers (dom0) in the Exadata infrastructure.
attrMaxCpuCount	number	The total number of CPU cores available on the Exadata infrastructure.
attrMaxDataStorageInTBs	IResolvable	The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
attrMaxDbNodeStorageSizeInGBs	number	The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
attrMaxMemoryInGBs	number	The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.
attrMemorySizeInGBs	number	The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.
attrOciResourceAnchorName	string	The name of the OCI resource anchor for the Exadata infrastructure.
attrOciUrl	string	The HTTPS link to the Exadata infrastructure in OCI.
attrOcid	string	The OCID of the Exadata infrastructure.
attrStorageServerVersion	string	The software version of the storage servers on the Exadata infrastructure.
attrTotalStorageSizeInGBs	number	The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.
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.
availabilityZone?	string	The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
availabilityZoneId?	string	The AZ ID of the AZ where the Exadata infrastructure is located.
computeCount?	number	The number of database servers for the Exadata infrastructure.
customerContactsToSendToOci?	IResolvable | IResolvable | CustomerContactProperty[]	The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
databaseServerType?	string	The database server model type of the Exadata infrastructure.
displayName?	string	The user-friendly name for the Exadata infrastructure.
shape?	string	The model name of the Exadata infrastructure.
storageCount?	number	The number of storage servers that are activated for the Exadata infrastructure.
storageServerType?	string	The storage server model type of the Exadata infrastructure.
tags?	CfnTag[]	Tags to assign to the Exadata Infrastructure.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrActivatedStorageCount

Type: number

The number of storage servers requested for the Exadata infrastructure.

---

attrAdditionalStorageCount

Type: number

The number of storage servers requested for the Exadata infrastructure.

---

attrAvailableStorageSizeInGBs

Type: number

The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.

---

attrCloudExadataInfrastructureArn

Type: string

The Amazon Resource Name (ARN) for the Exadata infrastructure.

---

attrCloudExadataInfrastructureId

Type: string

The unique identifier for the Exadata infrastructure.

---

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.

---

attrCpuCount

Type: number

The total number of CPU cores that are allocated to the Exadata infrastructure.

---

attrDataStorageSizeInTBs

Type: IResolvable

The size of the Exadata infrastructure's data disk group, in terabytes (TB).

---

attrDbNodeStorageSizeInGBs

Type: number

The size of the Exadata infrastructure's local node storage, in gigabytes (GB).

---

attrDbServerIds

Type: string[]

The list of database server identifiers for the Exadata infrastructure.

---

attrDbServerVersion

Type: string

The software version of the database servers (dom0) in the Exadata infrastructure.

---

attrMaxCpuCount

Type: number

The total number of CPU cores available on the Exadata infrastructure.

---

attrMaxDataStorageInTBs

Type: IResolvable

The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.

---

attrMaxDbNodeStorageSizeInGBs

Type: number

The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.

---

attrMaxMemoryInGBs

Type: number

The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.

---

attrMemorySizeInGBs

Type: number

The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.

---

attrOciResourceAnchorName

Type: string

The name of the OCI resource anchor for the Exadata infrastructure.

---

attrOciUrl

Type: string

The HTTPS link to the Exadata infrastructure in OCI.

---

attrOcid

Type: string

The OCID of the Exadata infrastructure.

---

attrStorageServerVersion

Type: string

The software version of the storage servers on the Exadata infrastructure.

---

attrTotalStorageSizeInGBs

Type: number

The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.

---

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

---

availabilityZone?

Type: string (optional)

The name of the Availability Zone (AZ) where the Exadata infrastructure is located.

---

availabilityZoneId?

Type: string (optional)

The AZ ID of the AZ where the Exadata infrastructure is located.

---

computeCount?

Type: number (optional)

The number of database servers for the Exadata infrastructure.

---

customerContactsToSendToOci?

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

The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.

---

databaseServerType?

Type: string (optional)

The database server model type of the Exadata infrastructure.

---

displayName?

Type: string (optional)

The user-friendly name for the Exadata infrastructure.

---

shape?

Type: string (optional)

The model name of the Exadata infrastructure.

---

storageCount?

Type: number (optional)

The number of storage servers that are activated for the Exadata infrastructure.

---

storageServerType?

Type: string (optional)

The storage server model type of the Exadata infrastructure.

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the Exadata Infrastructure.

---

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 }