oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.GoldenGate.getDeployments

This data source provides the list of Deployments in Oracle Cloud Infrastructure Golden Gate service.

Lists the Deployments in a compartment.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDeployments = Oci.GoldenGate.GetDeployments.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        AssignableConnectionId = oci_golden_gate_connection.Test_connection.Id,
        AssignedConnectionId = oci_golden_gate_connection.Test_connection.Id,
        DisplayName = @var.Deployment_display_name,
        Fqdn = @var.Deployment_fqdn,
        LifecycleSubState = @var.Deployment_lifecycle_sub_state,
        State = @var.Deployment_state,
        SupportedConnectionType = @var.Deployment_supported_connection_type,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GoldenGate.GetDeployments(ctx, &goldengate.GetDeploymentsArgs{
			CompartmentId:           _var.Compartment_id,
			AssignableConnectionId:  pulumi.StringRef(oci_golden_gate_connection.Test_connection.Id),
			AssignedConnectionId:    pulumi.StringRef(oci_golden_gate_connection.Test_connection.Id),
			DisplayName:             pulumi.StringRef(_var.Deployment_display_name),
			Fqdn:                    pulumi.StringRef(_var.Deployment_fqdn),
			LifecycleSubState:       pulumi.StringRef(_var.Deployment_lifecycle_sub_state),
			State:                   pulumi.StringRef(_var.Deployment_state),
			SupportedConnectionType: pulumi.StringRef(_var.Deployment_supported_connection_type),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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.GetDeploymentsArgs;
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 testDeployments = GoldenGateFunctions.getDeployments(GetDeploymentsArgs.builder()
            .compartmentId(var_.compartment_id())
            .assignableConnectionId(oci_golden_gate_connection.test_connection().id())
            .assignedConnectionId(oci_golden_gate_connection.test_connection().id())
            .displayName(var_.deployment_display_name())
            .fqdn(var_.deployment_fqdn())
            .lifecycleSubState(var_.deployment_lifecycle_sub_state())
            .state(var_.deployment_state())
            .supportedConnectionType(var_.deployment_supported_connection_type())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_deployments = oci.GoldenGate.get_deployments(compartment_id=var["compartment_id"],
    assignable_connection_id=oci_golden_gate_connection["test_connection"]["id"],
    assigned_connection_id=oci_golden_gate_connection["test_connection"]["id"],
    display_name=var["deployment_display_name"],
    fqdn=var["deployment_fqdn"],
    lifecycle_sub_state=var["deployment_lifecycle_sub_state"],
    state=var["deployment_state"],
    supported_connection_type=var["deployment_supported_connection_type"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDeployments = oci.GoldenGate.getDeployments({
    compartmentId: _var.compartment_id,
    assignableConnectionId: oci_golden_gate_connection.test_connection.id,
    assignedConnectionId: oci_golden_gate_connection.test_connection.id,
    displayName: _var.deployment_display_name,
    fqdn: _var.deployment_fqdn,
    lifecycleSubState: _var.deployment_lifecycle_sub_state,
    state: _var.deployment_state,
    supportedConnectionType: _var.deployment_supported_connection_type,
});
variables:
  testDeployments:
    fn::invoke:
      Function: oci:GoldenGate:getDeployments
      Arguments:
        compartmentId: ${var.compartment_id}
        assignableConnectionId: ${oci_golden_gate_connection.test_connection.id}
        assignedConnectionId: ${oci_golden_gate_connection.test_connection.id}
        displayName: ${var.deployment_display_name}
        fqdn: ${var.deployment_fqdn}
        lifecycleSubState: ${var.deployment_lifecycle_sub_state}
        state: ${var.deployment_state}
        supportedConnectionType: ${var.deployment_supported_connection_type}

Using getDeployments

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.

function getDeployments(args: GetDeploymentsArgs, opts?: InvokeOptions): Promise<GetDeploymentsResult>
function getDeploymentsOutput(args: GetDeploymentsOutputArgs, opts?: InvokeOptions): Output<GetDeploymentsResult>
def get_deployments(assignable_connection_id: Optional[str] = None,
                    assigned_connection_id: Optional[str] = None,
                    compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[_goldengate.GetDeploymentsFilter]] = None,
                    fqdn: Optional[str] = None,
                    lifecycle_sub_state: Optional[str] = None,
                    state: Optional[str] = None,
                    supported_connection_type: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDeploymentsResult
def get_deployments_output(assignable_connection_id: Optional[pulumi.Input[str]] = None,
                    assigned_connection_id: Optional[pulumi.Input[str]] = None,
                    compartment_id: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_goldengate.GetDeploymentsFilterArgs]]]] = None,
                    fqdn: Optional[pulumi.Input[str]] = None,
                    lifecycle_sub_state: Optional[pulumi.Input[str]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    supported_connection_type: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentsResult]
func GetDeployments(ctx *Context, args *GetDeploymentsArgs, opts ...InvokeOption) (*GetDeploymentsResult, error)
func GetDeploymentsOutput(ctx *Context, args *GetDeploymentsOutputArgs, opts ...InvokeOption) GetDeploymentsResultOutput

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

public static class GetDeployments 
{
    public static Task<GetDeploymentsResult> InvokeAsync(GetDeploymentsArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentsResult> Invoke(GetDeploymentsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeploymentsResult> getDeployments(GetDeploymentsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:GoldenGate/getDeployments:getDeployments
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment in which to list resources.

AssignableConnectionId string

Filters for compatible deployments which can be, but currently not assigned to the connection specified by its id.

AssignedConnectionId string

The OCID of the connection which for the deployment must be assigned.

DisplayName string

A filter to return only the resources that match the entire 'displayName' given.

Filters List<GetDeploymentsFilter>
Fqdn string

A filter to return only the resources that match the 'fqdn' given.

LifecycleSubState string

A filter to return only the resources that match the 'lifecycleSubState' given.

State string

A filter to return only the resources that match the 'lifecycleState' given.

SupportedConnectionType string

The connection type which the deployment must support.

CompartmentId string

The OCID of the compartment in which to list resources.

AssignableConnectionId string

Filters for compatible deployments which can be, but currently not assigned to the connection specified by its id.

AssignedConnectionId string

The OCID of the connection which for the deployment must be assigned.

DisplayName string

A filter to return only the resources that match the entire 'displayName' given.

Filters []GetDeploymentsFilter
Fqdn string

A filter to return only the resources that match the 'fqdn' given.

LifecycleSubState string

A filter to return only the resources that match the 'lifecycleSubState' given.

State string

A filter to return only the resources that match the 'lifecycleState' given.

SupportedConnectionType string

The connection type which the deployment must support.

compartmentId String

The OCID of the compartment in which to list resources.

assignableConnectionId String

Filters for compatible deployments which can be, but currently not assigned to the connection specified by its id.

assignedConnectionId String

The OCID of the connection which for the deployment must be assigned.

displayName String

A filter to return only the resources that match the entire 'displayName' given.

filters List<GetDeploymentsFilter>
fqdn String

A filter to return only the resources that match the 'fqdn' given.

lifecycleSubState String

A filter to return only the resources that match the 'lifecycleSubState' given.

state String

A filter to return only the resources that match the 'lifecycleState' given.

supportedConnectionType String

The connection type which the deployment must support.

compartmentId string

The OCID of the compartment in which to list resources.

assignableConnectionId string

Filters for compatible deployments which can be, but currently not assigned to the connection specified by its id.

assignedConnectionId string

The OCID of the connection which for the deployment must be assigned.

displayName string

A filter to return only the resources that match the entire 'displayName' given.

filters GetDeploymentsFilter[]
fqdn string

A filter to return only the resources that match the 'fqdn' given.

lifecycleSubState string

A filter to return only the resources that match the 'lifecycleSubState' given.

state string

A filter to return only the resources that match the 'lifecycleState' given.

supportedConnectionType string

The connection type which the deployment must support.

compartment_id str

The OCID of the compartment in which to list resources.

assignable_connection_id str

Filters for compatible deployments which can be, but currently not assigned to the connection specified by its id.

assigned_connection_id str

The OCID of the connection which for the deployment must be assigned.

display_name str

A filter to return only the resources that match the entire 'displayName' given.

filters GetDeploymentsFilter]
fqdn str

A filter to return only the resources that match the 'fqdn' given.

lifecycle_sub_state str

A filter to return only the resources that match the 'lifecycleSubState' given.

state str

A filter to return only the resources that match the 'lifecycleState' given.

supported_connection_type str

The connection type which the deployment must support.

compartmentId String

The OCID of the compartment in which to list resources.

assignableConnectionId String

Filters for compatible deployments which can be, but currently not assigned to the connection specified by its id.

assignedConnectionId String

The OCID of the connection which for the deployment must be assigned.

displayName String

A filter to return only the resources that match the entire 'displayName' given.

filters List<Property Map>
fqdn String

A filter to return only the resources that match the 'fqdn' given.

lifecycleSubState String

A filter to return only the resources that match the 'lifecycleSubState' given.

state String

A filter to return only the resources that match the 'lifecycleState' given.

supportedConnectionType String

The connection type which the deployment must support.

getDeployments Result

The following output properties are available:

CompartmentId string

The OCID of the compartment being referenced.

DeploymentCollections List<GetDeploymentsDeploymentCollection>

The list of deployment_collection.

Id string

The provider-assigned unique ID for this managed resource.

AssignableConnectionId string
AssignedConnectionId string
DisplayName string

An object's Display Name.

Filters List<GetDeploymentsFilter>
Fqdn string

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

LifecycleSubState string

Possible GGS lifecycle sub-states.

State string

Possible lifecycle states.

SupportedConnectionType string
CompartmentId string

The OCID of the compartment being referenced.

DeploymentCollections []GetDeploymentsDeploymentCollection

The list of deployment_collection.

Id string

The provider-assigned unique ID for this managed resource.

AssignableConnectionId string
AssignedConnectionId string
DisplayName string

An object's Display Name.

Filters []GetDeploymentsFilter
Fqdn string

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

LifecycleSubState string

Possible GGS lifecycle sub-states.

State string

Possible lifecycle states.

SupportedConnectionType string
compartmentId String

The OCID of the compartment being referenced.

deploymentCollections List<GetDeploymentsDeploymentCollection>

The list of deployment_collection.

id String

The provider-assigned unique ID for this managed resource.

assignableConnectionId String
assignedConnectionId String
displayName String

An object's Display Name.

filters List<GetDeploymentsFilter>
fqdn String

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

lifecycleSubState String

Possible GGS lifecycle sub-states.

state String

Possible lifecycle states.

supportedConnectionType String
compartmentId string

The OCID of the compartment being referenced.

deploymentCollections GetDeploymentsDeploymentCollection[]

The list of deployment_collection.

id string

The provider-assigned unique ID for this managed resource.

assignableConnectionId string
assignedConnectionId string
displayName string

An object's Display Name.

filters GetDeploymentsFilter[]
fqdn string

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

lifecycleSubState string

Possible GGS lifecycle sub-states.

state string

Possible lifecycle states.

supportedConnectionType string
compartment_id str

The OCID of the compartment being referenced.

deployment_collections GetDeploymentsDeploymentCollection]

The list of deployment_collection.

id str

The provider-assigned unique ID for this managed resource.

assignable_connection_id str
assigned_connection_id str
display_name str

An object's Display Name.

filters GetDeploymentsFilter]
fqdn str

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

lifecycle_sub_state str

Possible GGS lifecycle sub-states.

state str

Possible lifecycle states.

supported_connection_type str
compartmentId String

The OCID of the compartment being referenced.

deploymentCollections List<Property Map>

The list of deployment_collection.

id String

The provider-assigned unique ID for this managed resource.

assignableConnectionId String
assignedConnectionId String
displayName String

An object's Display Name.

filters List<Property Map>
fqdn String

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

lifecycleSubState String

Possible GGS lifecycle sub-states.

state String

Possible lifecycle states.

supportedConnectionType String

Supporting Types

GetDeploymentsDeploymentCollection

GetDeploymentsDeploymentCollectionItem

CompartmentId string

The OCID of the compartment in which to list resources.

CpuCoreCount int

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

DefinedTags Dictionary<string, object>

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

Information regarding the deployment diagnostic collection

DeploymentType string

The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged in favor of the equivalent DATABASE_ORACLE value.

DeploymentUrl string

The URL of a resource.

Description string

Metadata about this specific object.

DisplayName string

A filter to return only the resources that match the entire 'displayName' given.

Fqdn string

A filter to return only the resources that match the 'fqdn' given.

FreeformTags Dictionary<string, object>

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.

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.

IsPublic bool

True if this object is publicly available.

IsStorageUtilizationLimitExceeded bool

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

A filter to return only the resources that match the 'lifecycleSubState' given.

MaintenanceWindows List<GetDeploymentsDeploymentCollectionItemMaintenanceWindow>

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

Deployment Data for an OggDeployment

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.

State string

A filter to return only the resources that match the 'lifecycleState' given.

StorageUtilizationInBytes string

The amount of storage being utilized (in bytes)

SubnetId string

The OCID of the subnet being referenced.

SystemTags Dictionary<string, object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated string

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

TimeOfNextMaintenance string

The time of next maintenance schedule. 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.

CompartmentId string

The OCID of the compartment in which to list resources.

CpuCoreCount int

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

DefinedTags map[string]interface{}

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 []GetDeploymentsDeploymentCollectionItemDeploymentDiagnosticData

Information regarding the deployment diagnostic collection

DeploymentType string

The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged in favor of the equivalent DATABASE_ORACLE value.

DeploymentUrl string

The URL of a resource.

Description string

Metadata about this specific object.

DisplayName string

A filter to return only the resources that match the entire 'displayName' given.

Fqdn string

A filter to return only the resources that match the 'fqdn' given.

FreeformTags map[string]interface{}

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.

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.

IsPublic bool

True if this object is publicly available.

IsStorageUtilizationLimitExceeded bool

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

A filter to return only the resources that match the 'lifecycleSubState' given.

MaintenanceWindows []GetDeploymentsDeploymentCollectionItemMaintenanceWindow

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 []GetDeploymentsDeploymentCollectionItemOggData

Deployment Data for an OggDeployment

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.

State string

A filter to return only the resources that match the 'lifecycleState' given.

StorageUtilizationInBytes string

The amount of storage being utilized (in bytes)

SubnetId string

The OCID of the subnet being referenced.

SystemTags map[string]interface{}

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.

TimeOfNextMaintenance string

The time of next maintenance schedule. 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.

compartmentId String

The OCID of the compartment in which to list resources.

cpuCoreCount Integer

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

definedTags Map<String,Object>

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

Information regarding the deployment diagnostic collection

deploymentType String

The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged in favor of the equivalent DATABASE_ORACLE value.

deploymentUrl String

The URL of a resource.

description String

Metadata about this specific object.

displayName String

A filter to return only the resources that match the entire 'displayName' given.

fqdn String

A filter to return only the resources that match the 'fqdn' given.

freeformTags Map<String,Object>

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.

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.

isPublic Boolean

True if this object is publicly available.

isStorageUtilizationLimitExceeded Boolean

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

A filter to return only the resources that match the 'lifecycleSubState' given.

maintenanceWindows List<GetDeploymentsDeploymentCollectionItemMaintenanceWindow>

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

Deployment Data for an OggDeployment

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.

state String

A filter to return only the resources that match the 'lifecycleState' given.

storageUtilizationInBytes String

The amount of storage being utilized (in bytes)

subnetId String

The OCID of the subnet being referenced.

systemTags Map<String,Object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated String

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

timeOfNextMaintenance String

The time of next maintenance schedule. 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.

compartmentId string

The OCID of the compartment in which to list resources.

cpuCoreCount number

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

definedTags {[key: string]: any}

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 GetDeploymentsDeploymentCollectionItemDeploymentDiagnosticData[]

Information regarding the deployment diagnostic collection

deploymentType string

The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged in favor of the equivalent DATABASE_ORACLE value.

deploymentUrl string

The URL of a resource.

description string

Metadata about this specific object.

displayName string

A filter to return only the resources that match the entire 'displayName' given.

fqdn string

A filter to return only the resources that match the 'fqdn' given.

freeformTags {[key: string]: any}

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.

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.

isPublic boolean

True if this object is publicly available.

isStorageUtilizationLimitExceeded boolean

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

A filter to return only the resources that match the 'lifecycleSubState' given.

maintenanceWindows GetDeploymentsDeploymentCollectionItemMaintenanceWindow[]

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 GetDeploymentsDeploymentCollectionItemOggData[]

Deployment Data for an OggDeployment

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.

state string

A filter to return only the resources that match the 'lifecycleState' given.

storageUtilizationInBytes string

The amount of storage being utilized (in bytes)

subnetId string

The OCID of the subnet being referenced.

systemTags {[key: string]: any}

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.

timeOfNextMaintenance string

The time of next maintenance schedule. 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.

compartment_id str

The OCID of the compartment in which to list resources.

cpu_core_count int

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

defined_tags Mapping[str, Any]

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 GetDeploymentsDeploymentCollectionItemDeploymentDiagnosticData]

Information regarding the deployment diagnostic collection

deployment_type str

The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged in favor of the equivalent DATABASE_ORACLE value.

deployment_url str

The URL of a resource.

description str

Metadata about this specific object.

display_name str

A filter to return only the resources that match the entire 'displayName' given.

fqdn str

A filter to return only the resources that match the 'fqdn' given.

freeform_tags Mapping[str, Any]

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.

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_public bool

True if this object is publicly available.

is_storage_utilization_limit_exceeded bool

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

A filter to return only the resources that match the 'lifecycleSubState' given.

maintenance_windows GetDeploymentsDeploymentCollectionItemMaintenanceWindow]

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 GetDeploymentsDeploymentCollectionItemOggData]

Deployment Data for an OggDeployment

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.

state str

A filter to return only the resources that match the 'lifecycleState' given.

storage_utilization_in_bytes str

The amount of storage being utilized (in bytes)

subnet_id str

The OCID of the subnet being referenced.

system_tags Mapping[str, Any]

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

compartmentId String

The OCID of the compartment in which to list resources.

cpuCoreCount Number

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

definedTags Map<Any>

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

deploymentType String

The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged in favor of the equivalent DATABASE_ORACLE value.

deploymentUrl String

The URL of a resource.

description String

Metadata about this specific object.

displayName String

A filter to return only the resources that match the entire 'displayName' given.

fqdn String

A filter to return only the resources that match the 'fqdn' given.

freeformTags Map<Any>

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.

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.

isPublic Boolean

True if this object is publicly available.

isStorageUtilizationLimitExceeded Boolean

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

A filter to return only the resources that match the 'lifecycleSubState' given.

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

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.

state String

A filter to return only the resources that match the 'lifecycleState' given.

storageUtilizationInBytes String

The amount of storage being utilized (in bytes)

subnetId String

The OCID of the subnet being referenced.

systemTags Map<Any>

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.

timeOfNextMaintenance String

The time of next maintenance schedule. 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.

GetDeploymentsDeploymentCollectionItemDeploymentDiagnosticData

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.

GetDeploymentsDeploymentCollectionItemMaintenanceWindow

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.

GetDeploymentsDeploymentCollectionItemOggData

AdminPassword string
AdminUsername string

The GoldenGate deployment console username.

Certificate string

A PEM-encoded SSL certificate.

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.

Key string
OggVersion string

Version of OGG

AdminPassword string
AdminUsername string

The GoldenGate deployment console username.

Certificate string

A PEM-encoded SSL certificate.

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.

Key string
OggVersion string

Version of OGG

adminPassword String
adminUsername String

The GoldenGate deployment console username.

certificate String

A PEM-encoded SSL certificate.

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.

key String
oggVersion String

Version of OGG

adminPassword string
adminUsername string

The GoldenGate deployment console username.

certificate string

A PEM-encoded SSL certificate.

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.

key string
oggVersion string

Version of OGG

admin_password str
admin_username str

The GoldenGate deployment console username.

certificate str

A PEM-encoded SSL certificate.

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.

key str
ogg_version str

Version of OGG

adminPassword String
adminUsername String

The GoldenGate deployment console username.

certificate String

A PEM-encoded SSL certificate.

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.

key String
oggVersion String

Version of OGG

GetDeploymentsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.