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

scm.getService

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.getService({
        id: "1234-56-789",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_service(id="1234-56-789")
    
    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.LookupService(ctx, &scm.LookupServiceArgs{
    			Id: "1234-56-789",
    		}, 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.GetService.Invoke(new()
        {
            Id = "1234-56-789",
        });
    
    });
    
    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.GetServiceArgs;
    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.getService(GetServiceArgs.builder()
                .id("1234-56-789")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getService
          Arguments:
            id: 1234-56-789
    

    Using getService

    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 getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
    function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
    def get_service(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetServiceResult
    def get_service_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
    func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
    func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

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

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

    The following arguments are supported:

    Id string
    The Id param.
    Id string
    The Id param.
    id String
    The Id param.
    id string
    The Id param.
    id str
    The Id param.
    id String
    The Id param.

    getService Result

    The following output properties are available:

    Description string
    The Description param. String length must not exceed 1023 characters.
    Id string
    The Id param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Protocol GetServiceProtocol
    The Protocol param.
    Tags List<string>
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    Tfid string
    Description string
    The Description param. String length must not exceed 1023 characters.
    Id string
    The Id param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Protocol GetServiceProtocol
    The Protocol param.
    Tags []string
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    Tfid string
    description String
    The Description param. String length must not exceed 1023 characters.
    id String
    The Id param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol GetServiceProtocol
    The Protocol param.
    tags List<String>
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid String
    description string
    The Description param. String length must not exceed 1023 characters.
    id string
    The Id param.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol GetServiceProtocol
    The Protocol param.
    tags string[]
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid string
    description str
    The Description param. String length must not exceed 1023 characters.
    id str
    The Id param.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol GetServiceProtocol
    The Protocol param.
    tags Sequence[str]
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid str
    description String
    The Description param. String length must not exceed 1023 characters.
    id String
    The Id param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol Property Map
    The Protocol param.
    tags List<String>
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid String

    Supporting Types

    GetServiceProtocol

    tcp Property Map
    The Tcp param.
    udp Property Map
    The Udp param.

    GetServiceProtocolTcp

    Override GetServiceProtocolTcpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    Override GetServiceProtocolTcpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceProtocolTcpOverride
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceProtocolTcpOverride
    The Override param.
    port string
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceProtocolTcpOverride
    The Override param.
    port str
    The Port param. String length must be between 1 and 1023 characters.
    source_port str
    The SourcePort param. String length must be between 1 and 1023 characters.
    override Property Map
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.

    GetServiceProtocolTcpOverride

    HalfcloseTimeout int
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    Timeout int
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    TimewaitTimeout int
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    HalfcloseTimeout int
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    Timeout int
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    TimewaitTimeout int
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfcloseTimeout Integer
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout Integer
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewaitTimeout Integer
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfcloseTimeout number
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout number
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewaitTimeout number
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfclose_timeout int
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout int
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewait_timeout int
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfcloseTimeout Number
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout Number
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewaitTimeout Number
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.

    GetServiceProtocolUdp

    Override GetServiceProtocolUdpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    Override GetServiceProtocolUdpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceProtocolUdpOverride
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceProtocolUdpOverride
    The Override param.
    port string
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceProtocolUdpOverride
    The Override param.
    port str
    The Port param. String length must be between 1 and 1023 characters.
    source_port str
    The SourcePort param. String length must be between 1 and 1023 characters.
    override Property Map
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.

    GetServiceProtocolUdpOverride

    Timeout int
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    Timeout int
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout Integer
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout number
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout int
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout Number
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.

    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