goldengate_deployments

Creates, updates, deletes, gets or lists a goldengate_deployments resource.

Overview

Name	goldengate_deployments
Type	Resource
Id	google.oracledatabase.goldengate_deployments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
createTime	string (google-datetime)	Output only. The date and time that the GoldengateDeployment was created.
displayName	string	Required. The display name for the GoldengateDeployment.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the GoldengateDeployment
gcpOracleZone	string	Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
labels	object	Optional. The labels or tags associated with the GoldengateDeployment.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
odbNetwork	string	Optional. The name of the OdbNetwork associated with the GoldengateDeployment.
odbSubnet	string	Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.
properties	object	Required. The properties of the GoldengateDeployment. (id: GoldengateDeploymentProperties)

list

Name	Datatype	Description
name	string	Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
createTime	string (google-datetime)	Output only. The date and time that the GoldengateDeployment was created.
displayName	string	Required. The display name for the GoldengateDeployment.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the GoldengateDeployment
gcpOracleZone	string	Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
labels	object	Optional. The labels or tags associated with the GoldengateDeployment.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
odbNetwork	string	Optional. The name of the OdbNetwork associated with the GoldengateDeployment.
odbSubnet	string	Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.
properties	object	Required. The properties of the GoldengateDeployment. (id: GoldengateDeploymentProperties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, goldengateDeploymentsId		Gets details of a single GoldengateDeployment.
list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Lists all the GoldengateDeployments for the given project and location.
create	insert	projectsId, locationsId	goldengateDeploymentId, requestId	Creates a new GoldengateDeployment in a given project and location.
delete	delete	projectsId, locationsId, goldengateDeploymentsId	requestId	Deletes a single GoldengateDeployment.
start	exec	projectsId, locationsId, goldengateDeploymentsId		Starts a single GoldengateDeployment.
stop	exec	projectsId, locationsId, goldengateDeploymentsId		Stops a single GoldengateDeployment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
goldengateDeploymentsId	string
locationsId	string
projectsId	string
filter	string
goldengateDeploymentId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single GoldengateDeployment.

SELECT
name,
createTime,
displayName,
entitlementId,
gcpOracleZone,
labels,
ociUrl,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.goldengate_deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND goldengateDeploymentsId = '{{ goldengateDeploymentsId }}' -- required
;

list

Lists all the GoldengateDeployments for the given project and location.

SELECT
name,
createTime,
displayName,
entitlementId,
gcpOracleZone,
labels,
ociUrl,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.goldengate_deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new GoldengateDeployment in a given project and location.

INSERT INTO google.oracledatabase.goldengate_deployments (
data__displayName,
data__gcpOracleZone,
data__labels,
data__name,
data__odbNetwork,
data__odbSubnet,
data__properties,
projectsId,
locationsId,
goldengateDeploymentId,
requestId
)
SELECT 
'{{ displayName }}',
'{{ gcpOracleZone }}',
'{{ labels }}',
'{{ name }}',
'{{ odbNetwork }}',
'{{ odbSubnet }}',
'{{ properties }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ goldengateDeploymentId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: goldengate_deployments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the goldengate_deployments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the goldengate_deployments resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name for the GoldengateDeployment.
  - name: gcpOracleZone
    value: "{{ gcpOracleZone }}"
    description: |
      Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. The labels or tags associated with the GoldengateDeployment.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
  - name: odbNetwork
    value: "{{ odbNetwork }}"
    description: |
      Optional. The name of the OdbNetwork associated with the GoldengateDeployment.
  - name: odbSubnet
    value: "{{ odbSubnet }}"
    description: |
      Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.
  - name: properties
    description: |
      Required. The properties of the GoldengateDeployment.
    value:
      backupSchedule:
        backupScheduledTime: "{{ backupScheduledTime }}"
        bucket: "{{ bucket }}"
        compartmentId: "{{ compartmentId }}"
        frequencyBackupScheduled: "{{ frequencyBackupScheduled }}"
        metadataOnly: {{ metadataOnly }}
        namespace: "{{ namespace }}"
      category: "{{ category }}"
      cpuCoreCount: {{ cpuCoreCount }}
      deploymentBackupId: "{{ deploymentBackupId }}"
      deploymentDiagnosticData:
        bucket: "{{ bucket }}"
        diagnosticEndTime: "{{ diagnosticEndTime }}"
        diagnosticStartTime: "{{ diagnosticStartTime }}"
        diagnosticState: "{{ diagnosticState }}"
        namespace: "{{ namespace }}"
        object: "{{ object }}"
      deploymentRole: "{{ deploymentRole }}"
      deploymentType: "{{ deploymentType }}"
      deploymentUrl: "{{ deploymentUrl }}"
      description: "{{ description }}"
      environmentType: "{{ environmentType }}"
      fqdn: "{{ fqdn }}"
      healthy: {{ healthy }}
      ingressIps:
        - ingressIpAddress: "{{ ingressIpAddress }}"
      isAutoScalingEnabled: {{ isAutoScalingEnabled }}
      isLatestVersion: {{ isLatestVersion }}
      isPublic: {{ isPublic }}
      isStorageUtilizationLimitExceeded: {{ isStorageUtilizationLimitExceeded }}
      lastBackupScheduleTime: "{{ lastBackupScheduleTime }}"
      licenseModel: "{{ licenseModel }}"
      lifecycleDetails: "{{ lifecycleDetails }}"
      lifecycleState: "{{ lifecycleState }}"
      lifecycleSubState: "{{ lifecycleSubState }}"
      loadBalancerId: "{{ loadBalancerId }}"
      loadBalancerSubnetId: "{{ loadBalancerSubnetId }}"
      locks:
        - compartmentId: "{{ compartmentId }}"
          createTime: "{{ createTime }}"
          message: "{{ message }}"
          relatedResourceId: "{{ relatedResourceId }}"
          type: "{{ type }}"
      maintenanceConfig:
        bundleReleaseUpgradePeriodDays: {{ bundleReleaseUpgradePeriodDays }}
        interimReleaseUpgradePeriodDays: {{ interimReleaseUpgradePeriodDays }}
        isInterimReleaseAutoUpgradeEnabled: {{ isInterimReleaseAutoUpgradeEnabled }}
        majorReleaseUpgradePeriodDays: {{ majorReleaseUpgradePeriodDays }}
        securityPatchUpgradePeriodDays: {{ securityPatchUpgradePeriodDays }}
      maintenanceWindow:
        day: "{{ day }}"
        startHour: {{ startHour }}
      nextBackupScheduleTime: "{{ nextBackupScheduleTime }}"
      nextMaintenanceActionType: "{{ nextMaintenanceActionType }}"
      nextMaintenanceDescription: "{{ nextMaintenanceDescription }}"
      nextMaintenanceTime: "{{ nextMaintenanceTime }}"
      nsgIds:
        - "{{ nsgIds }}"
      ocid: "{{ ocid }}"
      oggData:
        adminPassword: "{{ adminPassword }}"
        adminPasswordSecretVersion: "{{ adminPasswordSecretVersion }}"
        adminUsername: "{{ adminUsername }}"
        certificate: "{{ certificate }}"
        credentialStore: "{{ credentialStore }}"
        deployment: "{{ deployment }}"
        groupRolesMapping:
          administratorGroupId: "{{ administratorGroupId }}"
          operatorGroupId: "{{ operatorGroupId }}"
          securityGroupId: "{{ securityGroupId }}"
          userGroupId: "{{ userGroupId }}"
        identityDomainId: "{{ identityDomainId }}"
        oggVersion: "{{ oggVersion }}"
        passwordSecretId: "{{ passwordSecretId }}"
      oggVersionSupportEndTime: "{{ oggVersionSupportEndTime }}"
      placements:
        - availabilityDomain: "{{ availabilityDomain }}"
          faultDomain: "{{ faultDomain }}"
      privateIpAddress: "{{ privateIpAddress }}"
      publicIpAddress: "{{ publicIpAddress }}"
      roleChangeTime: "{{ roleChangeTime }}"
      storageUtilizationBytes: "{{ storageUtilizationBytes }}"
      updateTime: "{{ updateTime }}"
      upgradeRequiredTime: "{{ upgradeRequiredTime }}"
  - name: goldengateDeploymentId
    value: "{{ goldengateDeploymentId }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes a single GoldengateDeployment.

DELETE FROM google.oracledatabase.goldengate_deployments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND goldengateDeploymentsId = '{{ goldengateDeploymentsId }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

start

Starts a single GoldengateDeployment.

EXEC google.oracledatabase.goldengate_deployments.start 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@goldengateDeploymentsId='{{ goldengateDeploymentsId }}' --required
;

stop

Stops a single GoldengateDeployment.

EXEC google.oracledatabase.goldengate_deployments.stop 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@goldengateDeploymentsId='{{ goldengateDeploymentsId }}' --required
;