Oracle Cloud Infrastructure v2.32.0, Apr 24 25

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.GoldenGate.getDeployment

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDeployment = oci.GoldenGate.getDeployment({
    deploymentId: testDeploymentOciGoldenGateDeployment.id,
});

import pulumi
import pulumi_oci as oci

test_deployment = oci.GoldenGate.get_deployment(deployment_id=test_deployment_oci_golden_gate_deployment["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/goldengate"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := goldengate.GetDeployment(ctx, &goldengate.GetDeploymentArgs{
			DeploymentId: testDeploymentOciGoldenGateDeployment.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDeployment = Oci.GoldenGate.GetDeployment.Invoke(new()
    {
        DeploymentId = testDeploymentOciGoldenGateDeployment.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.GoldenGateFunctions;
import com.pulumi.oci.GoldenGate.inputs.GetDeploymentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDeployment = GoldenGateFunctions.getDeployment(GetDeploymentArgs.builder()
            .deploymentId(testDeploymentOciGoldenGateDeployment.id())
            .build());

    }
}

variables:
  testDeployment:
    fn::invoke:
      function: oci:GoldenGate:getDeployment
      arguments:
        deploymentId: ${testDeploymentOciGoldenGateDeployment.id}

Using getDeployment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>

def get_deployment(deployment_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(deployment_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]

func GetDeployment(ctx *Context, args *GetDeploymentArgs, opts ...InvokeOption) (*GetDeploymentResult, error)
func GetDeploymentOutput(ctx *Context, args *GetDeploymentOutputArgs, opts ...InvokeOption) GetDeploymentResultOutput

> Note: This function is named GetDeployment in the Go SDK.

public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)

fn::invoke:
  function: oci:GoldenGate/getDeployment:getDeployment
  arguments:
    # arguments dictionary

The following arguments are supported:

DeploymentId string: A unique Deployment identifier.

DeploymentId string: A unique Deployment identifier.

deploymentId String: A unique Deployment identifier.

deploymentId string: A unique Deployment identifier.

deployment_id str: A unique Deployment identifier.

deploymentId String: A unique Deployment identifier.

getDeployment Result

The following output properties are available:

AvailabilityDomain string: The availability domain of a placement.
BackupSchedules List<GetDeploymentBackupSchedule>: Defines the schedule of the deployment backup.
Category string: 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'.
CompartmentId string: The OCID of the compartment being referenced.
CpuCoreCount int: The Minimum number of OCPUs to be made available for this Deployment.
DefinedTags Dictionary<string, string>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string: The OCID of the backup being referenced.
DeploymentDiagnosticDatas List<GetDeploymentDeploymentDiagnosticData>: Information regarding the deployment diagnostic collection
DeploymentId string
DeploymentRole string: The type of the deployment role.
DeploymentType string: 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'.
DeploymentUrl string: The URL of a resource.
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
EnvironmentType string: Specifies whether the deployment is used in a production or development/testing environment.
FaultDomain string: The fault domain of a placement.
Fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags 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 string: The OCID of the deployment being referenced.
IngressIps List<GetDeploymentIngressIp>: 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 bool: Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsHealthy bool: True if all of the aggregate resources are working correctly.
IsLatestVersion bool: Indicates if the resource is the the latest available version.
IsLockOverride bool
IsPublic bool: True if this object is publicly available.
IsStorageUtilizationLimitExceeded 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 string: The Oracle license model that applies to a Deployment.
LifecycleDetails 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.
LifecycleSubState string: Possible GGS lifecycle sub-states.
LoadBalancerId string: The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
LoadBalancerSubnetId 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 List<GetDeploymentLock>: Locks associated with this resource.
MaintenanceConfigurations List<GetDeploymentMaintenanceConfiguration>: Attributes for configuring automatic deployment maintenance.
MaintenanceWindows List<GetDeploymentMaintenanceWindow>: Defines the maintenance window, when automatic actions can be performed.
NextMaintenanceActionType string: Type of the next maintenance.
NextMaintenanceDescription string: Description of the next maintenance.
NsgIds List<string>: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
OggDatas List<GetDeploymentOggData>: Deployment Data for an OggDeployment
Placements List<GetDeploymentPlacement>: An array of local peers of deployment
PrivateIpAddress 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 string: The public IP address representing the access point for the Deployment.
SourceDeploymentId string: The OCID of the deployment being referenced.
State string: Possible lifecycle states.
StorageUtilizationInBytes string: The amount of storage being utilized (in bytes)
SubnetId 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.
SystemTags Dictionary<string, string>: 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 string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeLastBackupScheduled string: The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
TimeNextBackupScheduled string: The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
TimeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOggVersionSupportedUntil string: 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 string: The time of the last role change. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpgradeRequired string: 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.

AvailabilityDomain string: The availability domain of a placement.
BackupSchedules []GetDeploymentBackupSchedule: Defines the schedule of the deployment backup.
Category string: 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'.
CompartmentId string: The OCID of the compartment being referenced.
CpuCoreCount int: The Minimum number of OCPUs to be made available for this Deployment.
DefinedTags map[string]string: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string: The OCID of the backup being referenced.
DeploymentDiagnosticDatas []GetDeploymentDeploymentDiagnosticData: Information regarding the deployment diagnostic collection
DeploymentId string
DeploymentRole string: The type of the deployment role.
DeploymentType string: 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'.
DeploymentUrl string: The URL of a resource.
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
EnvironmentType string: Specifies whether the deployment is used in a production or development/testing environment.
FaultDomain string: The fault domain of a placement.
Fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags map[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 string: The OCID of the deployment being referenced.
IngressIps []GetDeploymentIngressIp: 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 bool: Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsHealthy bool: True if all of the aggregate resources are working correctly.
IsLatestVersion bool: Indicates if the resource is the the latest available version.
IsLockOverride bool
IsPublic bool: True if this object is publicly available.
IsStorageUtilizationLimitExceeded 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 string: The Oracle license model that applies to a Deployment.
LifecycleDetails 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.
LifecycleSubState string: Possible GGS lifecycle sub-states.
LoadBalancerId string: The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
LoadBalancerSubnetId 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 []GetDeploymentLock: Locks associated with this resource.
MaintenanceConfigurations []GetDeploymentMaintenanceConfiguration: Attributes for configuring automatic deployment maintenance.
MaintenanceWindows []GetDeploymentMaintenanceWindow: Defines the maintenance window, when automatic actions can be performed.
NextMaintenanceActionType string: Type of the next maintenance.
NextMaintenanceDescription string: Description of the next maintenance.
NsgIds []string: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
OggDatas []GetDeploymentOggData: Deployment Data for an OggDeployment
Placements []GetDeploymentPlacement: An array of local peers of deployment
PrivateIpAddress 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 string: The public IP address representing the access point for the Deployment.
SourceDeploymentId string: The OCID of the deployment being referenced.
State string: Possible lifecycle states.
StorageUtilizationInBytes string: The amount of storage being utilized (in bytes)
SubnetId 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.
SystemTags map[string]string: 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 string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeLastBackupScheduled string: The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
TimeNextBackupScheduled string: The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
TimeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOggVersionSupportedUntil string: 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 string: The time of the last role change. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpgradeRequired string: 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.

availabilityDomain String: The availability domain of a placement.
backupSchedules List<GetDeploymentBackupSchedule>: Defines the schedule of the deployment backup.
category String: 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'.
compartmentId String: The OCID of the compartment being referenced.
cpuCoreCount Integer: The Minimum number of OCPUs to be made available for this Deployment.
definedTags Map<String,String>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String: The OCID of the backup being referenced.
deploymentDiagnosticDatas List<GetDeploymentDeploymentDiagnosticData>: Information regarding the deployment diagnostic collection
deploymentId String
deploymentRole String: The type of the deployment role.
deploymentType String: 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'.
deploymentUrl String: The URL of a resource.
description String: Metadata about this specific object.
displayName String: An object's Display Name.
environmentType String: Specifies whether the deployment is used in a production or development/testing environment.
faultDomain String: The fault domain of a placement.
fqdn String: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<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 String: The OCID of the deployment being referenced.
ingressIps List<GetDeploymentIngressIp>: 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 Boolean: Indicates if auto scaling is enabled for the Deployment's CPU core count.
isHealthy Boolean: True if all of the aggregate resources are working correctly.
isLatestVersion Boolean: Indicates if the resource is the the latest available version.
isLockOverride Boolean
isPublic Boolean: True if this object is publicly available.
isStorageUtilizationLimitExceeded Boolean: 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 String: The Oracle license model that applies to a Deployment.
lifecycleDetails 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.
lifecycleSubState String: Possible GGS lifecycle sub-states.
loadBalancerId String: The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
loadBalancerSubnetId 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 List<GetDeploymentLock>: Locks associated with this resource.
maintenanceConfigurations List<GetDeploymentMaintenanceConfiguration>: Attributes for configuring automatic deployment maintenance.
maintenanceWindows List<GetDeploymentMaintenanceWindow>: Defines the maintenance window, when automatic actions can be performed.
nextMaintenanceActionType String: Type of the next maintenance.
nextMaintenanceDescription String: Description of the next maintenance.
nsgIds List<String>: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggDatas List<GetDeploymentOggData>: Deployment Data for an OggDeployment
placements List<GetDeploymentPlacement>: An array of local peers of deployment
privateIpAddress 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 String: The public IP address representing the access point for the Deployment.
sourceDeploymentId String: The OCID of the deployment being referenced.
state String: Possible lifecycle states.
storageUtilizationInBytes String: The amount of storage being utilized (in bytes)
subnetId 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.
systemTags Map<String,String>: 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 String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeLastBackupScheduled String: The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled String: The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
timeOfNextMaintenance String: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil String: 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 String: The time of the last role change. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired String: 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.

availabilityDomain string: The availability domain of a placement.
backupSchedules GetDeploymentBackupSchedule[]: Defines the schedule of the deployment backup.
category string: 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'.
compartmentId string: The OCID of the compartment being referenced.
cpuCoreCount number: The Minimum number of OCPUs to be made available for this Deployment.
definedTags {[key: string]: string}: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId string: The OCID of the backup being referenced.
deploymentDiagnosticDatas GetDeploymentDeploymentDiagnosticData[]: Information regarding the deployment diagnostic collection
deploymentId string
deploymentRole string: The type of the deployment role.
deploymentType string: 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'.
deploymentUrl string: The URL of a resource.
description string: Metadata about this specific object.
displayName string: An object's Display Name.
environmentType string: Specifies whether the deployment is used in a production or development/testing environment.
faultDomain string: The fault domain of a placement.
fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags {[key: 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 string: The OCID of the deployment being referenced.
ingressIps GetDeploymentIngressIp[]: 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 boolean: Indicates if auto scaling is enabled for the Deployment's CPU core count.
isHealthy boolean: True if all of the aggregate resources are working correctly.
isLatestVersion boolean: Indicates if the resource is the the latest available version.
isLockOverride boolean
isPublic boolean: True if this object is publicly available.
isStorageUtilizationLimitExceeded boolean: 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 string: The Oracle license model that applies to a Deployment.
lifecycleDetails 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.
lifecycleSubState string: Possible GGS lifecycle sub-states.
loadBalancerId string: The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
loadBalancerSubnetId 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 GetDeploymentLock[]: Locks associated with this resource.
maintenanceConfigurations GetDeploymentMaintenanceConfiguration[]: Attributes for configuring automatic deployment maintenance.
maintenanceWindows GetDeploymentMaintenanceWindow[]: Defines the maintenance window, when automatic actions can be performed.
nextMaintenanceActionType string: Type of the next maintenance.
nextMaintenanceDescription string: Description of the next maintenance.
nsgIds string[]: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggDatas GetDeploymentOggData[]: Deployment Data for an OggDeployment
placements GetDeploymentPlacement[]: An array of local peers of deployment
privateIpAddress 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 string: The public IP address representing the access point for the Deployment.
sourceDeploymentId string: The OCID of the deployment being referenced.
state string: Possible lifecycle states.
storageUtilizationInBytes string: The amount of storage being utilized (in bytes)
subnetId 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.
systemTags {[key: string]: string}: 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 string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeLastBackupScheduled string: The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled string: The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
timeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil string: 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 string: The time of the last role change. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired string: 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.

availability_domain str: The availability domain of a placement.
backup_schedules Sequence[goldengate.GetDeploymentBackupSchedule]: Defines the schedule of the deployment backup.
category str: 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'.
compartment_id str: The OCID of the compartment being referenced.
cpu_core_count int: The Minimum number of OCPUs to be made available for this Deployment.
defined_tags Mapping[str, str]: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_backup_id str: The OCID of the backup being referenced.
deployment_diagnostic_datas Sequence[goldengate.GetDeploymentDeploymentDiagnosticData]: Information regarding the deployment diagnostic collection
deployment_id str
deployment_role str: The type of the deployment role.
deployment_type str: 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'.
deployment_url str: The URL of a resource.
description str: Metadata about this specific object.
display_name str: An object's Display Name.
environment_type str: Specifies whether the deployment is used in a production or development/testing environment.
fault_domain str: The fault domain of a placement.
fqdn str: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeform_tags Mapping[str, str]: 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 str: The OCID of the deployment being referenced.
ingress_ips Sequence[goldengate.GetDeploymentIngressIp]: 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.
is_auto_scaling_enabled bool: Indicates if auto scaling is enabled for the Deployment's CPU core count.
is_healthy bool: True if all of the aggregate resources are working correctly.
is_latest_version bool: Indicates if the resource is the the latest available version.
is_lock_override bool
is_public bool: True if this object is publicly available.
is_storage_utilization_limit_exceeded 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.
license_model str: The Oracle license model that applies to a Deployment.
lifecycle_details str: 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.
lifecycle_sub_state str: Possible GGS lifecycle sub-states.
load_balancer_id str: The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
load_balancer_subnet_id str: 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 Sequence[goldengate.GetDeploymentLock]: Locks associated with this resource.
maintenance_configurations Sequence[goldengate.GetDeploymentMaintenanceConfiguration]: Attributes for configuring automatic deployment maintenance.
maintenance_windows Sequence[goldengate.GetDeploymentMaintenanceWindow]: Defines the maintenance window, when automatic actions can be performed.
next_maintenance_action_type str: Type of the next maintenance.
next_maintenance_description str: Description of the next maintenance.
nsg_ids Sequence[str]: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
ogg_datas Sequence[goldengate.GetDeploymentOggData]: Deployment Data for an OggDeployment
placements Sequence[goldengate.GetDeploymentPlacement]: An array of local peers of deployment
private_ip_address str: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
public_ip_address str: The public IP address representing the access point for the Deployment.
source_deployment_id str: The OCID of the deployment being referenced.
state str: Possible lifecycle states.
storage_utilization_in_bytes str: The amount of storage being utilized (in bytes)
subnet_id str: 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.
system_tags Mapping[str, str]: 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}}
time_created str: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_last_backup_scheduled str: The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
time_next_backup_scheduled str: The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
time_of_next_maintenance str: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_ogg_version_supported_until str: 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.
time_role_changed str: The time of the last role change. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_updated str: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_upgrade_required str: 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.

availabilityDomain String: The availability domain of a placement.
backupSchedules List<Property Map>: Defines the schedule of the deployment backup.
category String: 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'.
compartmentId String: The OCID of the compartment being referenced.
cpuCoreCount Number: The Minimum number of OCPUs to be made available for this Deployment.
definedTags Map<String>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String: The OCID of the backup being referenced.
deploymentDiagnosticDatas List<Property Map>: Information regarding the deployment diagnostic collection
deploymentId String
deploymentRole String: The type of the deployment role.
deploymentType String: 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'.
deploymentUrl String: The URL of a resource.
description String: Metadata about this specific object.
displayName String: An object's Display Name.
environmentType String: Specifies whether the deployment is used in a production or development/testing environment.
faultDomain String: The fault domain of a placement.
fqdn String: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<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 String: The OCID of the deployment being referenced.
ingressIps List<Property Map>: 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 Boolean: Indicates if auto scaling is enabled for the Deployment's CPU core count.
isHealthy Boolean: True if all of the aggregate resources are working correctly.
isLatestVersion Boolean: Indicates if the resource is the the latest available version.
isLockOverride Boolean
isPublic Boolean: True if this object is publicly available.
isStorageUtilizationLimitExceeded Boolean: 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 String: The Oracle license model that applies to a Deployment.
lifecycleDetails 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.
lifecycleSubState String: Possible GGS lifecycle sub-states.
loadBalancerId String: The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
loadBalancerSubnetId 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 List<Property Map>: Locks associated with this resource.
maintenanceConfigurations List<Property Map>: Attributes for configuring automatic deployment maintenance.
maintenanceWindows List<Property Map>: Defines the maintenance window, when automatic actions can be performed.
nextMaintenanceActionType String: Type of the next maintenance.
nextMaintenanceDescription String: Description of the next maintenance.
nsgIds List<String>: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggDatas List<Property Map>: Deployment Data for an OggDeployment
placements List<Property Map>: An array of local peers of deployment
privateIpAddress 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 String: The public IP address representing the access point for the Deployment.
sourceDeploymentId String: The OCID of the deployment being referenced.
state String: Possible lifecycle states.
storageUtilizationInBytes String: The amount of storage being utilized (in bytes)
subnetId 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.
systemTags Map<String>: 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 String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeLastBackupScheduled String: The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled String: The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
timeOfNextMaintenance String: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil String: 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 String: The time of the last role change. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired String: 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.

Supporting Types

GetDeploymentBackupSchedule

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
CompartmentId string: The OCID of the compartment being referenced.
FrequencyBackupScheduled string: The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
IsMetadataOnly bool: Parameter to allow users to create backup without trails
Namespace string: Name of namespace that serves as a container for all of your buckets
TimeBackupScheduled string: The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
CompartmentId string: The OCID of the compartment being referenced.
FrequencyBackupScheduled string: The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
IsMetadataOnly bool: Parameter to allow users to create backup without trails
Namespace string: Name of namespace that serves as a container for all of your buckets
TimeBackupScheduled string: The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
compartmentId String: The OCID of the compartment being referenced.
frequencyBackupScheduled String: The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
isMetadataOnly Boolean: Parameter to allow users to create backup without trails
namespace String: Name of namespace that serves as a container for all of your buckets
timeBackupScheduled String: The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

bucket string: Name of the bucket where the object is to be uploaded in the object storage
compartmentId string: The OCID of the compartment being referenced.
frequencyBackupScheduled string: The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
isMetadataOnly boolean: Parameter to allow users to create backup without trails
namespace string: Name of namespace that serves as a container for all of your buckets
timeBackupScheduled string: The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

bucket str: Name of the bucket where the object is to be uploaded in the object storage
compartment_id str: The OCID of the compartment being referenced.
frequency_backup_scheduled str: The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
is_metadata_only bool: Parameter to allow users to create backup without trails
namespace str: Name of namespace that serves as a container for all of your buckets
time_backup_scheduled str: The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
compartmentId String: The OCID of the compartment being referenced.
frequencyBackupScheduled String: The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
isMetadataOnly Boolean: Parameter to allow users to create backup without trails
namespace String: Name of namespace that serves as a container for all of your buckets
timeBackupScheduled String: The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

GetDeploymentDeploymentDiagnosticData

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
DiagnosticState string: The state of the deployment diagnostic collection.
Namespace string: Name of namespace that serves as a container for all of your buckets
Object string: Name of the diagnostic collected and uploaded to object storage
TimeDiagnosticEnd string: The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeDiagnosticStart string: The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
DiagnosticState string: The state of the deployment diagnostic collection.
Namespace string: Name of namespace that serves as a container for all of your buckets
Object string: Name of the diagnostic collected and uploaded to object storage
TimeDiagnosticEnd string: The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeDiagnosticStart string: The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState String: The state of the deployment diagnostic collection.
namespace String: Name of namespace that serves as a container for all of your buckets
object String: Name of the diagnostic collected and uploaded to object storage
timeDiagnosticEnd String: The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeDiagnosticStart String: The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

bucket string: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState string: The state of the deployment diagnostic collection.
namespace string: Name of namespace that serves as a container for all of your buckets
object string: Name of the diagnostic collected and uploaded to object storage
timeDiagnosticEnd string: The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeDiagnosticStart string: The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

bucket str: Name of the bucket where the object is to be uploaded in the object storage
diagnostic_state str: The state of the deployment diagnostic collection.
namespace str: Name of namespace that serves as a container for all of your buckets
object str: Name of the diagnostic collected and uploaded to object storage
time_diagnostic_end str: The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_diagnostic_start str: The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState String: The state of the deployment diagnostic collection.
namespace String: Name of namespace that serves as a container for all of your buckets
object String: Name of the diagnostic collected and uploaded to object storage
timeDiagnosticEnd String: The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeDiagnosticStart String: The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

GetDeploymentIngressIp

IngressIp string: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

IngressIp string: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingressIp String: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingressIp string: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingress_ip str: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingressIp String: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

GetDeploymentLock

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
Type string: Type of the lock.

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
Type string: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type String: Type of the lock.

message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type str: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type String: Type of the lock.

GetDeploymentMaintenanceConfiguration

BundleReleaseUpgradePeriodInDays int: 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.
InterimReleaseUpgradePeriodInDays int: Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
IsInterimReleaseAutoUpgradeEnabled bool: By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
MajorReleaseUpgradePeriodInDays int: 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.
SecurityPatchUpgradePeriodInDays int: 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.

BundleReleaseUpgradePeriodInDays int: 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.
InterimReleaseUpgradePeriodInDays int: Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
IsInterimReleaseAutoUpgradeEnabled bool: By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
MajorReleaseUpgradePeriodInDays int: 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.
SecurityPatchUpgradePeriodInDays int: 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.

bundleReleaseUpgradePeriodInDays Integer: 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.
interimReleaseUpgradePeriodInDays Integer: Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
isInterimReleaseAutoUpgradeEnabled Boolean: By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
majorReleaseUpgradePeriodInDays Integer: 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.
securityPatchUpgradePeriodInDays Integer: 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.

bundleReleaseUpgradePeriodInDays number: 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.
interimReleaseUpgradePeriodInDays number: Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
isInterimReleaseAutoUpgradeEnabled boolean: By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
majorReleaseUpgradePeriodInDays number: 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.
securityPatchUpgradePeriodInDays number: 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.

bundle_release_upgrade_period_in_days int: 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.
interim_release_upgrade_period_in_days int: Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
is_interim_release_auto_upgrade_enabled bool: By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
major_release_upgrade_period_in_days int: 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.
security_patch_upgrade_period_in_days int: 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.

bundleReleaseUpgradePeriodInDays Number: 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.
interimReleaseUpgradePeriodInDays Number: Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
isInterimReleaseAutoUpgradeEnabled Boolean: By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
majorReleaseUpgradePeriodInDays Number: 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.
securityPatchUpgradePeriodInDays Number: 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.

GetDeploymentMaintenanceWindow

Day string: Days of the week.
StartHour int: Start hour for maintenance period. Hour is in UTC.

Day string: Days of the week.
StartHour int: Start hour for maintenance period. Hour is in UTC.

day String: Days of the week.
startHour Integer: Start hour for maintenance period. Hour is in UTC.

day string: Days of the week.
startHour number: Start hour for maintenance period. Hour is in UTC.

day str: Days of the week.
start_hour int: Start hour for maintenance period. Hour is in UTC.

day String: Days of the week.
startHour Number: Start hour for maintenance period. Hour is in UTC.

GetDeploymentOggData

AdminPassword string
AdminUsername string: The GoldenGate deployment console username.
Certificate string: The base64 encoded content of the PEM file containing the SSL certificate.
CredentialStore string: The type of credential store for OGG.
DeploymentName string: 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.
GroupToRolesMappings List<GetDeploymentOggDataGroupToRolesMapping>: Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
IdentityDomainId string: The OCID of the Identity Domain when IAM credential store is used.
Key string
OggVersion string: Version of OGG
PasswordSecretId string: The OCID of the Secret where the deployment password is stored.

AdminPassword string
AdminUsername string: The GoldenGate deployment console username.
Certificate string: The base64 encoded content of the PEM file containing the SSL certificate.
CredentialStore string: The type of credential store for OGG.
DeploymentName string: 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.
GroupToRolesMappings []GetDeploymentOggDataGroupToRolesMapping: Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
IdentityDomainId string: The OCID of the Identity Domain when IAM credential store is used.
Key string
OggVersion string: Version of OGG
PasswordSecretId string: The OCID of the Secret where the deployment password is stored.

adminPassword String
adminUsername String: The GoldenGate deployment console username.
certificate String: The base64 encoded content of the PEM file containing the SSL certificate.
credentialStore String: The type of credential store for OGG.
deploymentName String: 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.
groupToRolesMappings List<GetDeploymentOggDataGroupToRolesMapping>: Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identityDomainId String: The OCID of the Identity Domain when IAM credential store is used.
key String
oggVersion String: Version of OGG
passwordSecretId String: The OCID of the Secret where the deployment password is stored.

adminPassword string
adminUsername string: The GoldenGate deployment console username.
certificate string: The base64 encoded content of the PEM file containing the SSL certificate.
credentialStore string: The type of credential store for OGG.
deploymentName string: 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.
groupToRolesMappings GetDeploymentOggDataGroupToRolesMapping[]: Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identityDomainId string: The OCID of the Identity Domain when IAM credential store is used.
key string
oggVersion string: Version of OGG
passwordSecretId string: The OCID of the Secret where the deployment password is stored.

admin_password str
admin_username str: The GoldenGate deployment console username.
certificate str: The base64 encoded content of the PEM file containing the SSL certificate.
credential_store str: The type of credential store for OGG.
deployment_name str: 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.
group_to_roles_mappings Sequence[goldengate.GetDeploymentOggDataGroupToRolesMapping]: Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identity_domain_id str: The OCID of the Identity Domain when IAM credential store is used.
key str
ogg_version str: Version of OGG
password_secret_id str: The OCID of the Secret where the deployment password is stored.

adminPassword String
adminUsername String: The GoldenGate deployment console username.
certificate String: The base64 encoded content of the PEM file containing the SSL certificate.
credentialStore String: The type of credential store for OGG.
deploymentName String: 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.
groupToRolesMappings List<Property Map>: Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identityDomainId String: The OCID of the Identity Domain when IAM credential store is used.
key String
oggVersion String: Version of OGG
passwordSecretId String: The OCID of the Secret where the deployment password is stored.

GetDeploymentOggDataGroupToRolesMapping

AdministratorGroupId string: The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
OperatorGroupId string: The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
SecurityGroupId string: The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
UserGroupId string: The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information

AdministratorGroupId string: The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
OperatorGroupId string: The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
SecurityGroupId string: The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
UserGroupId string: The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information

administratorGroupId String: The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operatorGroupId String: The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
securityGroupId String: The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
userGroupId String: The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information

administratorGroupId string: The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operatorGroupId string: The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
securityGroupId string: The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
userGroupId string: The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information

administrator_group_id str: The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operator_group_id str: The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
security_group_id str: The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
user_group_id str: The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information

administratorGroupId String: The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operatorGroupId String: The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
securityGroupId String: The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
userGroupId String: The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information

GetDeploymentPlacement

AvailabilityDomain string: The availability domain of a placement.
FaultDomain string: The fault domain of a placement.

AvailabilityDomain string: The availability domain of a placement.
FaultDomain string: The fault domain of a placement.

availabilityDomain String: The availability domain of a placement.
faultDomain String: The fault domain of a placement.

availabilityDomain string: The availability domain of a placement.
faultDomain string: The fault domain of a placement.

availability_domain str: The availability domain of a placement.
fault_domain str: The fault domain of a placement.

availabilityDomain String: The availability domain of a placement.
faultDomain String: The fault domain of a placement.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

pulumi/pulumi-oci

oci.GoldenGate.getDeployment

On this page

On this page

Example Usage

Using getDeployment

getDeployment Result

Supporting Types

GetDeploymentBackupSchedule

GetDeploymentDeploymentDiagnosticData

GetDeploymentIngressIp

GetDeploymentLock

GetDeploymentMaintenanceConfiguration

GetDeploymentMaintenanceWindow

GetDeploymentOggData

GetDeploymentOggDataGroupToRolesMapping

GetDeploymentPlacement

Package Details

On this page

On this page