Class Deployment

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

Inheritance
object
Deployment
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class Deployment

Properties

AvailabilityDomain

Declaration
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type Description
string

The availability domain of a placement.

BackupSchedule

Declaration
[JsonProperty(PropertyName = "backupSchedule")]
public BackupSchedule BackupSchedule { get; set; }
Property Value
Type Description
BackupSchedule

Category

Declaration
[Required(ErrorMessage = "Category is required.")]
[JsonProperty(PropertyName = "category")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DeploymentCategory? Category { get; set; }
Property Value
Type Description
DeploymentCategory?

The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment being referenced.
Remarks

Required

CpuCoreCount

Declaration
[Required(ErrorMessage = "CpuCoreCount is required.")]
[JsonProperty(PropertyName = "cpuCoreCount")]
public int? CpuCoreCount { get; set; }
Property Value
Type Description
int?

The Minimum number of OCPUs to be made available for this Deployment.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: {"foo-namespace": {"bar-key": "value"}}

DeploymentBackupId

Declaration
[JsonProperty(PropertyName = "deploymentBackupId")]
public string DeploymentBackupId { get; set; }
Property Value
Type Description
string

The OCID of the backup being referenced.

DeploymentDiagnosticData

Declaration
[JsonProperty(PropertyName = "deploymentDiagnosticData")]
public DeploymentDiagnosticData DeploymentDiagnosticData { get; set; }
Property Value
Type Description
DeploymentDiagnosticData

DeploymentRole

Declaration
[JsonProperty(PropertyName = "deploymentRole")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DeploymentRole? DeploymentRole { get; set; }
Property Value
Type Description
DeploymentRole?

The type of the deployment role.

DeploymentType

Declaration
[Required(ErrorMessage = "DeploymentType is required.")]
[JsonProperty(PropertyName = "deploymentType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DeploymentType? DeploymentType { get; set; }
Property Value
Type Description
DeploymentType?

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'.
Remarks

Required

DeploymentUrl

Declaration
[JsonProperty(PropertyName = "deploymentUrl")]
public string DeploymentUrl { get; set; }
Property Value
Type Description
string

The URL of a resource.

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Metadata about this specific object.

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

An object's Display Name.

EnvironmentType

Declaration
[JsonProperty(PropertyName = "environmentType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public EnvironmentType? EnvironmentType { get; set; }
Property Value
Type Description
EnvironmentType?

Specifies whether the deployment is used in a production or development/testing environment.

FaultDomain

Declaration
[JsonProperty(PropertyName = "faultDomain")]
public string FaultDomain { get; set; }
Property Value
Type Description
string

The fault domain of a placement.

Fqdn

Declaration
[JsonProperty(PropertyName = "fqdn")]
public string Fqdn { get; set; }
Property Value
Type Description
string

A three-label Fully Qualified Domain Name (FQDN) for a resource.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: {"bar-key": "value"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the deployment being referenced.
Remarks

Required

IngressIps

Declaration
[JsonProperty(PropertyName = "ingressIps")]
public List<IngressIpDetails> IngressIps { get; set; }
Property Value
Type Description
List<IngressIpDetails>

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.

IsAutoScalingEnabled

Declaration
[Required(ErrorMessage = "IsAutoScalingEnabled is required.")]
[JsonProperty(PropertyName = "isAutoScalingEnabled")]
public bool? IsAutoScalingEnabled { get; set; }
Property Value
Type Description
bool?

Indicates if auto scaling is enabled for the Deployment's CPU core count.
Remarks

Required

IsHealthy

Declaration
[JsonProperty(PropertyName = "isHealthy")]
public bool? IsHealthy { get; set; }
Property Value
Type Description
bool?

True if all of the aggregate resources are working correctly.

IsLatestVersion

Declaration
[JsonProperty(PropertyName = "isLatestVersion")]
public bool? IsLatestVersion { get; set; }
Property Value
Type Description
bool?

Indicates if the resource is the the latest available version.

IsPublic

Declaration
[JsonProperty(PropertyName = "isPublic")]
public bool? IsPublic { get; set; }
Property Value
Type Description
bool?

True if this object is publicly available.

IsStorageUtilizationLimitExceeded

Declaration
[JsonProperty(PropertyName = "isStorageUtilizationLimitExceeded")]
public bool? IsStorageUtilizationLimitExceeded { get; set; }
Property Value
Type Description
bool?

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.

LicenseModel

Declaration
[Required(ErrorMessage = "LicenseModel is required.")]
[JsonProperty(PropertyName = "licenseModel")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LicenseModel? LicenseModel { get; set; }
Property Value
Type Description
LicenseModel?

The Oracle license model that applies to a Deployment.
Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

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.

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

Possible lifecycle states.

LifecycleSubState

Declaration
[JsonProperty(PropertyName = "lifecycleSubState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleSubState? LifecycleSubState { get; set; }
Property Value
Type Description
LifecycleSubState?

Possible GGS lifecycle sub-states.

LoadBalancerId

Declaration
[JsonProperty(PropertyName = "loadBalancerId")]
public string LoadBalancerId { get; set; }
Property Value
Type Description
string

The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.

LoadBalancerSubnetId

Declaration
[JsonProperty(PropertyName = "loadBalancerSubnetId")]
public string LoadBalancerSubnetId { get; set; }
Property Value
Type Description
string

The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.

Locks

Declaration
[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }
Property Value
Type Description
List<ResourceLock>

Locks associated with this resource.

MaintenanceConfiguration

Declaration
[JsonProperty(PropertyName = "maintenanceConfiguration")]
public MaintenanceConfiguration MaintenanceConfiguration { get; set; }
Property Value
Type Description
MaintenanceConfiguration

MaintenanceWindow

Declaration
[JsonProperty(PropertyName = "maintenanceWindow")]
public MaintenanceWindow MaintenanceWindow { get; set; }
Property Value
Type Description
MaintenanceWindow

NextMaintenanceActionType

Declaration
[JsonProperty(PropertyName = "nextMaintenanceActionType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MaintenanceActionType? NextMaintenanceActionType { get; set; }
Property Value
Type Description
MaintenanceActionType?

Type of the next maintenance.

NextMaintenanceDescription

Declaration
[JsonProperty(PropertyName = "nextMaintenanceDescription")]
public string NextMaintenanceDescription { get; set; }
Property Value
Type Description
string

Description of the next maintenance.

NsgIds

Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type Description
List<string>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

OggData

Declaration
[JsonProperty(PropertyName = "oggData")]
public OggDeployment OggData { get; set; }
Property Value
Type Description
OggDeployment

Placements

Declaration
[JsonProperty(PropertyName = "placements")]
public List<DeploymentPlacementInfo> Placements { get; set; }
Property Value
Type Description
List<DeploymentPlacementInfo>

An array of local peers of deployment

PrivateIpAddress

Declaration
[JsonProperty(PropertyName = "privateIpAddress")]
public string PrivateIpAddress { get; set; }
Property Value
Type Description
string

The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.

PublicIpAddress

Declaration
[JsonProperty(PropertyName = "publicIpAddress")]
public string PublicIpAddress { get; set; }
Property Value
Type Description
string

The public IP address representing the access point for the Deployment.

SourceDeploymentId

Declaration
[JsonProperty(PropertyName = "sourceDeploymentId")]
public string SourceDeploymentId { get; set; }
Property Value
Type Description
string

The OCID of the deployment being referenced.

StorageUtilizationInBytes

Declaration
[JsonProperty(PropertyName = "storageUtilizationInBytes")]
public long? StorageUtilizationInBytes { get; set; }
Property Value
Type Description
long?

The amount of storage being utilized (in bytes)

SubnetId

Declaration
[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type Description
string

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.
Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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}}

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

TimeLastBackupScheduled

Declaration
[JsonProperty(PropertyName = "timeLastBackupScheduled")]
public DateTime? TimeLastBackupScheduled { get; set; }
Property Value
Type Description
DateTime?

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

TimeNextBackupScheduled

Declaration
[JsonProperty(PropertyName = "timeNextBackupScheduled")]
public DateTime? TimeNextBackupScheduled { get; set; }
Property Value
Type Description
DateTime?

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

TimeOfNextMaintenance

Declaration
[JsonProperty(PropertyName = "timeOfNextMaintenance")]
public DateTime? TimeOfNextMaintenance { get; set; }
Property Value
Type Description
DateTime?

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

TimeOggVersionSupportedUntil

Declaration
[JsonProperty(PropertyName = "timeOggVersionSupportedUntil")]
public DateTime? TimeOggVersionSupportedUntil { get; set; }
Property Value
Type Description
DateTime?

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.

TimeRoleChanged

Declaration
[JsonProperty(PropertyName = "timeRoleChanged")]
public DateTime? TimeRoleChanged { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpgradeRequired

Declaration
[JsonProperty(PropertyName = "timeUpgradeRequired")]
public DateTime? TimeUpgradeRequired { get; set; }
Property Value
Type Description
DateTime?

Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records to check, when deployment will be forced to upgrade to a newer version. Old description: The date the existing version in use will no longer be considered as usable and an upgrade will be required. This date is typically 6 months after the version was released for use by GGS. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.