UpgradeOpenSearchClusterDetails

class oci.opensearch.models.UpgradeOpenSearchClusterDetails(**kwargs)

Bases: object

Minor or major version upgrade of a cluster.

Attributes:

UPGRADE_TYPE_MAJOR

A constant which can be used with the upgrade_type property of a UpgradeOpenSearchClusterDetails.

UPGRADE_TYPE_MINOR

A constant which can be used with the upgrade_type property of a UpgradeOpenSearchClusterDetails.

defined_tags

Gets the defined_tags of this UpgradeOpenSearchClusterDetails.

desired_software_version

[Required] Gets the desired_software_version of this UpgradeOpenSearchClusterDetails.

freeform_tags

Gets the freeform_tags of this UpgradeOpenSearchClusterDetails.

is_clone

Gets the is_clone of this UpgradeOpenSearchClusterDetails.

original_cluster_display_name

[Required] Gets the original_cluster_display_name of this UpgradeOpenSearchClusterDetails.

security_attributes

Gets the security_attributes of this UpgradeOpenSearchClusterDetails.

system_tags

Gets the system_tags of this UpgradeOpenSearchClusterDetails.

upgrade_type

[Required] Gets the upgrade_type of this UpgradeOpenSearchClusterDetails.

Methods:

__init__(**kwargs)

Initializes a new UpgradeOpenSearchClusterDetails object with values from keyword arguments.

UPGRADE_TYPE_MAJOR = 'MAJOR'

A constant which can be used with the upgrade_type property of a UpgradeOpenSearchClusterDetails. This constant has a value of “MAJOR”

UPGRADE_TYPE_MINOR = 'MINOR'

A constant which can be used with the upgrade_type property of a UpgradeOpenSearchClusterDetails. This constant has a value of “MINOR”

__init__(**kwargs)

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

Parameters
  • original_cluster_display_name (str) – The value to assign to the original_cluster_display_name property of this UpgradeOpenSearchClusterDetails.

  • desired_software_version (str) – The value to assign to the desired_software_version property of this UpgradeOpenSearchClusterDetails.

  • upgrade_type (str) – The value to assign to the upgrade_type property of this UpgradeOpenSearchClusterDetails. Allowed values for this property are: “MINOR”, “MAJOR”

  • is_clone (bool) – The value to assign to the is_clone property of this UpgradeOpenSearchClusterDetails.

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

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

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

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

property defined_tags

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

Returns

The defined_tags of this UpgradeOpenSearchClusterDetails.

Return type

dict(str, dict(str, object))

property desired_software_version

[Required] Gets the desired_software_version of this UpgradeOpenSearchClusterDetails. The software version the cluster is desired.

Returns

The desired_software_version of this UpgradeOpenSearchClusterDetails.

Return type

str

property freeform_tags

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

Returns

The freeform_tags of this UpgradeOpenSearchClusterDetails.

Return type

dict(str, str)

property is_clone

Gets the is_clone of this UpgradeOpenSearchClusterDetails. The cluster would be cloned for true and updated for false with the provided version.

Returns

The is_clone of this UpgradeOpenSearchClusterDetails.

Return type

bool

property original_cluster_display_name

[Required] Gets the original_cluster_display_name of this UpgradeOpenSearchClusterDetails. The display name of the original cluster. This is required to validate that the cluster ID has the same display name.

Returns

The original_cluster_display_name of this UpgradeOpenSearchClusterDetails.

Return type

str

property security_attributes

Gets the security_attributes of this UpgradeOpenSearchClusterDetails. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns

The security_attributes of this UpgradeOpenSearchClusterDetails.

Return type

dict(str, dict(str, object))

property system_tags

Gets the system_tags of this UpgradeOpenSearchClusterDetails. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this UpgradeOpenSearchClusterDetails.

Return type

dict(str, dict(str, object))

property upgrade_type

[Required] Gets the upgrade_type of this UpgradeOpenSearchClusterDetails. The upgrade type of cluster (major or minor).

Allowed values for this property are: “MINOR”, “MAJOR”

Returns

The upgrade_type of this UpgradeOpenSearchClusterDetails.

Return type

str