CreateDeploymentDetails

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

Bases: object

The information about a new Deployment.

Attributes:

DEPLOYMENT_TYPE_BIGDATA

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

DEPLOYMENT_TYPE_DATABASE_DB2_I

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

DEPLOYMENT_TYPE_DATABASE_DB2_ZOS

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

DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER

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

DEPLOYMENT_TYPE_DATABASE_MYSQL

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

DEPLOYMENT_TYPE_DATABASE_ORACLE

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

DEPLOYMENT_TYPE_DATABASE_POSTGRESQL

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

DEPLOYMENT_TYPE_DATA_TRANSFORMS

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

DEPLOYMENT_TYPE_GGSA

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

DEPLOYMENT_TYPE_OGG

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

DEPLOYMENT_TYPE_VERIDATA_AGENT

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

DEPLOYMENT_TYPE_VERIDATA_SERVER

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

DISASTER_RECOVERY_STATUS_DISABLED

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

DISASTER_RECOVERY_STATUS_ENABLED

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

ENVIRONMENT_TYPE_DEVELOPMENT_OR_TESTING

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

ENVIRONMENT_TYPE_PRODUCTION

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

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE

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

LICENSE_MODEL_LICENSE_INCLUDED

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

availability_domain

Gets the availability_domain of this CreateDeploymentDetails.

backup_schedule

Gets the backup_schedule of this CreateDeploymentDetails.

byol_cpu_core_count_limit

Gets the byol_cpu_core_count_limit of this CreateDeploymentDetails.

cluster_placement_group_id

Gets the cluster_placement_group_id of this CreateDeploymentDetails.

compartment_id

[Required] Gets the compartment_id of this CreateDeploymentDetails.

cpu_core_count

Gets the cpu_core_count of this CreateDeploymentDetails.

defined_tags

Gets the defined_tags of this CreateDeploymentDetails.

deployment_backup_id

Gets the deployment_backup_id of this CreateDeploymentDetails.

deployment_type

Gets the deployment_type of this CreateDeploymentDetails. 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'.

description

Gets the description of this CreateDeploymentDetails.

disaster_recovery_status

Gets the disaster_recovery_status of this CreateDeploymentDetails.

display_name

[Required] Gets the display_name of this CreateDeploymentDetails.

environment_type

Gets the environment_type of this CreateDeploymentDetails.

fault_domain

Gets the fault_domain of this CreateDeploymentDetails.

fqdn

Gets the fqdn of this CreateDeploymentDetails.

freeform_tags

Gets the freeform_tags of this CreateDeploymentDetails.

is_auto_scaling_enabled

Gets the is_auto_scaling_enabled of this CreateDeploymentDetails.

is_byol_cpu_core_count_limit_enabled

Gets the is_byol_cpu_core_count_limit_enabled of this CreateDeploymentDetails.

is_public

Gets the is_public of this CreateDeploymentDetails.

license_model

Gets the license_model of this CreateDeploymentDetails.

load_balancer_subnet_id

Gets the load_balancer_subnet_id of this CreateDeploymentDetails.

locks

Gets the locks of this CreateDeploymentDetails.

maintenance_configuration

Gets the maintenance_configuration of this CreateDeploymentDetails.

maintenance_window

Gets the maintenance_window of this CreateDeploymentDetails.

nsg_ids

Gets the nsg_ids of this CreateDeploymentDetails.

ogg_data

Gets the ogg_data of this CreateDeploymentDetails.

placements

Gets the placements of this CreateDeploymentDetails.

security_attributes

Gets the security_attributes of this CreateDeploymentDetails.

source_deployment_id

Gets the source_deployment_id of this CreateDeploymentDetails.

subnet_id

[Required] Gets the subnet_id of this CreateDeploymentDetails.

subscription_id

Gets the subscription_id of this CreateDeploymentDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateDeploymentDetails object with values from keyword arguments.

DEPLOYMENT_TYPE_BIGDATA = 'BIGDATA'

A constant which can be used with the deployment_type property of a CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. This constant has a value of “GGSA”

DEPLOYMENT_TYPE_OGG = 'OGG'

A constant which can be used with the deployment_type property of a CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. 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 CreateDeploymentDetails. This constant has a value of “LICENSE_INCLUDED”

__init__(**kwargs)

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

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

  • license_model (str) – The value to assign to the license_model property of this CreateDeploymentDetails. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

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

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

  • environment_type (str) – The value to assign to the environment_type property of this CreateDeploymentDetails. Allowed values for this property are: “PRODUCTION”, “DEVELOPMENT_OR_TESTING”

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • deployment_type (str) – The value to assign to the deployment_type property of this CreateDeploymentDetails. 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”

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

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

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

  • disaster_recovery_status (str) – The value to assign to the disaster_recovery_status property of this CreateDeploymentDetails. Allowed values for this property are: “ENABLED”, “DISABLED”

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

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

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

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

property availability_domain

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

Returns

The availability_domain of this CreateDeploymentDetails.

Return type

str

property backup_schedule

Gets the backup_schedule of this CreateDeploymentDetails.

Returns

The backup_schedule of this CreateDeploymentDetails.

Return type

oci.golden_gate.models.CreateBackupScheduleDetails

property byol_cpu_core_count_limit

Gets the byol_cpu_core_count_limit of this CreateDeploymentDetails. 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 CreateDeploymentDetails.

Return type

int

property cluster_placement_group_id

Gets the cluster_placement_group_id of this CreateDeploymentDetails. 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 CreateDeploymentDetails.

Return type

str

property compartment_id

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

Returns

The compartment_id of this CreateDeploymentDetails.

Return type

str

property cpu_core_count

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

Returns

The cpu_core_count of this CreateDeploymentDetails.

Return type

int

property defined_tags

Gets the defined_tags of this CreateDeploymentDetails. 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 CreateDeploymentDetails.

Return type

dict(str, dict(str, object))

property deployment_backup_id

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

Returns

The deployment_backup_id of this CreateDeploymentDetails.

Return type

str

property deployment_type

Gets the deployment_type of this CreateDeploymentDetails. 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”

Returns

The deployment_type of this CreateDeploymentDetails.

Return type

str

property description

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

Returns

The description of this CreateDeploymentDetails.

Return type

str

property disaster_recovery_status

Gets the disaster_recovery_status of this CreateDeploymentDetails. 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”

Returns

The disaster_recovery_status of this CreateDeploymentDetails.

Return type

str

property display_name

[Required] Gets the display_name of this CreateDeploymentDetails. An object’s Display Name.

Returns

The display_name of this CreateDeploymentDetails.

Return type

str

property environment_type

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

Allowed values for this property are: “PRODUCTION”, “DEVELOPMENT_OR_TESTING”

Returns

The environment_type of this CreateDeploymentDetails.

Return type

str

property fault_domain

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

Returns

The fault_domain of this CreateDeploymentDetails.

Return type

str

property fqdn

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

Returns

The fqdn of this CreateDeploymentDetails.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property is_auto_scaling_enabled

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

Returns

The is_auto_scaling_enabled of this CreateDeploymentDetails.

Return type

bool

property is_byol_cpu_core_count_limit_enabled

Gets the is_byol_cpu_core_count_limit_enabled of this CreateDeploymentDetails. 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 CreateDeploymentDetails.

Return type

bool

property is_public

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

Returns

The is_public of this CreateDeploymentDetails.

Return type

bool

property license_model

Gets the license_model of this CreateDeploymentDetails. The Oracle license model that applies to a Deployment.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

Returns

The license_model of this CreateDeploymentDetails.

Return type

str

property load_balancer_subnet_id

Gets the load_balancer_subnet_id of this CreateDeploymentDetails. 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 CreateDeploymentDetails.

Return type

str

property locks

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

Returns

The locks of this CreateDeploymentDetails.

Return type

list[oci.golden_gate.models.AddResourceLockDetails]

property maintenance_configuration

Gets the maintenance_configuration of this CreateDeploymentDetails.

Returns

The maintenance_configuration of this CreateDeploymentDetails.

Return type

oci.golden_gate.models.CreateMaintenanceConfigurationDetails

property maintenance_window

Gets the maintenance_window of this CreateDeploymentDetails.

Returns

The maintenance_window of this CreateDeploymentDetails.

Return type

oci.golden_gate.models.CreateMaintenanceWindowDetails

property nsg_ids

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

Returns

The nsg_ids of this CreateDeploymentDetails.

Return type

list[str]

property ogg_data

Gets the ogg_data of this CreateDeploymentDetails.

Returns

The ogg_data of this CreateDeploymentDetails.

Return type

oci.golden_gate.models.CreateOggDeploymentDetails

property placements

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

Returns

The placements of this CreateDeploymentDetails.

Return type

list[oci.golden_gate.models.DeploymentPlacementDetails]

property security_attributes

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

Return type

dict(str, dict(str, object))

property source_deployment_id

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

Returns

The source_deployment_id of this CreateDeploymentDetails.

Return type

str

property subnet_id

[Required] Gets the subnet_id of this CreateDeploymentDetails. 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 CreateDeploymentDetails.

Return type

str

property subscription_id

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

Returns

The subscription_id of this CreateDeploymentDetails.

Return type

str