Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Deployment

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

Properties

compartmentId

compartmentId: string

The OCID of the compartment being referenced.

cpuCoreCount

cpuCoreCount: number

The Minimum number of OCPUs to be made available for this Deployment. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional definedTags

definedTags: undefined | object

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional deploymentBackupId

deploymentBackupId: undefined | string

The OCID of the backup being referenced.

Optional deploymentDiagnosticData

deploymentDiagnosticData: model.DeploymentDiagnosticData

deploymentType

deploymentType: 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'.

Optional deploymentUrl

deploymentUrl: undefined | string

The URL of a resource.

Optional description

description: undefined | string

Metadata about this specific object.

Optional displayName

displayName: undefined | string

An object's Display Name.

Optional fqdn

fqdn: undefined | string

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

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {@code {\"bar-key\": \"value\"}}

id

id: string

The OCID of the deployment being referenced.

Optional ingressIps

ingressIps: Array<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

isAutoScalingEnabled: boolean

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

Optional isHealthy

isHealthy: undefined | false | true

True if all of the aggregate resources are working correctly.

Optional isLatestVersion

isLatestVersion: undefined | false | true

Indicates if the resource is the the latest available version.

Optional isPublic

isPublic: undefined | false | true

True if this object is publicly available.

Optional isStorageUtilizationLimitExceeded

isStorageUtilizationLimitExceeded: undefined | false | true

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

licenseModel: LicenseModel

The Oracle license model that applies to a Deployment.

Optional lifecycleDetails

lifecycleDetails: undefined | 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.

Optional lifecycleState

lifecycleState: model.LifecycleState

Possible lifecycle states.

Optional lifecycleSubState

lifecycleSubState: model.LifecycleSubState

Possible GGS lifecycle sub-states.

Optional loadBalancerId

loadBalancerId: undefined | string

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

Optional loadBalancerSubnetId

loadBalancerSubnetId: undefined | 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 compatiblity this is an optional property for now, but it will become mandatory (for public deployments only) after October 1, 2024.

Optional maintenanceConfiguration

maintenanceConfiguration: model.MaintenanceConfiguration

Optional maintenanceWindow

maintenanceWindow: model.MaintenanceWindow

Optional nextMaintenanceActionType

nextMaintenanceActionType: model.MaintenanceActionType

Type of the next maintenance.

Optional nextMaintenanceDescription

nextMaintenanceDescription: undefined | string

Description of the next maintenance.

Optional nsgIds

nsgIds: Array<string>

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

Optional oggData

oggData: model.OggDeployment

Optional privateIpAddress

privateIpAddress: undefined | string

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

Optional publicIpAddress

publicIpAddress: undefined | string

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

Optional storageUtilizationInBytes

storageUtilizationInBytes: undefined | number

The amount of storage being utilized (in bytes) Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

subnetId

subnetId: string

The OCID of the subnet of the deployment's private endpoint.

Optional systemTags

systemTags: undefined | 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: {@code {orcl-cloud: {free-tier-retain: true}}}

Optional timeCreated

timeCreated: Date

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

Optional timeOfNextMaintenance

timeOfNextMaintenance: Date

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

Optional timeOggVersionSupportedUntil

timeOggVersionSupportedUntil: Date

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 {@code 2016-08-25T21:10:29.600Z}.

Optional timeUpdated

timeUpdated: Date

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

Optional timeUpgradeRequired

timeUpgradeRequired: Date

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 {@code 2016-08-25T21:10:29.600Z}.

Functions

getDeserializedJsonObj

getJsonObj