Deployment

class oci.golden_gate.models.Deployment(**kwargs)

Bases: object

A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.

Attributes:

CATEGORY_DATA_REPLICATION

A constant which can be used with the category property of a Deployment.

CATEGORY_DATA_TRANSFORMS

A constant which can be used with the category property of a Deployment.

CATEGORY_DATA_VERIFICATION

A constant which can be used with the category property of a Deployment.

CATEGORY_STREAM_ANALYTICS

A constant which can be used with the category property of a Deployment.

DEPLOYMENT_ROLE_PRIMARY

A constant which can be used with the deployment_role property of a Deployment.

DEPLOYMENT_ROLE_STANDBY

A constant which can be used with the deployment_role property of a Deployment.

DEPLOYMENT_TYPE_BIGDATA

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_DATABASE_DB2_I

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_DATABASE_DB2_ZOS

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_DATABASE_MYSQL

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_DATABASE_ORACLE

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_DATABASE_POSTGRESQL

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_DATA_TRANSFORMS

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_GGSA

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_OGG

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_VERIDATA_AGENT

A constant which can be used with the deployment_type property of a Deployment.

DEPLOYMENT_TYPE_VERIDATA_SERVER

A constant which can be used with the deployment_type property of a Deployment.

DISASTER_RECOVERY_STATUS_DISABLED

A constant which can be used with the disaster_recovery_status property of a Deployment.

DISASTER_RECOVERY_STATUS_ENABLED

A constant which can be used with the disaster_recovery_status property of a Deployment.

ENVIRONMENT_TYPE_DEVELOPMENT_OR_TESTING

A constant which can be used with the environment_type property of a Deployment.

ENVIRONMENT_TYPE_PRODUCTION

A constant which can be used with the environment_type property of a Deployment.

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE

A constant which can be used with the license_model property of a Deployment.

LICENSE_MODEL_LICENSE_INCLUDED

A constant which can be used with the license_model property of a Deployment.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_NEEDS_ATTENTION

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

LIFECYCLE_STATE_UPDATING

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

LIFECYCLE_SUB_STATE_BACKUP_IN_PROGRESS

A constant which can be used with the lifecycle_sub_state property of a Deployment.

LIFECYCLE_SUB_STATE_MOVING

A constant which can be used with the lifecycle_sub_state property of a Deployment.

LIFECYCLE_SUB_STATE_RECOVERING

A constant which can be used with the lifecycle_sub_state property of a Deployment.

LIFECYCLE_SUB_STATE_RESTORING

A constant which can be used with the lifecycle_sub_state property of a Deployment.

LIFECYCLE_SUB_STATE_ROLLBACK_IN_PROGRESS

A constant which can be used with the lifecycle_sub_state property of a Deployment.

LIFECYCLE_SUB_STATE_STARTING

A constant which can be used with the lifecycle_sub_state property of a Deployment.

LIFECYCLE_SUB_STATE_STOPPING

A constant which can be used with the lifecycle_sub_state property of a Deployment.

LIFECYCLE_SUB_STATE_UPGRADING

A constant which can be used with the lifecycle_sub_state property of a Deployment.

NEXT_MAINTENANCE_ACTION_TYPE_UPGRADE

A constant which can be used with the next_maintenance_action_type property of a Deployment.

availability_domain

Gets the availability_domain of this Deployment.

backup_schedule

Gets the backup_schedule of this Deployment.

byol_cpu_core_count_limit

Gets the byol_cpu_core_count_limit of this Deployment.

category

[Required] Gets the category of this Deployment.

cluster_placement_group_id

Gets the cluster_placement_group_id of this Deployment.

compartment_id

[Required] Gets the compartment_id of this Deployment.

cpu_core_count

[Required] Gets the cpu_core_count of this Deployment.

defined_tags

Gets the defined_tags of this Deployment.

deployment_backup_id

Gets the deployment_backup_id of this Deployment.

deployment_diagnostic_data

Gets the deployment_diagnostic_data of this Deployment.

deployment_role

Gets the deployment_role of this Deployment.

deployment_type

[Required] Gets the deployment_type of this Deployment. The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.

deployment_url

Gets the deployment_url of this Deployment.

description

Gets the description of this Deployment.

disaster_recovery_status

Gets the disaster_recovery_status of this Deployment.

display_name

Gets the display_name of this Deployment.

environment_type

Gets the environment_type of this Deployment.

fault_domain

Gets the fault_domain of this Deployment.

fqdn

Gets the fqdn of this Deployment.

freeform_tags

Gets the freeform_tags of this Deployment.

id

[Required] Gets the id of this Deployment.

ingress_ips

Gets the ingress_ips of this Deployment.

is_auto_scaling_enabled

[Required] Gets the is_auto_scaling_enabled of this Deployment.

is_byol_cpu_core_count_limit_enabled

Gets the is_byol_cpu_core_count_limit_enabled of this Deployment.

is_healthy

Gets the is_healthy of this Deployment.

is_latest_version

Gets the is_latest_version of this Deployment.

is_public

Gets the is_public of this Deployment.

is_storage_utilization_limit_exceeded

Gets the is_storage_utilization_limit_exceeded of this Deployment.

license_model

[Required] Gets the license_model of this Deployment.

lifecycle_details

Gets the lifecycle_details of this Deployment.

lifecycle_state

Gets the lifecycle_state of this Deployment.

lifecycle_sub_state

Gets the lifecycle_sub_state of this Deployment.

load_balancer_id

Gets the load_balancer_id of this Deployment.

load_balancer_subnet_id

Gets the load_balancer_subnet_id of this Deployment.

locks

Gets the locks of this Deployment.

maintenance_configuration

Gets the maintenance_configuration of this Deployment.

maintenance_window

Gets the maintenance_window of this Deployment.

next_maintenance_action_type

Gets the next_maintenance_action_type of this Deployment.

next_maintenance_description

Gets the next_maintenance_description of this Deployment.

nsg_ids

Gets the nsg_ids of this Deployment.

ogg_data

Gets the ogg_data of this Deployment.

placements

Gets the placements of this Deployment.

private_ip_address

Gets the private_ip_address of this Deployment.

public_ip_address

Gets the public_ip_address of this Deployment.

security_attributes

Gets the security_attributes of this Deployment.

source_deployment_id

Gets the source_deployment_id of this Deployment.

storage_utilization_in_bytes

Gets the storage_utilization_in_bytes of this Deployment.

subnet_id

[Required] Gets the subnet_id of this Deployment.

subscription_id

Gets the subscription_id of this Deployment.

system_tags

Gets the system_tags of this Deployment.

time_created

Gets the time_created of this Deployment.

time_last_backup_scheduled

Gets the time_last_backup_scheduled of this Deployment.

time_next_backup_scheduled

Gets the time_next_backup_scheduled of this Deployment.

time_of_next_maintenance

Gets the time_of_next_maintenance of this Deployment.

time_ogg_version_supported_until

Gets the time_ogg_version_supported_until of this Deployment.

time_role_changed

Gets the time_role_changed of this Deployment.

time_updated

Gets the time_updated of this Deployment.

Methods:

__init__(**kwargs)

Initializes a new Deployment object with values from keyword arguments.

CATEGORY_DATA_REPLICATION = 'DATA_REPLICATION'

A constant which can be used with the category property of a Deployment. This constant has a value of “DATA_REPLICATION”

CATEGORY_DATA_TRANSFORMS = 'DATA_TRANSFORMS'

A constant which can be used with the category property of a Deployment. This constant has a value of “DATA_TRANSFORMS”

CATEGORY_DATA_VERIFICATION = 'DATA_VERIFICATION'

A constant which can be used with the category property of a Deployment. This constant has a value of “DATA_VERIFICATION”

CATEGORY_STREAM_ANALYTICS = 'STREAM_ANALYTICS'

A constant which can be used with the category property of a Deployment. This constant has a value of “STREAM_ANALYTICS”

DEPLOYMENT_ROLE_PRIMARY = 'PRIMARY'

A constant which can be used with the deployment_role property of a Deployment. This constant has a value of “PRIMARY”

DEPLOYMENT_ROLE_STANDBY = 'STANDBY'

A constant which can be used with the deployment_role property of a Deployment. This constant has a value of “STANDBY”

DEPLOYMENT_TYPE_BIGDATA = 'BIGDATA'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “BIGDATA”

DEPLOYMENT_TYPE_DATABASE_DB2_I = 'DATABASE_DB2I'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “DATABASE_DB2I”

DEPLOYMENT_TYPE_DATABASE_DB2_ZOS = 'DATABASE_DB2ZOS'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “DATABASE_DB2ZOS”

DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER = 'DATABASE_MICROSOFT_SQLSERVER'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “DATABASE_MICROSOFT_SQLSERVER”

DEPLOYMENT_TYPE_DATABASE_MYSQL = 'DATABASE_MYSQL'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “DATABASE_MYSQL”

DEPLOYMENT_TYPE_DATABASE_ORACLE = 'DATABASE_ORACLE'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “DATABASE_ORACLE”

DEPLOYMENT_TYPE_DATABASE_POSTGRESQL = 'DATABASE_POSTGRESQL'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “DATABASE_POSTGRESQL”

DEPLOYMENT_TYPE_DATA_TRANSFORMS = 'DATA_TRANSFORMS'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “DATA_TRANSFORMS”

DEPLOYMENT_TYPE_GGSA = 'GGSA'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “GGSA”

DEPLOYMENT_TYPE_OGG = 'OGG'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “OGG”

DEPLOYMENT_TYPE_VERIDATA_AGENT = 'VERIDATA_AGENT'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “VERIDATA_AGENT”

DEPLOYMENT_TYPE_VERIDATA_SERVER = 'VERIDATA_SERVER'

A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “VERIDATA_SERVER”

DISASTER_RECOVERY_STATUS_DISABLED = 'DISABLED'

A constant which can be used with the disaster_recovery_status property of a Deployment. This constant has a value of “DISABLED”

DISASTER_RECOVERY_STATUS_ENABLED = 'ENABLED'

A constant which can be used with the disaster_recovery_status property of a Deployment. This constant has a value of “ENABLED”

ENVIRONMENT_TYPE_DEVELOPMENT_OR_TESTING = 'DEVELOPMENT_OR_TESTING'

A constant which can be used with the environment_type property of a Deployment. This constant has a value of “DEVELOPMENT_OR_TESTING”

ENVIRONMENT_TYPE_PRODUCTION = 'PRODUCTION'

A constant which can be used with the environment_type property of a Deployment. This constant has a value of “PRODUCTION”

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'

A constant which can be used with the license_model property of a Deployment. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'

A constant which can be used with the license_model property of a Deployment. This constant has a value of “LICENSE_INCLUDED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

LIFECYCLE_SUB_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “BACKUP_IN_PROGRESS”

LIFECYCLE_SUB_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “MOVING”

LIFECYCLE_SUB_STATE_RECOVERING = 'RECOVERING'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “RECOVERING”

LIFECYCLE_SUB_STATE_RESTORING = 'RESTORING'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “RESTORING”

LIFECYCLE_SUB_STATE_ROLLBACK_IN_PROGRESS = 'ROLLBACK_IN_PROGRESS'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “ROLLBACK_IN_PROGRESS”

LIFECYCLE_SUB_STATE_STARTING = 'STARTING'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “STARTING”

LIFECYCLE_SUB_STATE_STOPPING = 'STOPPING'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “STOPPING”

LIFECYCLE_SUB_STATE_UPGRADING = 'UPGRADING'

A constant which can be used with the lifecycle_sub_state property of a Deployment. This constant has a value of “UPGRADING”

NEXT_MAINTENANCE_ACTION_TYPE_UPGRADE = 'UPGRADE'

A constant which can be used with the next_maintenance_action_type property of a Deployment. This constant has a value of “UPGRADE”

__init__(**kwargs)

Initializes a new Deployment 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 Deployment.

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

  • description (str) – The value to assign to the description property of this Deployment.

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

  • availability_domain (str) – The value to assign to the availability_domain property of this Deployment.

  • fault_domain (str) – The value to assign to the fault_domain property of this Deployment.

  • deployment_role (str) – The value to assign to the deployment_role property of this Deployment. Allowed values for this property are: “PRIMARY”, “STANDBY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_role_changed (datetime) – The value to assign to the time_role_changed property of this Deployment.

  • source_deployment_id (str) – The value to assign to the source_deployment_id property of this Deployment.

  • placements (list[oci.golden_gate.models.DeploymentPlacementInfo]) – The value to assign to the placements property of this Deployment.

  • deployment_backup_id (str) – The value to assign to the deployment_backup_id property of this Deployment.

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

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

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

  • lifecycle_sub_state (str) – The value to assign to the lifecycle_sub_state property of this Deployment. Allowed values for this property are: “RECOVERING”, “STARTING”, “STOPPING”, “MOVING”, “UPGRADING”, “RESTORING”, “BACKUP_IN_PROGRESS”, “ROLLBACK_IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Deployment.

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

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

  • locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this Deployment.

  • is_healthy (bool) – The value to assign to the is_healthy property of this Deployment.

  • subnet_id (str) – The value to assign to the subnet_id property of this Deployment.

  • load_balancer_subnet_id (str) – The value to assign to the load_balancer_subnet_id property of this Deployment.

  • load_balancer_id (str) – The value to assign to the load_balancer_id property of this Deployment.

  • fqdn (str) – The value to assign to the fqdn property of this Deployment.

  • license_model (str) – The value to assign to the license_model property of this Deployment. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • is_byol_cpu_core_count_limit_enabled (bool) – The value to assign to the is_byol_cpu_core_count_limit_enabled property of this Deployment.

  • byol_cpu_core_count_limit (int) – The value to assign to the byol_cpu_core_count_limit property of this Deployment.

  • environment_type (str) – The value to assign to the environment_type property of this Deployment. Allowed values for this property are: “PRODUCTION”, “DEVELOPMENT_OR_TESTING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • category (str) – The value to assign to the category property of this Deployment. Allowed values for this property are: “DATA_REPLICATION”, “STREAM_ANALYTICS”, “DATA_TRANSFORMS”, “DATA_VERIFICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • cpu_core_count (int) – The value to assign to the cpu_core_count property of this Deployment.

  • is_auto_scaling_enabled (bool) – The value to assign to the is_auto_scaling_enabled property of this Deployment.

  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this Deployment.

  • is_public (bool) – The value to assign to the is_public property of this Deployment.

  • public_ip_address (str) – The value to assign to the public_ip_address property of this Deployment.

  • private_ip_address (str) – The value to assign to the private_ip_address property of this Deployment.

  • deployment_url (str) – The value to assign to the deployment_url property of this Deployment.

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

  • is_latest_version (bool) – The value to assign to the is_latest_version property of this Deployment.

  • storage_utilization_in_bytes (int) – The value to assign to the storage_utilization_in_bytes property of this Deployment.

  • is_storage_utilization_limit_exceeded (bool) – The value to assign to the is_storage_utilization_limit_exceeded property of this Deployment.

  • deployment_type (str) – The value to assign to the deployment_type property of this Deployment. Allowed values for this property are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “DATABASE_DB2I”, “GGSA”, “DATA_TRANSFORMS”, “VERIDATA_SERVER”, “VERIDATA_AGENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • ogg_data (oci.golden_gate.models.OggDeployment) – The value to assign to the ogg_data property of this Deployment.

  • deployment_diagnostic_data (oci.golden_gate.models.DeploymentDiagnosticData) – The value to assign to the deployment_diagnostic_data property of this Deployment.

  • maintenance_window (oci.golden_gate.models.MaintenanceWindow) – The value to assign to the maintenance_window property of this Deployment.

  • time_of_next_maintenance (datetime) – The value to assign to the time_of_next_maintenance property of this Deployment.

  • next_maintenance_action_type (str) – The value to assign to the next_maintenance_action_type property of this Deployment. Allowed values for this property are: “UPGRADE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • next_maintenance_description (str) – The value to assign to the next_maintenance_description property of this Deployment.

  • maintenance_configuration (oci.golden_gate.models.MaintenanceConfiguration) – The value to assign to the maintenance_configuration property of this Deployment.

  • time_ogg_version_supported_until (datetime) – The value to assign to the time_ogg_version_supported_until property of this Deployment.

  • backup_schedule (oci.golden_gate.models.BackupSchedule) – The value to assign to the backup_schedule property of this Deployment.

  • time_last_backup_scheduled (datetime) – The value to assign to the time_last_backup_scheduled property of this Deployment.

  • time_next_backup_scheduled (datetime) – The value to assign to the time_next_backup_scheduled property of this Deployment.

  • ingress_ips (list[oci.golden_gate.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this Deployment.

  • subscription_id (str) – The value to assign to the subscription_id property of this Deployment.

  • cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this Deployment.

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

  • disaster_recovery_status (str) – The value to assign to the disaster_recovery_status property of this Deployment. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property availability_domain

Gets the availability_domain of this Deployment. The availability domain of a placement.

Returns

The availability_domain of this Deployment.

Return type

str

property backup_schedule

Gets the backup_schedule of this Deployment.

Returns

The backup_schedule of this Deployment.

Return type

oci.golden_gate.models.BackupSchedule

property byol_cpu_core_count_limit

Gets the byol_cpu_core_count_limit of this Deployment. The maximum number of CPUs allowed with a ‘Bring Your Own License’ (BYOL) license type. Any CPU usage above this limit is considered as License Included and billed.

Returns

The byol_cpu_core_count_limit of this Deployment.

Return type

int

property category

[Required] Gets the category of this Deployment. The deployment category defines the broad separation of the deployment type into four categories. Currently the separation is ‘DATA_REPLICATION’, ‘STREAM_ANALYTICS’, ‘DATA_TRANSFORMS’ and ‘DATA_VERIFICATION’.

Allowed values for this property are: “DATA_REPLICATION”, “STREAM_ANALYTICS”, “DATA_TRANSFORMS”, “DATA_VERIFICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The category of this Deployment.

Return type

str

property cluster_placement_group_id

Gets the cluster_placement_group_id of this Deployment. The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.

Returns

The cluster_placement_group_id of this Deployment.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this Deployment. The OCID of the compartment being referenced.

Returns

The compartment_id of this Deployment.

Return type

str

property cpu_core_count

[Required] Gets the cpu_core_count of this Deployment. The Minimum number of OCPUs to be made available for this Deployment.

Returns

The cpu_core_count of this Deployment.

Return type

int

property defined_tags

Gets the defined_tags of this Deployment. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this Deployment.

Return type

dict(str, dict(str, object))

property deployment_backup_id

Gets the deployment_backup_id of this Deployment. The OCID of the backup being referenced.

Returns

The deployment_backup_id of this Deployment.

Return type

str

property deployment_diagnostic_data

Gets the deployment_diagnostic_data of this Deployment.

Returns

The deployment_diagnostic_data of this Deployment.

Return type

oci.golden_gate.models.DeploymentDiagnosticData

property deployment_role

Gets the deployment_role of this Deployment. The type of the deployment role.

Allowed values for this property are: “PRIMARY”, “STANDBY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The deployment_role of this Deployment.

Return type

str

property deployment_type

[Required] Gets the deployment_type of this Deployment. The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value ‘OGG’ is maintained for backward compatibility purposes.

Its use is discouraged in favor of ‘DATABASE_ORACLE’.

Allowed values for this property are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “DATABASE_DB2I”, “GGSA”, “DATA_TRANSFORMS”, “VERIDATA_SERVER”, “VERIDATA_AGENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The deployment_type of this Deployment.

Return type

str

property deployment_url

Gets the deployment_url of this Deployment. The URL of a resource.

Returns

The deployment_url of this Deployment.

Return type

str

property description

Gets the description of this Deployment. Metadata about this specific object.

Returns

The description of this Deployment.

Return type

str

property disaster_recovery_status

Gets the disaster_recovery_status of this Deployment. Indicates if disaster recovery is enabled for a deployment. If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided.

Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The disaster_recovery_status of this Deployment.

Return type

str

property display_name

Gets the display_name of this Deployment. An object’s Display Name.

Returns

The display_name of this Deployment.

Return type

str

property environment_type

Gets the environment_type of this Deployment. Specifies whether the deployment is used in a production or development/testing environment.

Allowed values for this property are: “PRODUCTION”, “DEVELOPMENT_OR_TESTING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The environment_type of this Deployment.

Return type

str

property fault_domain

Gets the fault_domain of this Deployment. The fault domain of a placement.

Returns

The fault_domain of this Deployment.

Return type

str

property fqdn

Gets the fqdn of this Deployment. A three-label Fully Qualified Domain Name (FQDN) for a resource.

Returns

The fqdn of this Deployment.

Return type

str

property freeform_tags

Gets the freeform_tags of this Deployment. A 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 Deployment.

Return type

dict(str, str)

property id

[Required] Gets the id of this Deployment. The OCID of the deployment being referenced.

Returns

The id of this Deployment.

Return type

str

property ingress_ips

Gets the ingress_ips of this Deployment. List of ingress IP addresses from where the GoldenGate deployment connects to this connection’s privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

Returns

The ingress_ips of this Deployment.

Return type

list[oci.golden_gate.models.IngressIpDetails]

property is_auto_scaling_enabled

[Required] Gets the is_auto_scaling_enabled of this Deployment. Indicates if auto scaling is enabled for the Deployment’s CPU core count.

Returns

The is_auto_scaling_enabled of this Deployment.

Return type

bool

property is_byol_cpu_core_count_limit_enabled

Gets the is_byol_cpu_core_count_limit_enabled of this Deployment. Flag to allow to configure the ‘Bring Your Own License’ (BYOL) license type CPU limit. If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

Returns

The is_byol_cpu_core_count_limit_enabled of this Deployment.

Return type

bool

property is_healthy

Gets the is_healthy of this Deployment. True if all of the aggregate resources are working correctly.

Returns

The is_healthy of this Deployment.

Return type

bool

property is_latest_version

Gets the is_latest_version of this Deployment. Indicates if the resource is the the latest available version.

Returns

The is_latest_version of this Deployment.

Return type

bool

property is_public

Gets the is_public of this Deployment. True if this object is publicly available.

Returns

The is_public of this Deployment.

Return type

bool

property is_storage_utilization_limit_exceeded

Gets the is_storage_utilization_limit_exceeded of this Deployment. Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=. Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment’s GoldenGate service.

Returns

The is_storage_utilization_limit_exceeded of this Deployment.

Return type

bool

property license_model

[Required] Gets the license_model of this Deployment. The Oracle license model that applies to a Deployment.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The license_model of this Deployment.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Deployment. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns

The lifecycle_details of this Deployment.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Deployment. Possible lifecycle states for a Deployment.

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

Returns

The lifecycle_state of this Deployment.

Return type

str

property lifecycle_sub_state

Gets the lifecycle_sub_state of this Deployment. Possible GGS lifecycle sub-states.

Allowed values for this property are: “RECOVERING”, “STARTING”, “STOPPING”, “MOVING”, “UPGRADING”, “RESTORING”, “BACKUP_IN_PROGRESS”, “ROLLBACK_IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_sub_state of this Deployment.

Return type

str

property load_balancer_id

Gets the load_balancer_id of this Deployment. The OCID of the loadbalancer in the customer’s subnet. The loadbalancer of the public deployment created in the customer subnet.

Returns

The load_balancer_id of this Deployment.

Return type

str

property load_balancer_subnet_id

Gets the load_balancer_subnet_id of this Deployment. The OCID of a public subnet in the customer tenancy used to host the public load balancer of the deployment.

Rules: - Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId. - Update:

  • For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet).

  • Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.

Validation: - Must reference a public subnet. - Must be a regional subnet. - Must be in the same VCN as subnetId.

Returns

The load_balancer_subnet_id of this Deployment.

Return type

str

property locks

Gets the locks of this Deployment. Locks associated with this resource.

Returns

The locks of this Deployment.

Return type

list[oci.golden_gate.models.ResourceLock]

property maintenance_configuration

Gets the maintenance_configuration of this Deployment.

Returns

The maintenance_configuration of this Deployment.

Return type

oci.golden_gate.models.MaintenanceConfiguration

property maintenance_window

Gets the maintenance_window of this Deployment.

Returns

The maintenance_window of this Deployment.

Return type

oci.golden_gate.models.MaintenanceWindow

property next_maintenance_action_type

Gets the next_maintenance_action_type of this Deployment. Type of the next maintenance.

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

Returns

The next_maintenance_action_type of this Deployment.

Return type

str

property next_maintenance_description

Gets the next_maintenance_description of this Deployment. Description of the next maintenance.

Returns

The next_maintenance_description of this Deployment.

Return type

str

property nsg_ids

Gets the nsg_ids of this Deployment. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns

The nsg_ids of this Deployment.

Return type

list[str]

property ogg_data

Gets the ogg_data of this Deployment.

Returns

The ogg_data of this Deployment.

Return type

oci.golden_gate.models.OggDeployment

property placements

Gets the placements of this Deployment. An array of local peers of deployment

Returns

The placements of this Deployment.

Return type

list[oci.golden_gate.models.DeploymentPlacementInfo]

property private_ip_address

Gets the private_ip_address of this Deployment. The private IP address in the customer’s VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.

Returns

The private_ip_address of this Deployment.

Return type

str

property public_ip_address

Gets the public_ip_address of this Deployment. The public IP address representing the access point for the Deployment.

Returns

The public_ip_address of this Deployment.

Return type

str

property security_attributes

Gets the security_attributes of this Deployment. 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 Deployment.

Return type

dict(str, dict(str, object))

property source_deployment_id

Gets the source_deployment_id of this Deployment. The OCID of the deployment being referenced.

Returns

The source_deployment_id of this Deployment.

Return type

str

property storage_utilization_in_bytes

Gets the storage_utilization_in_bytes of this Deployment. The amount of storage being utilized (in bytes)

Returns

The storage_utilization_in_bytes of this Deployment.

Return type

int

property subnet_id

[Required] Gets the subnet_id of this Deployment. The OCID of the subnet of the deployment’s private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.

Returns

The subnet_id of this Deployment.

Return type

str

property subscription_id

Gets the subscription_id of this Deployment. The OCID of the subscription with which resource needs to be associated with.

Returns

The subscription_id of this Deployment.

Return type

str

property system_tags

Gets the system_tags of this Deployment. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns

The system_tags of this Deployment.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this Deployment. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns

The time_created of this Deployment.

Return type

datetime

property time_last_backup_scheduled

Gets the time_last_backup_scheduled of this Deployment. The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

Returns

The time_last_backup_scheduled of this Deployment.

Return type

datetime

property time_next_backup_scheduled

Gets the time_next_backup_scheduled of this Deployment. The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.

Returns

The time_next_backup_scheduled of this Deployment.

Return type

datetime

property time_of_next_maintenance

Gets the time_of_next_maintenance of this Deployment. The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns

The time_of_next_maintenance of this Deployment.

Return type

datetime

property time_ogg_version_supported_until

Gets the time_ogg_version_supported_until of this Deployment. The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns

The time_ogg_version_supported_until of this Deployment.

Return type

datetime

property time_role_changed

Gets the time_role_changed of this Deployment. The time of the last role change. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns

The time_role_changed of this Deployment.

Return type

datetime

property time_updated

Gets the time_updated of this Deployment. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns

The time_updated of this Deployment.

Return type

datetime