Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getDeployment

This data source provides details about a specific Deployment resource in Oracle Cloud Infrastructure Golden Gate service.

Retrieves a deployment.

Example Usage

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

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

});

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.GetDeployment(ctx, &goldengate.GetDeploymentArgs{
			DeploymentId: oci_golden_gate_deployment.Test_deployment.Id,
		}, 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.ApiGateway.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(oci_golden_gate_deployment.test_deployment().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

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

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

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

variables:
  testDeployment:
    Fn::Invoke:
      Function: oci:GoldenGate:getDeployment
      Arguments:
        deploymentId: ${oci_golden_gate_deployment.test_deployment.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.

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)
// Output-based functions aren't available in Java yet

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:

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, 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.
DeploymentId string
DeploymentType string: The deployment type.
DeploymentUrl string: The URL of a resource.
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
Fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
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: Possible GGS lifecycle sub-states.
NsgIds List<string>: An array of Network Security Group OCIDs used to define network access for a deployment.
OggDatas List<GetDeploymentOggData>: 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: Possible lifecycle states.
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.
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: 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 being referenced.
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.
DeploymentId string
DeploymentType string: The deployment type.
DeploymentUrl string: The URL of a resource.
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
Fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
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: Possible GGS lifecycle sub-states.
NsgIds []string: An array of Network Security Group OCIDs used to define network access for a deployment.
OggDatas []GetDeploymentOggData: 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: Possible lifecycle states.
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.
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: 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 being referenced.
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.
deploymentId String
deploymentType String: The deployment type.
deploymentUrl String: The URL of a resource.
description String: Metadata about this specific object.
displayName String: An object's Display Name.
fqdn String: A three-label Fully Qualified Domain Name (FQDN) for a resource.
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: Possible GGS lifecycle sub-states.
nsgIds List<String>: An array of Network Security Group OCIDs used to define network access for a deployment.
oggDatas List<GetDeploymentOggData>: 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: Possible lifecycle states.
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.
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: 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 being referenced.
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.
deploymentId string
deploymentType string: The deployment type.
deploymentUrl string: The URL of a resource.
description string: Metadata about this specific object.
displayName string: An object's Display Name.
fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
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: Possible GGS lifecycle sub-states.
nsgIds string[]: An array of Network Security Group OCIDs used to define network access for a deployment.
oggDatas GetDeploymentOggData[]: 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: Possible lifecycle states.
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.
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: 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 being referenced.
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_id str
deployment_type str: The deployment type.
deployment_url str: The URL of a resource.
description str: Metadata about this specific object.
display_name str: An object's Display Name.
fqdn str: A three-label Fully Qualified Domain Name (FQDN) for a resource.
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: Possible GGS lifecycle sub-states.
nsg_ids Sequence[str]: An array of Network Security Group OCIDs used to define network access for a deployment.
ogg_datas GetDeploymentOggData]: 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: Possible lifecycle states.
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_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: 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 being referenced.
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.
deploymentId String
deploymentType String: The deployment type.
deploymentUrl String: The URL of a resource.
description String: Metadata about this specific object.
displayName String: An object's Display Name.
fqdn String: A three-label Fully Qualified Domain Name (FQDN) for a resource.
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: Possible GGS lifecycle sub-states.
nsgIds List<String>: An array of Network Security Group OCIDs used to define network access for a deployment.
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: Possible lifecycle states.
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.
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: 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

GetDeploymentOggData

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

Package Details

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