CfnCloudAutonomousVmCluster

class aws_cdk.aws_odb.CfnCloudAutonomousVmCluster(scope, id, *, autonomous_data_storage_size_in_t_bs=None, cloud_exadata_infrastructure_id=None, cpu_core_count_per_node=None, db_servers=None, description=None, display_name=None, is_mtls_enabled_vm_cluster=None, license_model=None, maintenance_window=None, memory_per_oracle_compute_unit_in_g_bs=None, odb_network_id=None, scan_listener_port_non_tls=None, scan_listener_port_tls=None, tags=None, time_zone=None, total_container_databases=None)

Bases: CfnResource

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

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html
CloudformationResource:: AWS::ODB::CloudAutonomousVmCluster
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_autonomous_vm_cluster = odb.CfnCloudAutonomousVmCluster(self, "MyCfnCloudAutonomousVmCluster",
    autonomous_data_storage_size_in_tBs=123,
    cloud_exadata_infrastructure_id="cloudExadataInfrastructureId",
    cpu_core_count_per_node=123,
    db_servers=["dbServers"],
    description="description",
    display_name="displayName",
    is_mtls_enabled_vm_cluster=False,
    license_model="licenseModel",
    maintenance_window=odb.CfnCloudAutonomousVmCluster.MaintenanceWindowProperty(
        days_of_week=["daysOfWeek"],
        hours_of_day=[123],
        lead_time_in_weeks=123,
        months=["months"],
        preference="preference",
        weeks_of_month=[123]
    ),
    memory_per_oracle_compute_unit_in_gBs=123,
    odb_network_id="odbNetworkId",
    scan_listener_port_non_tls=123,
    scan_listener_port_tls=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    time_zone="timeZone",
    total_container_databases=123
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
autonomous_data_storage_size_in_t_bs (Union[int, float, None]) – The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB. Required when creating an Autonomous VM cluster.
cloud_exadata_infrastructure_id (Optional[str]) – The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster. Required when creating an Autonomous VM cluster.
cpu_core_count_per_node (Union[int, float, None]) – The number of CPU cores enabled per node in the Autonomous VM cluster. Required when creating an Autonomous VM cluster.
db_servers (Optional[Sequence[str]]) – The list of database servers associated with the Autonomous VM cluster.
description (Optional[str]) – The user-provided description of the Autonomous VM cluster.
display_name (Optional[str]) – The display name of the Autonomous VM cluster. Required when creating an Autonomous VM cluster.
is_mtls_enabled_vm_cluster (Union[bool, IResolvable, None]) – Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
license_model (Optional[str]) – The Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE .
maintenance_window (Union[IResolvable, MaintenanceWindowProperty, Dict[str, Any], None]) – The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
memory_per_oracle_compute_unit_in_g_bs (Union[int, float, None]) – The amount of memory allocated per Oracle Compute Unit, in GB. Required when creating an Autonomous VM cluster.
odb_network_id (Optional[str]) – The unique identifier of the ODB network associated with this Autonomous VM cluster. Required when creating an Autonomous VM cluster.
scan_listener_port_non_tls (Union[int, float, None]) – The SCAN listener port for non-TLS (TCP) protocol. The default is 1521.
scan_listener_port_tls (Union[int, float, None]) – The SCAN listener port for TLS (TCP) protocol. The default is 2484.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the Autonomous Vm Cluster.
time_zone (Optional[str]) – The time zone of the Autonomous VM cluster.
total_container_databases (Union[int, float, None]) – The total number of Autonomous Container Databases that can be created with the allocated local storage. Required when creating an Autonomous 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::CloudAutonomousVmCluster'

attr_autonomous_data_storage_percentage

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

CloudformationAttribute:: AutonomousDataStoragePercentage

attr_available_autonomous_data_storage_size_in_t_bs

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

CloudformationAttribute:: AvailableAutonomousDataStorageSizeInTBs

attr_available_container_databases

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

CloudformationAttribute:: AvailableContainerDatabases

attr_available_cpus

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

CloudformationAttribute:: AvailableCpus

attr_cloud_autonomous_vm_cluster_arn

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

CloudformationAttribute:: CloudAutonomousVmClusterArn

attr_cloud_autonomous_vm_cluster_id

The unique identifier of the Autonomous VM cluster.

CloudformationAttribute:: CloudAutonomousVmClusterId

attr_compute_model

ECPU or OCPU.

CloudformationAttribute:: ComputeModel
Type:: The compute model of the Autonomous VM cluster

attr_cpu_core_count

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

CloudformationAttribute:: CpuCoreCount

attr_cpu_percentage

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

CloudformationAttribute:: CpuPercentage

attr_data_storage_size_in_g_bs

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

CloudformationAttribute:: DataStorageSizeInGBs

attr_data_storage_size_in_t_bs

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

CloudformationAttribute:: DataStorageSizeInTBs

attr_db_node_storage_size_in_g_bs

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

CloudformationAttribute:: DbNodeStorageSizeInGBs

attr_domain

The domain name for the Autonomous VM cluster.

CloudformationAttribute:: Domain

attr_exadata_storage_in_t_bs_lowest_scaled_value

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

CloudformationAttribute:: ExadataStorageInTBsLowestScaledValue

attr_hostname

The hostname for the Autonomous VM cluster.

CloudformationAttribute:: Hostname

attr_max_acds_lowest_scaled_value

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

CloudformationAttribute:: MaxAcdsLowestScaledValue

attr_memory_size_in_g_bs

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

CloudformationAttribute:: MemorySizeInGBs

attr_node_count

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

CloudformationAttribute:: NodeCount

attr_non_provisionable_autonomous_container_databases

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

CloudformationAttribute:: NonProvisionableAutonomousContainerDatabases

attr_oci_resource_anchor_name

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

CloudformationAttribute:: OciResourceAnchorName

attr_oci_url

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

CloudformationAttribute:: OciUrl

attr_ocid

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

CloudformationAttribute:: Ocid

attr_provisionable_autonomous_container_databases

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

CloudformationAttribute:: ProvisionableAutonomousContainerDatabases

attr_provisioned_autonomous_container_databases

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

CloudformationAttribute:: ProvisionedAutonomousContainerDatabases

attr_provisioned_cpus

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

CloudformationAttribute:: ProvisionedCpus

attr_reclaimable_cpus

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

CloudformationAttribute:: ReclaimableCpus

attr_reserved_cpus

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

CloudformationAttribute:: ReservedCpus

attr_shape

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

CloudformationAttribute:: Shape

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

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 Cloud Exadata Infrastructure containing this Autonomous VM cluster.

cpu_core_count_per_node: The number of CPU cores enabled per node in the Autonomous 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.

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

description: The user-provided description of the Autonomous VM cluster.

display_name: The display name of the Autonomous VM cluster.

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

license_model: The Oracle license model that applies to the Autonomous 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.

maintenance_window: The scheduling details for the maintenance window.

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

node: The tree node.

odb_network_id: The unique identifier of the ODB network associated with this Autonomous 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_non_tls: The SCAN listener port for non-TLS (TCP) protocol.

scan_listener_port_tls: The SCAN listener port for TLS (TCP) protocol.

stack

The stack in which this element is defined.

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

tags: Tags to assign to the Autonomous Vm Cluster.

time_zone: The time zone of the Autonomous VM cluster.

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

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.

MaintenanceWindowProperty

class CfnCloudAutonomousVmCluster.MaintenanceWindowProperty(*, days_of_week=None, hours_of_day=None, lead_time_in_weeks=None, months=None, preference=None, weeks_of_month=None)

Bases: object

The scheduling details for the maintenance window.

Patching and system updates take place during the maintenance window.

Parameters:

days_of_week (Optional[Sequence[str]]) – The days of the week when maintenance can be performed.
hours_of_day (Union[Sequence[Union[int, float]], IResolvable, None]) – The hours of the day when maintenance can be performed.
lead_time_in_weeks (Union[int, float, None]) – The lead time in weeks before the maintenance window.
months (Optional[Sequence[str]]) – The months when maintenance can be performed.
preference (Optional[str]) – The preference for the maintenance window scheduling.
weeks_of_month (Union[Sequence[Union[int, float]], IResolvable, None]) – The weeks of the month when maintenance can be performed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.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

maintenance_window_property = odb.CfnCloudAutonomousVmCluster.MaintenanceWindowProperty(
    days_of_week=["daysOfWeek"],
    hours_of_day=[123],
    lead_time_in_weeks=123,
    months=["months"],
    preference="preference",
    weeks_of_month=[123]
)