--- title: "POST /v1/{+parent}/goldengateDeployments" method: POST path: "/v1/{+parent}/goldengateDeployments" tags: ["projects"] --- # POST /v1/{+parent}/goldengateDeployments `POST /v1/{+parent}/goldengateDeployments` Creates a new GoldengateDeployment in a given project and location. ## Path parameters - `parent` string, required ## Query parameters - `goldengateDeploymentId` string - `requestId` string ## Request body - GoldengateDeployment — GoldengateDeployment Goldengate Deployment resource model. - `name` string — Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment} - `ociUrl` string — Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. - `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. - `displayName` string — Required. The display name for the GoldengateDeployment. - `properties` GoldengateDeploymentProperties — Properties of GoldengateDeployment. - `nextMaintenanceActionType` 'NEXT_MAINTENANCE_ACTION_TYPE_UNSPECIFIED' | 'UPGRADE' — Output only. The next maintenance action type of the GoldengateDeployment. - `environmentType` string — Optional. The environment type of the GoldengateDeployment. - `updateTime` string, google-datetime — Output only. The time the GoldengateDeployment was updated. - `lifecycleState` 'GOLDENGATE_DEPLOYMENT_LIFECYCLE_STATE_UNSPECIFIED' | 'CREATING' | 'UPDATING' | 'ACTIVE' | 'INACTIVE' | 'DELETING' | 'DELETED' | 'FAILED' | 'NEEDS_ATTENTION' | 'IN_PROGRESS' | 'CANCELLING' | 'CANCELLED' | 'SUCCEEDED' | 'WAITING' — Output only. State of the GoldengateDeployment. - `nextMaintenanceTime` string, google-datetime — Output only. The time of next maintenance of the GoldengateDeployment. - `storageUtilizationBytes` string, int64 — Output only. The storage utilization in bytes of the GoldengateDeployment. - `oggVersionSupportEndTime` string, google-datetime — Output only. The time ogg version supported until of the GoldengateDeployment. - `nextBackupScheduleTime` string, google-datetime — Output only. The time next backup scheduled of the GoldengateDeployment. - `roleChangeTime` string, google-datetime — Output only. The time when the role of the GoldengateDeployment was changed. - `ingressIps` IngressIp[] — Output only. The ingress ips of the GoldengateDeployment. - `ingressIpAddress` string — Output only. The ingress IP. - `deploymentRole` 'GOLDENGATE_DEPLOYMENT_ROLE_TYPE_UNSPECIFIED' | 'PRIMARY' | 'STANDBY' — Output only. The deployment role of the GoldengateDeployment. - `upgradeRequiredTime` string, google-datetime — Output only. The time upgrade required of the GoldengateDeployment. - `ocid` string — Output only. OCID of the GoldengateDeployment. - `deploymentType` string — Required. A valid Goldengate Deployment type. For a list of supported types, use the `ListGoldengateDeploymentTypes` operation. - `isPublic` boolean — Output only. Whether the GoldengateDeployment is public. - `locks` GoldengateDeploymentLock[] — Output only. The locks of the GoldengateDeployment. - `type` 'LOCK_TYPE_UNSPECIFIED' | 'FULL' | 'DELETE' — Output only. The type of lock. - `compartmentId` string — Output only. The compartment id. - `relatedResourceId` string — Output only. The related resource id. - `message` string — Output only. The message. - `createTime` string, google-datetime — Output only. The time created. - `maintenanceWindow` GoldengateMaintenanceWindow — The maintenance window of the GoldengateDeployment. - `day` 'DAY_OF_WEEK_UNSPECIFIED' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' — Required. Days of the week. - `startHour` integer — Required. Start hour for maintenance period. Hour is in UTC. - `deploymentBackupId` string — Output only. The deployment backup id of the GoldengateDeployment. - `fqdn` string — Output only. The Fully Qualified Domain Name of the GoldengateDeployment. - `loadBalancerSubnetId` string — Output only. The load balancer subnet id of the GoldengateDeployment. - `nsgIds` string[] — Output only. The nsg ids of the GoldengateDeployment. - `licenseModel` 'LICENSE_MODEL_UNSPECIFIED' | 'LICENSE_INCLUDED' | 'BRING_YOUR_OWN_LICENSE' — Optional. The Oracle license model that applies to a Deployment. - `isLatestVersion` boolean — Output only. Whether the GoldengateDeployment is of the latest version. - `publicIpAddress` string — Output only. The public ip address of the GoldengateDeployment. - `oggData` GoldengateOggDeployment — The Ogg data of the GoldengateDeployment. - `certificate` string — Output only. The certificate of the GoldengateDeployment. - `identityDomainId` string — Output only. The identity domain id of the GoldengateDeployment. - `oggVersion` string — Optional. Version of OGG - `passwordSecretId` string — Output only. The password secret id of the GoldengateDeployment. - `adminUsername` string — Required. The Goldengate deployment console username. - `adminPassword` string — Optional. The Goldengate deployment console password in plain text. - `deployment` string — Required. The name given to the Goldengate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter. - `credentialStore` 'CREDENTIAL_STORE_UNSPECIFIED' | 'GOLDENGATE' | 'IAM' — Output only. The credential store of the GoldengateDeployment. - `adminPasswordSecretVersion` string — Optional. Input only. The Goldengate deployment console password secret version. - `groupRolesMapping` GoldengateGroupToRolesMapping — The group to roles mapping of the GoldengateDeployment. - `operatorGroupId` string — Output only. The operator group id. - `securityGroupId` string — Output only. The security group id. - `administratorGroupId` string — Output only. The administrator group id. - `userGroupId` string — Output only. The user group id. - `deploymentUrl` string — Output only. The deployment url of the GoldengateDeployment. - `lastBackupScheduleTime` string, google-datetime — Output only. The time last backup scheduled of the GoldengateDeployment. - `backupSchedule` GoldengateBackupSchedule — The backup schedule of the GoldengateDeployment. - `backupScheduledTime` string, google-datetime — Output only. The timestamp of when the backup was scheduled. - `namespace` string — Output only. The namespace name. - `frequencyBackupScheduled` 'FREQUENCY_BACKUP_SCHEDULED_UNSPECIFIED' | 'DAILY' | 'WEEKLY' | 'MONTHLY' — Output only. The frequency backup scheduled. - `bucket` string — Output only. The bucket name. - `compartmentId` string — Output only. The compartment id. - `metadataOnly` boolean — Output only. If metadata only. - `nextMaintenanceDescription` string — Output only. The next maintenance description of the GoldengateDeployment. - `healthy` boolean — Output only. Whether the GoldengateDeployment is healthy. - `placements` GoldengatePlacement[] — Output only. The placements of the GoldengateDeployment. - `availabilityDomain` string — Output only. The availability domain. - `faultDomain` string — Output only. The fault domain. - `maintenanceConfig` GoldengateMaintenanceConfig — The maintenance configuration of the GoldengateDeployment. - `majorReleaseUpgradePeriodDays` integer — Optional. Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default. - `securityPatchUpgradePeriodDays` integer — Optional. Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default. - `interimReleaseUpgradePeriodDays` integer — Optional. Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period. - `bundleReleaseUpgradePeriodDays` integer — Optional. Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default. - `isInterimReleaseAutoUpgradeEnabled` boolean — Optional. By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interim_release_upgrade_period_days too. - `category` 'GOLDENGATE_DEPLOYMENT_CATEGORY_UNSPECIFIED' | 'DATA_REPLICATION' | 'DATA_TRANSFORMS' — Output only. The category of the GoldengateDeployment. - `cpuCoreCount` integer — Optional. The Minimum number of OCPUs to be made available for this Deployment. - `lifecycleDetails` string — Output only. The lifecycle details of the GoldengateDeployment. - `loadBalancerId` string — Output only. The load balancer id of the GoldengateDeployment. - `isAutoScalingEnabled` boolean — Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count. - `lifecycleSubState` 'GOLDENGATE_DEPLOYMENT_LIFECYCLE_SUB_STATE_UNSPECIFIED' | 'RECOVERING' | 'STARTING' | 'STOPPING' | 'MOVING' | 'UPGRADING' | 'RESTORING' | 'BACKING_UP' | 'ROLLING_BACK' — Output only. The lifecycle sub-state of the GoldengateDeployment. - `privateIpAddress` string — Output only. The private ip address of the GoldengateDeployment. - `isStorageUtilizationLimitExceeded` boolean — Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment. - `description` string — Optional. The description of the GoldengateDeployment. - `deploymentDiagnosticData` DeploymentDiagnosticData — The deployment diagnostic data. - `namespace` string — Output only. The namespace name. - `diagnosticEndTime` string, google-datetime — Output only. The time diagnostic end. - `object` string — Output only. The object name. - `diagnosticState` 'DIAGNOSTIC_STATE_UNSPECIFIED' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' — Output only. The diagnostic state. - `diagnosticStartTime` string, google-datetime — Output only. The time diagnostic start. - `bucket` string — Output only. The bucket name. - `odbSubnet` string — Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation. - `labels` object — Optional. The labels or tags associated with the GoldengateDeployment. - `entitlementId` string — Output only. The ID of the subscription entitlement associated with the GoldengateDeployment - `odbNetwork` string — Optional. The name of the OdbNetwork associated with the GoldengateDeployment. - `createTime` string, google-datetime — Output only. The date and time that the GoldengateDeployment was created. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/oracledatabase.md) · [All operations](https://skmtc.net/google/apis/oracledatabase/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/oracledatabase/versions/120ce7891e09/schema)