Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. Service
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.Service

Explore with Pulumi AI

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

    Retrieves a config item.

    Example Usage

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

const example = new scm.Service("example", {});

    import pulumi
import pulumi_scm as scm

example = scm.Service("example")

    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.NewService(ctx, "example", 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 = new Scm.Service("example");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.Service;
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) {
        var example = new Service("example");

    }
}

    resources:
  example:
    type: scm:Service

    Create Service Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            protocol: Optional[ServiceProtocolArgs] = None,
            description: Optional[str] = None,
            device: Optional[str] = None,
            folder: Optional[str] = None,
            name: Optional[str] = None,
            snippet: Optional[str] = None,
            tags: Optional[Sequence[str]] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: scm:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var serviceResource = new Scm.Service("serviceResource", new()
{
    Protocol = new Scm.Inputs.ServiceProtocolArgs
    {
        Tcp = new Scm.Inputs.ServiceProtocolTcpArgs
        {
            Port = "string",
            Override = new Scm.Inputs.ServiceProtocolTcpOverrideArgs
            {
                HalfcloseTimeout = 0,
                Timeout = 0,
                TimewaitTimeout = 0,
            },
            SourcePort = "string",
        },
        Udp = new Scm.Inputs.ServiceProtocolUdpArgs
        {
            Port = "string",
            Override = new Scm.Inputs.ServiceProtocolUdpOverrideArgs
            {
                Timeout = 0,
            },
            SourcePort = "string",
        },
    },
    Description = "string",
    Device = "string",
    Folder = "string",
    Name = "string",
    Snippet = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := scm.NewService(ctx, "serviceResource", &scm.ServiceArgs{
	Protocol: &scm.ServiceProtocolArgs{
		Tcp: &scm.ServiceProtocolTcpArgs{
			Port: pulumi.String("string"),
			Override: &scm.ServiceProtocolTcpOverrideArgs{
				HalfcloseTimeout: pulumi.Int(0),
				Timeout:          pulumi.Int(0),
				TimewaitTimeout:  pulumi.Int(0),
			},
			SourcePort: pulumi.String("string"),
		},
		Udp: &scm.ServiceProtocolUdpArgs{
			Port: pulumi.String("string"),
			Override: &scm.ServiceProtocolUdpOverrideArgs{
				Timeout: pulumi.Int(0),
			},
			SourcePort: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Folder:      pulumi.String("string"),
	Name:        pulumi.String("string"),
	Snippet:     pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var serviceResource = new Service("serviceResource", ServiceArgs.builder()
    .protocol(ServiceProtocolArgs.builder()
        .tcp(ServiceProtocolTcpArgs.builder()
            .port("string")
            .override(ServiceProtocolTcpOverrideArgs.builder()
                .halfcloseTimeout(0)
                .timeout(0)
                .timewaitTimeout(0)
                .build())
            .sourcePort("string")
            .build())
        .udp(ServiceProtocolUdpArgs.builder()
            .port("string")
            .override(ServiceProtocolUdpOverrideArgs.builder()
                .timeout(0)
                .build())
            .sourcePort("string")
            .build())
        .build())
    .description("string")
    .device("string")
    .folder("string")
    .name("string")
    .snippet("string")
    .tags("string")
    .build());

    service_resource = scm.Service("serviceResource",
    protocol={
        "tcp": {
            "port": "string",
            "override": {
                "halfclose_timeout": 0,
                "timeout": 0,
                "timewait_timeout": 0,
            },
            "source_port": "string",
        },
        "udp": {
            "port": "string",
            "override": {
                "timeout": 0,
            },
            "source_port": "string",
        },
    },
    description="string",
    device="string",
    folder="string",
    name="string",
    snippet="string",
    tags=["string"])

    const serviceResource = new scm.Service("serviceResource", {
    protocol: {
        tcp: {
            port: "string",
            override: {
                halfcloseTimeout: 0,
                timeout: 0,
                timewaitTimeout: 0,
            },
            sourcePort: "string",
        },
        udp: {
            port: "string",
            override: {
                timeout: 0,
            },
            sourcePort: "string",
        },
    },
    description: "string",
    device: "string",
    folder: "string",
    name: "string",
    snippet: "string",
    tags: ["string"],
});

    type: scm:Service
properties:
    description: string
    device: string
    folder: string
    name: string
    protocol:
        tcp:
            override:
                halfcloseTimeout: 0
                timeout: 0
                timewaitTimeout: 0
            port: string
            sourcePort: string
        udp:
            override:
                timeout: 0
            port: string
            sourcePort: string
    snippet: string
    tags:
        - string

    Service Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Service resource accepts the following input properties:

    Protocol ServiceProtocol
    The Protocol param.
    Description string
    The Description param. String length must not exceed 1023 characters.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Snippet string
    The Snippet 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.
    Protocol ServiceProtocolArgs
    The Protocol param.
    Description string
    The Description param. String length must not exceed 1023 characters.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Snippet string
    The Snippet 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.
    protocol ServiceProtocol
    The Protocol param.
    description String
    The Description param. String length must not exceed 1023 characters.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet String
    The Snippet 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.
    protocol ServiceProtocol
    The Protocol param.
    description string
    The Description param. String length must not exceed 1023 characters.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet string
    The Snippet 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.
    protocol ServiceProtocolArgs
    The Protocol param.
    description str
    The Description param. String length must not exceed 1023 characters.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet str
    The Snippet 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.
    protocol Property Map
    The Protocol param.
    description String
    The Description param. String length must not exceed 1023 characters.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet String
    The Snippet 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String

    Look up Existing Service Resource

    Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        protocol: Optional[ServiceProtocolArgs] = None,
        snippet: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tfid: Optional[str] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The Description param. String length must not exceed 1023 characters.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Protocol ServiceProtocol
    The Protocol param.
    Snippet string
    The Snippet 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.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Protocol ServiceProtocolArgs
    The Protocol param.
    Snippet string
    The Snippet 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.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol ServiceProtocol
    The Protocol param.
    snippet String
    The Snippet 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.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol ServiceProtocol
    The Protocol param.
    snippet string
    The Snippet 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.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol ServiceProtocolArgs
    The Protocol param.
    snippet str
    The Snippet 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.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol Property Map
    The Protocol param.
    snippet String
    The Snippet 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

    ServiceProtocol, ServiceProtocolArgs

    Tcp ServiceProtocolTcp
    The Tcp param. Ensure that only one of the following is specified: tcp, udp
    Udp ServiceProtocolUdp
    The Udp param. Ensure that only one of the following is specified: tcp, udp
    Tcp ServiceProtocolTcp
    The Tcp param. Ensure that only one of the following is specified: tcp, udp
    Udp ServiceProtocolUdp
    The Udp param. Ensure that only one of the following is specified: tcp, udp
    tcp ServiceProtocolTcp
    The Tcp param. Ensure that only one of the following is specified: tcp, udp
    udp ServiceProtocolUdp
    The Udp param. Ensure that only one of the following is specified: tcp, udp
    tcp ServiceProtocolTcp
    The Tcp param. Ensure that only one of the following is specified: tcp, udp
    udp ServiceProtocolUdp
    The Udp param. Ensure that only one of the following is specified: tcp, udp
    tcp ServiceProtocolTcp
    The Tcp param. Ensure that only one of the following is specified: tcp, udp
    udp ServiceProtocolUdp
    The Udp param. Ensure that only one of the following is specified: tcp, udp
    tcp Property Map
    The Tcp param. Ensure that only one of the following is specified: tcp, udp
    udp Property Map
    The Udp param. Ensure that only one of the following is specified: tcp, udp

    ServiceProtocolTcp, ServiceProtocolTcpArgs

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

    ServiceProtocolTcpOverride, ServiceProtocolTcpOverrideArgs

    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.

    ServiceProtocolUdp, ServiceProtocolUdpArgs

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

    ServiceProtocolUdpOverride, ServiceProtocolUdpOverrideArgs

    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
    pulumi/pulumi-scm