Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GoldenGate
  5. getDeploymentPeers
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GoldenGate.getDeploymentPeers

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

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

    Lists the local and remote peers in a deployment.

    Example Usage

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

const testDeploymentPeers = oci.GoldenGate.getDeploymentPeers({
    deploymentId: testDeployment.id,
    displayName: deploymentPeerDisplayName,
    state: deploymentPeerState,
});

    import pulumi
import pulumi_oci as oci

test_deployment_peers = oci.GoldenGate.get_deployment_peers(deployment_id=test_deployment["id"],
    display_name=deployment_peer_display_name,
    state=deployment_peer_state)

    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.GetDeploymentPeers(ctx, &goldengate.GetDeploymentPeersArgs{
			DeploymentId: testDeployment.Id,
			DisplayName:  pulumi.StringRef(deploymentPeerDisplayName),
			State:        pulumi.StringRef(deploymentPeerState),
		}, 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 testDeploymentPeers = Oci.GoldenGate.GetDeploymentPeers.Invoke(new()
    {
        DeploymentId = testDeployment.Id,
        DisplayName = deploymentPeerDisplayName,
        State = deploymentPeerState,
    });

});

    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.GetDeploymentPeersArgs;
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 testDeploymentPeers = GoldenGateFunctions.getDeploymentPeers(GetDeploymentPeersArgs.builder()
            .deploymentId(testDeployment.id())
            .displayName(deploymentPeerDisplayName)
            .state(deploymentPeerState)
            .build());

    }
}

    variables:
  testDeploymentPeers:
    fn::invoke:
      function: oci:GoldenGate:getDeploymentPeers
      arguments:
        deploymentId: ${testDeployment.id}
        displayName: ${deploymentPeerDisplayName}
        state: ${deploymentPeerState}

    Using getDeploymentPeers

    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 getDeploymentPeers(args: GetDeploymentPeersArgs, opts?: InvokeOptions): Promise<GetDeploymentPeersResult>
function getDeploymentPeersOutput(args: GetDeploymentPeersOutputArgs, opts?: InvokeOptions): Output<GetDeploymentPeersResult>
    def get_deployment_peers(deployment_id: Optional[str] = None,
                         display_name: Optional[str] = None,
                         filters: Optional[Sequence[GetDeploymentPeersFilter]] = None,
                         state: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDeploymentPeersResult
def get_deployment_peers_output(deployment_id: Optional[pulumi.Input[str]] = None,
                         display_name: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDeploymentPeersFilterArgs]]]] = None,
                         state: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentPeersResult]
    func GetDeploymentPeers(ctx *Context, args *GetDeploymentPeersArgs, opts ...InvokeOption) (*GetDeploymentPeersResult, error)
func GetDeploymentPeersOutput(ctx *Context, args *GetDeploymentPeersOutputArgs, opts ...InvokeOption) GetDeploymentPeersResultOutput

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

    public static class GetDeploymentPeers 
{
    public static Task<GetDeploymentPeersResult> InvokeAsync(GetDeploymentPeersArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentPeersResult> Invoke(GetDeploymentPeersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDeploymentPeersResult> getDeploymentPeers(GetDeploymentPeersArgs args, InvokeOptions options)
public static Output<GetDeploymentPeersResult> getDeploymentPeers(GetDeploymentPeersArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DeploymentId string
    A unique Deployment identifier.
    DisplayName string
    A filter to return only the resources that match the entire 'displayName' given.
    Filters List<GetDeploymentPeersFilter>
    State string
    A filter to return only the resources that match the 'lifecycleState' given.
    DeploymentId string
    A unique Deployment identifier.
    DisplayName string
    A filter to return only the resources that match the entire 'displayName' given.
    Filters []GetDeploymentPeersFilter
    State string
    A filter to return only the resources that match the 'lifecycleState' given.
    deploymentId String
    A unique Deployment identifier.
    displayName String
    A filter to return only the resources that match the entire 'displayName' given.
    filters List<GetDeploymentPeersFilter>
    state String
    A filter to return only the resources that match the 'lifecycleState' given.
    deploymentId string
    A unique Deployment identifier.
    displayName string
    A filter to return only the resources that match the entire 'displayName' given.
    filters GetDeploymentPeersFilter[]
    state string
    A filter to return only the resources that match the 'lifecycleState' given.
    deployment_id str
    A unique Deployment identifier.
    display_name str
    A filter to return only the resources that match the entire 'displayName' given.
    filters Sequence[GetDeploymentPeersFilter]
    state str
    A filter to return only the resources that match the 'lifecycleState' given.
    deploymentId String
    A unique Deployment identifier.
    displayName String
    A filter to return only the resources that match the entire 'displayName' given.
    filters List<Property Map>
    state String
    A filter to return only the resources that match the 'lifecycleState' given.

    getDeploymentPeers Result

    The following output properties are available:

    DeploymentId string
    The OCID of the deployment being referenced.
    DeploymentPeerCollections List<GetDeploymentPeersDeploymentPeerCollection>
    The list of deployment_peer_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    DisplayName string
    An object's Display Name.
    Filters List<GetDeploymentPeersFilter>
    State string
    Possible lifecycle states for deployment peer.
    DeploymentId string
    The OCID of the deployment being referenced.
    DeploymentPeerCollections []GetDeploymentPeersDeploymentPeerCollection
    The list of deployment_peer_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    DisplayName string
    An object's Display Name.
    Filters []GetDeploymentPeersFilter
    State string
    Possible lifecycle states for deployment peer.
    deploymentId String
    The OCID of the deployment being referenced.
    deploymentPeerCollections List<GetDeploymentPeersDeploymentPeerCollection>
    The list of deployment_peer_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    displayName String
    An object's Display Name.
    filters List<GetDeploymentPeersFilter>
    state String
    Possible lifecycle states for deployment peer.
    deploymentId string
    The OCID of the deployment being referenced.
    deploymentPeerCollections GetDeploymentPeersDeploymentPeerCollection[]
    The list of deployment_peer_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    displayName string
    An object's Display Name.
    filters GetDeploymentPeersFilter[]
    state string
    Possible lifecycle states for deployment peer.
    deployment_id str
    The OCID of the deployment being referenced.
    deployment_peer_collections Sequence[GetDeploymentPeersDeploymentPeerCollection]
    The list of deployment_peer_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    display_name str
    An object's Display Name.
    filters Sequence[GetDeploymentPeersFilter]
    state str
    Possible lifecycle states for deployment peer.
    deploymentId String
    The OCID of the deployment being referenced.
    deploymentPeerCollections List<Property Map>
    The list of deployment_peer_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    displayName String
    An object's Display Name.
    filters List<Property Map>
    state String
    Possible lifecycle states for deployment peer.

    Supporting Types

    GetDeploymentPeersDeploymentPeerCollection

    items List<Property Map>
    An array of DeploymentPeers.

    GetDeploymentPeersDeploymentPeerCollectionItem

    AvailabilityDomain string
    The availability domain of a placement.
    DeploymentId string
    A unique Deployment identifier.
    DisplayName string
    A filter to return only the resources that match the entire 'displayName' given.
    FaultDomain string
    The fault domain of a placement.
    PeerRole string
    The type of the deployment role.
    PeerType string
    The type of the deployment peer.
    Region string
    The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
    State string
    A filter to return only the resources that match the 'lifecycleState' given.
    TimeCreated string
    The time the resource was created. 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.
    AvailabilityDomain string
    The availability domain of a placement.
    DeploymentId string
    A unique Deployment identifier.
    DisplayName string
    A filter to return only the resources that match the entire 'displayName' given.
    FaultDomain string
    The fault domain of a placement.
    PeerRole string
    The type of the deployment role.
    PeerType string
    The type of the deployment peer.
    Region string
    The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
    State string
    A filter to return only the resources that match the 'lifecycleState' given.
    TimeCreated string
    The time the resource was created. 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.
    availabilityDomain String
    The availability domain of a placement.
    deploymentId String
    A unique Deployment identifier.
    displayName String
    A filter to return only the resources that match the entire 'displayName' given.
    faultDomain String
    The fault domain of a placement.
    peerRole String
    The type of the deployment role.
    peerType String
    The type of the deployment peer.
    region String
    The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
    state String
    A filter to return only the resources that match the 'lifecycleState' given.
    timeCreated String
    The time the resource was created. 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.
    availabilityDomain string
    The availability domain of a placement.
    deploymentId string
    A unique Deployment identifier.
    displayName string
    A filter to return only the resources that match the entire 'displayName' given.
    faultDomain string
    The fault domain of a placement.
    peerRole string
    The type of the deployment role.
    peerType string
    The type of the deployment peer.
    region string
    The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
    state string
    A filter to return only the resources that match the 'lifecycleState' given.
    timeCreated string
    The time the resource was created. 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.
    availability_domain str
    The availability domain of a placement.
    deployment_id str
    A unique Deployment identifier.
    display_name str
    A filter to return only the resources that match the entire 'displayName' given.
    fault_domain str
    The fault domain of a placement.
    peer_role str
    The type of the deployment role.
    peer_type str
    The type of the deployment peer.
    region str
    The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
    state str
    A filter to return only the resources that match the 'lifecycleState' given.
    time_created str
    The time the resource was created. 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.
    availabilityDomain String
    The availability domain of a placement.
    deploymentId String
    A unique Deployment identifier.
    displayName String
    A filter to return only the resources that match the entire 'displayName' given.
    faultDomain String
    The fault domain of a placement.
    peerRole String
    The type of the deployment role.
    peerType String
    The type of the deployment peer.
    region String
    The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
    state String
    A filter to return only the resources that match the 'lifecycleState' given.
    timeCreated String
    The time the resource was created. 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.

    GetDeploymentPeersFilter

    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.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci