1. Packages
  2. Scm Provider
  3. API Docs
  4. getServiceConnection
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

scm.getServiceConnection

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const example = scm.getServiceConnection({
        id: "1234-56-789",
        folder: "Service Connections",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_service_connection(id="1234-56-789",
        folder="Service Connections")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-scm/sdk/go/scm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scm.LookupServiceConnection(ctx, &scm.LookupServiceConnectionArgs{
    			Id:     "1234-56-789",
    			Folder: pulumi.StringRef("Service Connections"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Scm.GetServiceConnection.Invoke(new()
        {
            Id = "1234-56-789",
            Folder = "Service Connections",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetServiceConnectionArgs;
    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 example = ScmFunctions.getServiceConnection(GetServiceConnectionArgs.builder()
                .id("1234-56-789")
                .folder("Service Connections")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getServiceConnection
          Arguments:
            id: 1234-56-789
            folder: Service Connections
    

    Using getServiceConnection

    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 getServiceConnection(args: GetServiceConnectionArgs, opts?: InvokeOptions): Promise<GetServiceConnectionResult>
    function getServiceConnectionOutput(args: GetServiceConnectionOutputArgs, opts?: InvokeOptions): Output<GetServiceConnectionResult>
    def get_service_connection(folder: Optional[str] = None,
                               id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetServiceConnectionResult
    def get_service_connection_output(folder: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetServiceConnectionResult]
    func LookupServiceConnection(ctx *Context, args *LookupServiceConnectionArgs, opts ...InvokeOption) (*LookupServiceConnectionResult, error)
    func LookupServiceConnectionOutput(ctx *Context, args *LookupServiceConnectionOutputArgs, opts ...InvokeOption) LookupServiceConnectionResultOutput

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

    public static class GetServiceConnection 
    {
        public static Task<GetServiceConnectionResult> InvokeAsync(GetServiceConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetServiceConnectionResult> Invoke(GetServiceConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServiceConnectionResult> getServiceConnection(GetServiceConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scm:index/getServiceConnection:getServiceConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The Id param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    Id string
    The Id param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id String
    The Id param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id string
    The Id param.
    folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id str
    The Id param.
    folder str
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id String
    The Id param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".

    getServiceConnection Result

    The following output properties are available:

    BackupSC string
    The BackupSC param.
    BgpPeer GetServiceConnectionBgpPeer
    The BgpPeer param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    Id string
    The Id param.
    IpsecTunnel string
    The IpsecTunnel param.
    Name string
    The Name param.
    NatPool string
    The NatPool param.
    NoExportCommunity string
    The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
    OnboardingType string
    The OnboardingType param. String must be one of these: "classic". Default: "classic".
    Protocol GetServiceConnectionProtocol
    The Protocol param.
    Qos GetServiceConnectionQos
    The Qos param.
    Region string
    The Region param.
    SecondaryIpsecTunnel string
    The SecondaryIpsecTunnel param.
    SourceNat bool
    The SourceNat param.
    Subnets List<string>
    The Subnets param.
    Tfid string
    BackupSC string
    The BackupSC param.
    BgpPeer GetServiceConnectionBgpPeer
    The BgpPeer param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    Id string
    The Id param.
    IpsecTunnel string
    The IpsecTunnel param.
    Name string
    The Name param.
    NatPool string
    The NatPool param.
    NoExportCommunity string
    The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
    OnboardingType string
    The OnboardingType param. String must be one of these: "classic". Default: "classic".
    Protocol GetServiceConnectionProtocol
    The Protocol param.
    Qos GetServiceConnectionQos
    The Qos param.
    Region string
    The Region param.
    SecondaryIpsecTunnel string
    The SecondaryIpsecTunnel param.
    SourceNat bool
    The SourceNat param.
    Subnets []string
    The Subnets param.
    Tfid string
    backupSC String
    The BackupSC param.
    bgpPeer GetServiceConnectionBgpPeer
    The BgpPeer param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id String
    The Id param.
    ipsecTunnel String
    The IpsecTunnel param.
    name String
    The Name param.
    natPool String
    The NatPool param.
    noExportCommunity String
    The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
    onboardingType String
    The OnboardingType param. String must be one of these: "classic". Default: "classic".
    protocol GetServiceConnectionProtocol
    The Protocol param.
    qos GetServiceConnectionQos
    The Qos param.
    region String
    The Region param.
    secondaryIpsecTunnel String
    The SecondaryIpsecTunnel param.
    sourceNat Boolean
    The SourceNat param.
    subnets List<String>
    The Subnets param.
    tfid String
    backupSC string
    The BackupSC param.
    bgpPeer GetServiceConnectionBgpPeer
    The BgpPeer param.
    folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id string
    The Id param.
    ipsecTunnel string
    The IpsecTunnel param.
    name string
    The Name param.
    natPool string
    The NatPool param.
    noExportCommunity string
    The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
    onboardingType string
    The OnboardingType param. String must be one of these: "classic". Default: "classic".
    protocol GetServiceConnectionProtocol
    The Protocol param.
    qos GetServiceConnectionQos
    The Qos param.
    region string
    The Region param.
    secondaryIpsecTunnel string
    The SecondaryIpsecTunnel param.
    sourceNat boolean
    The SourceNat param.
    subnets string[]
    The Subnets param.
    tfid string
    backup_sc str
    The BackupSC param.
    bgp_peer GetServiceConnectionBgpPeer
    The BgpPeer param.
    folder str
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id str
    The Id param.
    ipsec_tunnel str
    The IpsecTunnel param.
    name str
    The Name param.
    nat_pool str
    The NatPool param.
    no_export_community str
    The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
    onboarding_type str
    The OnboardingType param. String must be one of these: "classic". Default: "classic".
    protocol GetServiceConnectionProtocol
    The Protocol param.
    qos GetServiceConnectionQos
    The Qos param.
    region str
    The Region param.
    secondary_ipsec_tunnel str
    The SecondaryIpsecTunnel param.
    source_nat bool
    The SourceNat param.
    subnets Sequence[str]
    The Subnets param.
    tfid str
    backupSC String
    The BackupSC param.
    bgpPeer Property Map
    The BgpPeer param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    id String
    The Id param.
    ipsecTunnel String
    The IpsecTunnel param.
    name String
    The Name param.
    natPool String
    The NatPool param.
    noExportCommunity String
    The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
    onboardingType String
    The OnboardingType param. String must be one of these: "classic". Default: "classic".
    protocol Property Map
    The Protocol param.
    qos Property Map
    The Qos param.
    region String
    The Region param.
    secondaryIpsecTunnel String
    The SecondaryIpsecTunnel param.
    sourceNat Boolean
    The SourceNat param.
    subnets List<String>
    The Subnets param.
    tfid String

    Supporting Types

    GetServiceConnectionBgpPeer

    LocalIpAddress string
    The LocalIpAddress param.
    LocalIpv6Address string
    The LocalIpv6Address param.
    PeerIpAddress string
    The PeerIpAddress param.
    PeerIpv6Address string
    The PeerIpv6Address param.
    SameAsPrimary bool
    The SameAsPrimary param.
    Secret string
    The Secret param.
    LocalIpAddress string
    The LocalIpAddress param.
    LocalIpv6Address string
    The LocalIpv6Address param.
    PeerIpAddress string
    The PeerIpAddress param.
    PeerIpv6Address string
    The PeerIpv6Address param.
    SameAsPrimary bool
    The SameAsPrimary param.
    Secret string
    The Secret param.
    localIpAddress String
    The LocalIpAddress param.
    localIpv6Address String
    The LocalIpv6Address param.
    peerIpAddress String
    The PeerIpAddress param.
    peerIpv6Address String
    The PeerIpv6Address param.
    sameAsPrimary Boolean
    The SameAsPrimary param.
    secret String
    The Secret param.
    localIpAddress string
    The LocalIpAddress param.
    localIpv6Address string
    The LocalIpv6Address param.
    peerIpAddress string
    The PeerIpAddress param.
    peerIpv6Address string
    The PeerIpv6Address param.
    sameAsPrimary boolean
    The SameAsPrimary param.
    secret string
    The Secret param.
    local_ip_address str
    The LocalIpAddress param.
    local_ipv6_address str
    The LocalIpv6Address param.
    peer_ip_address str
    The PeerIpAddress param.
    peer_ipv6_address str
    The PeerIpv6Address param.
    same_as_primary bool
    The SameAsPrimary param.
    secret str
    The Secret param.
    localIpAddress String
    The LocalIpAddress param.
    localIpv6Address String
    The LocalIpv6Address param.
    peerIpAddress String
    The PeerIpAddress param.
    peerIpv6Address String
    The PeerIpv6Address param.
    sameAsPrimary Boolean
    The SameAsPrimary param.
    secret String
    The Secret param.

    GetServiceConnectionProtocol

    bgp Property Map
    The Bgp param.

    GetServiceConnectionProtocolBgp

    DoNotExportRoutes bool
    The DoNotExportRoutes param.
    Enable bool
    The Enable param.
    FastFailover bool
    The FastFailover param.
    LocalIpAddress string
    The LocalIpAddress param.
    OriginateDefaultRoute bool
    The OriginateDefaultRoute param.
    PeerAs string
    The PeerAs param.
    PeerIpAddress string
    The PeerIpAddress param.
    Secret string
    The Secret param.
    SummarizeMobileUserRoutes bool
    The SummarizeMobileUserRoutes param.
    DoNotExportRoutes bool
    The DoNotExportRoutes param.
    Enable bool
    The Enable param.
    FastFailover bool
    The FastFailover param.
    LocalIpAddress string
    The LocalIpAddress param.
    OriginateDefaultRoute bool
    The OriginateDefaultRoute param.
    PeerAs string
    The PeerAs param.
    PeerIpAddress string
    The PeerIpAddress param.
    Secret string
    The Secret param.
    SummarizeMobileUserRoutes bool
    The SummarizeMobileUserRoutes param.
    doNotExportRoutes Boolean
    The DoNotExportRoutes param.
    enable Boolean
    The Enable param.
    fastFailover Boolean
    The FastFailover param.
    localIpAddress String
    The LocalIpAddress param.
    originateDefaultRoute Boolean
    The OriginateDefaultRoute param.
    peerAs String
    The PeerAs param.
    peerIpAddress String
    The PeerIpAddress param.
    secret String
    The Secret param.
    summarizeMobileUserRoutes Boolean
    The SummarizeMobileUserRoutes param.
    doNotExportRoutes boolean
    The DoNotExportRoutes param.
    enable boolean
    The Enable param.
    fastFailover boolean
    The FastFailover param.
    localIpAddress string
    The LocalIpAddress param.
    originateDefaultRoute boolean
    The OriginateDefaultRoute param.
    peerAs string
    The PeerAs param.
    peerIpAddress string
    The PeerIpAddress param.
    secret string
    The Secret param.
    summarizeMobileUserRoutes boolean
    The SummarizeMobileUserRoutes param.
    do_not_export_routes bool
    The DoNotExportRoutes param.
    enable bool
    The Enable param.
    fast_failover bool
    The FastFailover param.
    local_ip_address str
    The LocalIpAddress param.
    originate_default_route bool
    The OriginateDefaultRoute param.
    peer_as str
    The PeerAs param.
    peer_ip_address str
    The PeerIpAddress param.
    secret str
    The Secret param.
    summarize_mobile_user_routes bool
    The SummarizeMobileUserRoutes param.
    doNotExportRoutes Boolean
    The DoNotExportRoutes param.
    enable Boolean
    The Enable param.
    fastFailover Boolean
    The FastFailover param.
    localIpAddress String
    The LocalIpAddress param.
    originateDefaultRoute Boolean
    The OriginateDefaultRoute param.
    peerAs String
    The PeerAs param.
    peerIpAddress String
    The PeerIpAddress param.
    secret String
    The Secret param.
    summarizeMobileUserRoutes Boolean
    The SummarizeMobileUserRoutes param.

    GetServiceConnectionQos

    Enable bool
    The Enable param.
    QosProfile string
    The QosProfile param.
    Enable bool
    The Enable param.
    QosProfile string
    The QosProfile param.
    enable Boolean
    The Enable param.
    qosProfile String
    The QosProfile param.
    enable boolean
    The Enable param.
    qosProfile string
    The QosProfile param.
    enable bool
    The Enable param.
    qos_profile str
    The QosProfile param.
    enable Boolean
    The Enable param.
    qosProfile String
    The QosProfile param.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi