CfnCloudVmCluster

class aws_cdk.aws_odb.CfnCloudVmCluster(scope, id, *, cloud_exadata_infrastructure_id=None, cluster_name=None, cpu_core_count=None, data_collection_options=None, data_storage_size_in_t_bs=None, db_nodes=None, db_node_storage_size_in_g_bs=None, db_servers=None, display_name=None, gi_version=None, hostname=None, is_local_backup_enabled=None, is_sparse_diskgroup_enabled=None, license_model=None, memory_size_in_g_bs=None, odb_network_id=None, scan_listener_port_tcp=None, ssh_public_keys=None, system_version=None, tags=None, time_zone=None)

Bases: CfnResource

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html
CloudformationResource:: AWS::ODB::CloudVmCluster
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_odb as odb

cfn_cloud_vm_cluster = odb.CfnCloudVmCluster(self, "MyCfnCloudVmCluster",
    cloud_exadata_infrastructure_id="cloudExadataInfrastructureId",
    cluster_name="clusterName",
    cpu_core_count=123,
    data_collection_options=odb.CfnCloudVmCluster.DataCollectionOptionsProperty(
        is_diagnostics_events_enabled=False,
        is_health_monitoring_enabled=False,
        is_incident_logs_enabled=False
    ),
    data_storage_size_in_tBs=123,
    db_nodes=[odb.CfnCloudVmCluster.DbNodeProperty(
        db_server_id="dbServerId",

        # the properties below are optional
        backup_ip_id="backupIpId",
        backup_vnic2_id="backupVnic2Id",
        cpu_core_count=123,
        db_node_arn="dbNodeArn",
        db_node_id="dbNodeId",
        db_node_storage_size_in_gBs=123,
        db_system_id="dbSystemId",
        host_ip_id="hostIpId",
        hostname="hostname",
        memory_size_in_gBs=123,
        ocid="ocid",
        status="status",
        tags=[CfnTag(
            key="key",
            value="value"
        )],
        vnic2_id="vnic2Id",
        vnic_id="vnicId"
    )],
    db_node_storage_size_in_gBs=123,
    db_servers=["dbServers"],
    display_name="displayName",
    gi_version="giVersion",
    hostname="hostname",
    is_local_backup_enabled=False,
    is_sparse_diskgroup_enabled=False,
    license_model="licenseModel",
    memory_size_in_gBs=123,
    odb_network_id="odbNetworkId",
    scan_listener_port_tcp=123,
    ssh_public_keys=["sshPublicKeys"],
    system_version="systemVersion",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    time_zone="timeZone"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
cloud_exadata_infrastructure_id (Optional[str]) – The unique identifier of the Exadata infrastructure that this VM cluster belongs to. Required when creating a VM cluster.
cluster_name (Optional[str]) – The name of the Grid Infrastructure (GI) cluster.
cpu_core_count (Union[int, float, None]) – The number of CPU cores enabled on the VM cluster. Required when creating a VM cluster.
data_collection_options (Union[IResolvable, DataCollectionOptionsProperty, Dict[str, Any], None]) – The set of diagnostic collection options enabled for the VM cluster.
data_storage_size_in_t_bs (Union[int, float, None]) – The size of the data disk group, in terabytes (TB), that’s allocated for the VM cluster.
db_nodes (Union[IResolvable, Sequence[Union[IResolvable, DbNodeProperty, Dict[str, Any]]], None]) – The DB nodes that are implicitly created and managed as part of this VM Cluster.
db_node_storage_size_in_g_bs (Union[int, float, None]) – The amount of local node storage, in gigabytes (GB), that’s allocated for the VM cluster.
db_servers (Optional[Sequence[str]]) – The list of database servers for the VM cluster.
display_name (Optional[str]) – The user-friendly name for the VM cluster. Required when creating a VM cluster.
gi_version (Optional[str]) – The software version of the Oracle Grid Infrastructure (GI) for the VM cluster. Required when creating a VM cluster.
hostname (Optional[str]) – The host name for the VM cluster. Required when creating a VM cluster.
is_local_backup_enabled (Union[bool, IResolvable, None]) – Specifies whether database backups to local Exadata storage are enabled for the VM cluster.
is_sparse_diskgroup_enabled (Union[bool, IResolvable, None]) – Specifies whether the VM cluster is configured with a sparse disk group.
license_model (Optional[str]) – The Oracle license model applied to the VM cluster.
memory_size_in_g_bs (Union[int, float, None]) – The amount of memory, in gigabytes (GB), that’s allocated for the VM cluster.
odb_network_id (Optional[str]) – The unique identifier of the ODB network for the VM cluster. Required when creating a VM cluster.
scan_listener_port_tcp (Union[int, float, None]) – 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
ssh_public_keys (Optional[Sequence[str]]) – The public key portion of one or more key pairs used for SSH access to the VM cluster. Required when creating a VM cluster.
system_version (Optional[str]) – The operating system version of the image chosen for the VM cluster.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the Vm Cluster.
time_zone (Optional[str]) – The time zone of the VM cluster.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

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.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

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

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

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.

add_override(path, 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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

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

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

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

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

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

Return type:

None

get_att(attribute_name, type_hint=None)

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.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

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

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

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

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

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

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

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

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

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.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ODB::CloudVmCluster'

attr_cloud_vm_cluster_arn

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

CloudformationAttribute:: CloudVmClusterArn

attr_cloud_vm_cluster_id

The unique identifier of the VM cluster.

CloudformationAttribute:: CloudVmClusterId

attr_compute_model

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.

CloudformationAttribute:: ComputeModel
Type:: The OCI model compute model used when you create or clone an instance

attr_disk_redundancy

The type of redundancy configured for the VM cluster.

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

CloudformationAttribute:: DiskRedundancy

attr_domain

The domain of the VM cluster.

CloudformationAttribute:: Domain

attr_listener_port

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

CloudformationAttribute:: ListenerPort

attr_node_count

The number of nodes in the VM cluster.

CloudformationAttribute:: NodeCount

attr_oci_resource_anchor_name

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

CloudformationAttribute:: OciResourceAnchorName

attr_oci_url

The HTTPS link to the VM cluster in OCI.

CloudformationAttribute:: OciUrl

attr_ocid

The OCID of the VM cluster.

CloudformationAttribute:: Ocid

attr_scan_dns_name

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

CloudformationAttribute:: ScanDnsName

attr_scan_ip_ids

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

CloudformationAttribute:: ScanIpIds

attr_shape

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

CloudformationAttribute:: Shape

attr_storage_size_in_g_bs

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

CloudformationAttribute:: StorageSizeInGBs

attr_vip_ids

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.

CloudformationAttribute:: VipIds

cdk_tag_manager: Tag Manager which manages the tags for this resource.

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

cfn_resource_type: AWS resource type.

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

cloud_vm_cluster_ref: A reference to a CloudVmCluster resource.

cluster_name: The name of the Grid Infrastructure (GI) cluster.

cpu_core_count: The number of CPU cores enabled on the VM cluster.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

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

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

db_nodes: The DB nodes that are implicitly created and managed as part of this VM Cluster.

db_servers: The list of database servers for the VM cluster.

display_name: The user-friendly name for the VM cluster.

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

hostname: The host name for the VM cluster.

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

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

license_model: The Oracle license model applied to the VM cluster.

logical_id

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

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

memory_size_in_g_bs: The amount of memory, in gigabytes (GB), that’s allocated for the VM cluster.

node: The tree node.

odb_network_id: The unique identifier of the ODB network for the VM cluster.

ref

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

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

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

stack

The stack in which this element is defined.

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

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

tags: Tags to assign to the Vm Cluster.

time_zone: The time zone of the VM cluster.

Static Methods

classmethod is_cfn_element(x)

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

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

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

DataCollectionOptionsProperty

class CfnCloudVmCluster.DataCollectionOptionsProperty(*, is_diagnostics_events_enabled=None, is_health_monitoring_enabled=None, is_incident_logs_enabled=None)

Bases: object

Information about the data collection options enabled for a VM cluster.

Parameters:

is_diagnostics_events_enabled (Union[bool, IResolvable, None]) – Specifies whether diagnostic collection is enabled for the VM cluster.
is_health_monitoring_enabled (Union[bool, IResolvable, None]) – Specifies whether health monitoring is enabled for the VM cluster.
is_incident_logs_enabled (Union[bool, IResolvable, None]) – Specifies whether incident logs are enabled for the VM cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_odb as odb

data_collection_options_property = odb.CfnCloudVmCluster.DataCollectionOptionsProperty(
    is_diagnostics_events_enabled=False,
    is_health_monitoring_enabled=False,
    is_incident_logs_enabled=False
)

Attributes

is_diagnostics_events_enabled

Specifies whether diagnostic collection is enabled for the VM cluster.

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

is_health_monitoring_enabled

Specifies whether health monitoring is enabled for the VM cluster.

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

is_incident_logs_enabled

Specifies whether incident logs are enabled for the VM cluster.

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

DbNodeProperty

class CfnCloudVmCluster.DbNodeProperty(*, db_server_id, backup_ip_id=None, backup_vnic2_id=None, cpu_core_count=None, db_node_arn=None, db_node_id=None, db_node_storage_size_in_g_bs=None, db_system_id=None, host_ip_id=None, hostname=None, memory_size_in_g_bs=None, ocid=None, status=None, tags=None, vnic2_id=None, vnic_id=None)

Bases: object

Information about a DB node.

Parameters:

db_server_id (str) – The unique identifier of the Db server that is associated with the DB node.
backup_ip_id (Optional[str]) – The Oracle Cloud ID (OCID) of the backup IP address that’s associated with the DB node.
backup_vnic2_id (Optional[str]) – The OCID of the second backup VNIC.
cpu_core_count (Union[int, float, None]) – Number of CPU cores enabled on the DB node.
db_node_arn (Optional[str]) – The Amazon Resource Name (ARN) of the DB node.
db_node_id (Optional[str]) – The unique identifier of the DB node.
db_node_storage_size_in_g_bs (Union[int, float, None]) – The amount of local node storage, in gigabytes (GBs), that’s allocated on the DB node.
db_system_id (Optional[str]) – The OCID of the DB system.
host_ip_id (Optional[str]) – The OCID of the host IP address that’s associated with the DB node.
hostname (Optional[str]) – The host name for the DB node.
memory_size_in_g_bs (Union[int, float, None]) – The allocated memory in GBs on the DB node.
ocid (Optional[str]) – The OCID of the DB node.
status (Optional[str]) – The current status of the DB node.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]])
vnic2_id (Optional[str]) – The OCID of the second VNIC.
vnic_id (Optional[str]) – The OCID of the VNIC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_odb as odb

db_node_property = odb.CfnCloudVmCluster.DbNodeProperty(
    db_server_id="dbServerId",

    # the properties below are optional
    backup_ip_id="backupIpId",
    backup_vnic2_id="backupVnic2Id",
    cpu_core_count=123,
    db_node_arn="dbNodeArn",
    db_node_id="dbNodeId",
    db_node_storage_size_in_gBs=123,
    db_system_id="dbSystemId",
    host_ip_id="hostIpId",
    hostname="hostname",
    memory_size_in_gBs=123,
    ocid="ocid",
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vnic2_id="vnic2Id",
    vnic_id="vnicId"
)