BdsInstance

class oci.bds.models.BdsInstance(**kwargs)

Bases: object

Description of the cluster.

Attributes:

CLUSTER_PROFILE_HADOOP

A constant which can be used with the cluster_profile property of a BdsInstance.

CLUSTER_PROFILE_HADOOP_EXTENDED

A constant which can be used with the cluster_profile property of a BdsInstance.

CLUSTER_PROFILE_HBASE

A constant which can be used with the cluster_profile property of a BdsInstance.

CLUSTER_PROFILE_HIVE

A constant which can be used with the cluster_profile property of a BdsInstance.

CLUSTER_PROFILE_KAFKA

A constant which can be used with the cluster_profile property of a BdsInstance.

CLUSTER_PROFILE_SPARK

A constant which can be used with the cluster_profile property of a BdsInstance.

CLUSTER_PROFILE_TRINO

A constant which can be used with the cluster_profile property of a BdsInstance.

CLUSTER_VERSION_CDH5

A constant which can be used with the cluster_version property of a BdsInstance.

CLUSTER_VERSION_CDH6

A constant which can be used with the cluster_version property of a BdsInstance.

CLUSTER_VERSION_ODH0_9

A constant which can be used with the cluster_version property of a BdsInstance.

CLUSTER_VERSION_ODH1

A constant which can be used with the cluster_version property of a BdsInstance.

CLUSTER_VERSION_ODH2_0

A constant which can be used with the cluster_version property of a BdsInstance.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_RESUMING

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_SUSPENDED

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_SUSPENDING

A constant which can be used with the lifecycle_state property of a BdsInstance.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a BdsInstance.

bds_capacity_reservation_configurations

Gets the bds_capacity_reservation_configurations of this BdsInstance.

bds_cluster_version_summary

Gets the bds_cluster_version_summary of this BdsInstance.

bootstrap_script_url

Gets the bootstrap_script_url of this BdsInstance.

cloud_sql_details

Gets the cloud_sql_details of this BdsInstance.

cluster_details

Gets the cluster_details of this BdsInstance.

cluster_profile

Gets the cluster_profile of this BdsInstance.

cluster_version

Gets the cluster_version of this BdsInstance.

compartment_id

[Required] Gets the compartment_id of this BdsInstance.

created_by

Gets the created_by of this BdsInstance.

defined_tags

Gets the defined_tags of this BdsInstance.

display_name

[Required] Gets the display_name of this BdsInstance.

freeform_tags

Gets the freeform_tags of this BdsInstance.

id

[Required] Gets the id of this BdsInstance.

is_cloud_sql_configured

[Required] Gets the is_cloud_sql_configured of this BdsInstance.

is_high_availability

[Required] Gets the is_high_availability of this BdsInstance.

is_kafka_configured

[Required] Gets the is_kafka_configured of this BdsInstance.

is_secret_reused

Gets the is_secret_reused of this BdsInstance.

is_secure

[Required] Gets the is_secure of this BdsInstance.

kms_key_id

Gets the kms_key_id of this BdsInstance.

lifecycle_state

[Required] Gets the lifecycle_state of this BdsInstance.

network_config

Gets the network_config of this BdsInstance.

nodes

[Required] Gets the nodes of this BdsInstance.

number_of_nodes

[Required] Gets the number_of_nodes of this BdsInstance.

number_of_nodes_requiring_maintenance_reboot

Gets the number_of_nodes_requiring_maintenance_reboot of this BdsInstance.

secret_id

Gets the secret_id of this BdsInstance.

time_created

Gets the time_created of this BdsInstance.

time_earliest_certificate_expiration

Gets the time_earliest_certificate_expiration of this BdsInstance.

time_updated

Gets the time_updated of this BdsInstance.

Methods:

__init__(**kwargs)

Initializes a new BdsInstance object with values from keyword arguments.

CLUSTER_PROFILE_HADOOP = 'HADOOP'

A constant which can be used with the cluster_profile property of a BdsInstance. This constant has a value of “HADOOP”

CLUSTER_PROFILE_HADOOP_EXTENDED = 'HADOOP_EXTENDED'

A constant which can be used with the cluster_profile property of a BdsInstance. This constant has a value of “HADOOP_EXTENDED”

CLUSTER_PROFILE_HBASE = 'HBASE'

A constant which can be used with the cluster_profile property of a BdsInstance. This constant has a value of “HBASE”

CLUSTER_PROFILE_HIVE = 'HIVE'

A constant which can be used with the cluster_profile property of a BdsInstance. This constant has a value of “HIVE”

CLUSTER_PROFILE_KAFKA = 'KAFKA'

A constant which can be used with the cluster_profile property of a BdsInstance. This constant has a value of “KAFKA”

CLUSTER_PROFILE_SPARK = 'SPARK'

A constant which can be used with the cluster_profile property of a BdsInstance. This constant has a value of “SPARK”

CLUSTER_PROFILE_TRINO = 'TRINO'

A constant which can be used with the cluster_profile property of a BdsInstance. This constant has a value of “TRINO”

CLUSTER_VERSION_CDH5 = 'CDH5'

A constant which can be used with the cluster_version property of a BdsInstance. This constant has a value of “CDH5”

CLUSTER_VERSION_CDH6 = 'CDH6'

A constant which can be used with the cluster_version property of a BdsInstance. This constant has a value of “CDH6”

CLUSTER_VERSION_ODH0_9 = 'ODH0_9'

A constant which can be used with the cluster_version property of a BdsInstance. This constant has a value of “ODH0_9”

CLUSTER_VERSION_ODH1 = 'ODH1'

A constant which can be used with the cluster_version property of a BdsInstance. This constant has a value of “ODH1”

CLUSTER_VERSION_ODH2_0 = 'ODH2_0'

A constant which can be used with the cluster_version property of a BdsInstance. This constant has a value of “ODH2_0”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_RESUMING = 'RESUMING'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “RESUMING”

LIFECYCLE_STATE_SUSPENDED = 'SUSPENDED'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “SUSPENDED”

LIFECYCLE_STATE_SUSPENDING = 'SUSPENDING'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “SUSPENDING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a BdsInstance. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new BdsInstance object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this BdsInstance.

  • compartment_id (str) – The value to assign to the compartment_id property of this BdsInstance.

  • display_name (str) – The value to assign to the display_name property of this BdsInstance.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this BdsInstance. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “SUSPENDING”, “SUSPENDED”, “RESUMING”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • cluster_version (str) – The value to assign to the cluster_version property of this BdsInstance. Allowed values for this property are: “CDH5”, “CDH6”, “ODH1”, “ODH0_9”, “ODH2_0”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • secret_id (str) – The value to assign to the secret_id property of this BdsInstance.

  • is_secret_reused (bool) – The value to assign to the is_secret_reused property of this BdsInstance.

  • is_high_availability (bool) – The value to assign to the is_high_availability property of this BdsInstance.

  • is_secure (bool) – The value to assign to the is_secure property of this BdsInstance.

  • is_cloud_sql_configured (bool) – The value to assign to the is_cloud_sql_configured property of this BdsInstance.

  • is_kafka_configured (bool) – The value to assign to the is_kafka_configured property of this BdsInstance.

  • network_config (oci.bds.models.NetworkConfig) – The value to assign to the network_config property of this BdsInstance.

  • cluster_details (oci.bds.models.ClusterDetails) – The value to assign to the cluster_details property of this BdsInstance.

  • nodes (list[oci.bds.models.Node]) – The value to assign to the nodes property of this BdsInstance.

  • bds_capacity_reservation_configurations (list[oci.bds.models.BdsCapacityReservationConfiguration]) – The value to assign to the bds_capacity_reservation_configurations property of this BdsInstance.

  • cloud_sql_details (oci.bds.models.CloudSqlDetails) – The value to assign to the cloud_sql_details property of this BdsInstance.

  • created_by (str) – The value to assign to the created_by property of this BdsInstance.

  • time_created (datetime) – The value to assign to the time_created property of this BdsInstance.

  • time_updated (datetime) – The value to assign to the time_updated property of this BdsInstance.

  • number_of_nodes (int) – The value to assign to the number_of_nodes property of this BdsInstance.

  • number_of_nodes_requiring_maintenance_reboot (int) – The value to assign to the number_of_nodes_requiring_maintenance_reboot property of this BdsInstance.

  • bootstrap_script_url (str) – The value to assign to the bootstrap_script_url property of this BdsInstance.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BdsInstance.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BdsInstance.

  • kms_key_id (str) – The value to assign to the kms_key_id property of this BdsInstance.

  • cluster_profile (str) – The value to assign to the cluster_profile property of this BdsInstance. Allowed values for this property are: “HADOOP_EXTENDED”, “HADOOP”, “HIVE”, “SPARK”, “HBASE”, “TRINO”, “KAFKA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • bds_cluster_version_summary (oci.bds.models.BdsClusterVersionSummary) – The value to assign to the bds_cluster_version_summary property of this BdsInstance.

  • time_earliest_certificate_expiration (datetime) – The value to assign to the time_earliest_certificate_expiration property of this BdsInstance.

property bds_capacity_reservation_configurations

Gets the bds_capacity_reservation_configurations of this BdsInstance. The list of BDS capacity reservation configurations associated with the cluster.

Returns

The bds_capacity_reservation_configurations of this BdsInstance.

Return type

list[oci.bds.models.BdsCapacityReservationConfiguration]

property bds_cluster_version_summary

Gets the bds_cluster_version_summary of this BdsInstance.

Returns

The bds_cluster_version_summary of this BdsInstance.

Return type

oci.bds.models.BdsClusterVersionSummary

property bootstrap_script_url

Gets the bootstrap_script_url of this BdsInstance. pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.

Returns

The bootstrap_script_url of this BdsInstance.

Return type

str

property cloud_sql_details

Gets the cloud_sql_details of this BdsInstance.

Returns

The cloud_sql_details of this BdsInstance.

Return type

oci.bds.models.CloudSqlDetails

property cluster_details

Gets the cluster_details of this BdsInstance.

Returns

The cluster_details of this BdsInstance.

Return type

oci.bds.models.ClusterDetails

property cluster_profile

Gets the cluster_profile of this BdsInstance. Profile of the Big Data Service cluster.

Allowed values for this property are: “HADOOP_EXTENDED”, “HADOOP”, “HIVE”, “SPARK”, “HBASE”, “TRINO”, “KAFKA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The cluster_profile of this BdsInstance.

Return type

str

property cluster_version

Gets the cluster_version of this BdsInstance. Version of the Hadoop distribution.

Allowed values for this property are: “CDH5”, “CDH6”, “ODH1”, “ODH0_9”, “ODH2_0”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The cluster_version of this BdsInstance.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this BdsInstance. The OCID of the compartment.

Returns

The compartment_id of this BdsInstance.

Return type

str

property created_by

Gets the created_by of this BdsInstance. The user who created the cluster.

Returns

The created_by of this BdsInstance.

Return type

str

property defined_tags

Gets the defined_tags of this BdsInstance. Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this BdsInstance.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this BdsInstance. The name of the cluster.

Returns

The display_name of this BdsInstance.

Return type

str

property freeform_tags

Gets the freeform_tags of this BdsInstance. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, {“bar-key”: “value”}

Returns

The freeform_tags of this BdsInstance.

Return type

dict(str, str)

property id

[Required] Gets the id of this BdsInstance. The OCID of the Big Data Service resource.

Returns

The id of this BdsInstance.

Return type

str

property is_cloud_sql_configured

[Required] Gets the is_cloud_sql_configured of this BdsInstance. Boolean flag specifying whether or not Cloud SQL should be configured.

Returns

The is_cloud_sql_configured of this BdsInstance.

Return type

bool

property is_high_availability

[Required] Gets the is_high_availability of this BdsInstance. Boolean flag specifying whether or not the cluster is highly available (HA)

Returns

The is_high_availability of this BdsInstance.

Return type

bool

property is_kafka_configured

[Required] Gets the is_kafka_configured of this BdsInstance. Boolean flag specifying whether or not Kafka should be configured.

Returns

The is_kafka_configured of this BdsInstance.

Return type

bool

property is_secret_reused

Gets the is_secret_reused of this BdsInstance. Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations.

Returns

The is_secret_reused of this BdsInstance.

Return type

bool

property is_secure

[Required] Gets the is_secure of this BdsInstance. Boolean flag specifying whether or not the cluster should be set up as secure.

Returns

The is_secure of this BdsInstance.

Return type

bool

property kms_key_id

Gets the kms_key_id of this BdsInstance. The OCID of the Key Management master encryption key.

Returns

The kms_key_id of this BdsInstance.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this BdsInstance. The state of the cluster.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “SUSPENDING”, “SUSPENDED”, “RESUMING”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this BdsInstance.

Return type

str

property network_config

Gets the network_config of this BdsInstance.

Returns

The network_config of this BdsInstance.

Return type

oci.bds.models.NetworkConfig

property nodes

[Required] Gets the nodes of this BdsInstance. The list of nodes in the cluster.

Returns

The nodes of this BdsInstance.

Return type

list[oci.bds.models.Node]

property number_of_nodes

[Required] Gets the number_of_nodes of this BdsInstance. Number of nodes that forming the cluster

Returns

The number_of_nodes of this BdsInstance.

Return type

int

property number_of_nodes_requiring_maintenance_reboot

Gets the number_of_nodes_requiring_maintenance_reboot of this BdsInstance. Number of nodes that require a maintenance reboot

Returns

The number_of_nodes_requiring_maintenance_reboot of this BdsInstance.

Return type

int

property secret_id

Gets the secret_id of this BdsInstance. The secretId for the clusterAdminPassword.

Returns

The secret_id of this BdsInstance.

Return type

str

property time_created

Gets the time_created of this BdsInstance. The time the cluster was created, shown as an RFC 3339 formatted datetime string.

Returns

The time_created of this BdsInstance.

Return type

datetime

property time_earliest_certificate_expiration

Gets the time_earliest_certificate_expiration of this BdsInstance. The earliest time of certificate expiration date across the certificates of all current nodes under this cluster.

Returns

The time_earliest_certificate_expiration of this BdsInstance.

Return type

datetime

property time_updated

Gets the time_updated of this BdsInstance. The time the cluster was updated, shown as an RFC 3339 formatted datetime string.

Returns

The time_updated of this BdsInstance.

Return type

datetime