1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ProtocolTemplate
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.ProtocolTemplate

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Provides a resource to manage protocol template.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const foo = new tencentcloud.ProtocolTemplate("foo", {protocols: [
        "tcp:80",
        "udp:all",
        "icmp:10-30",
    ]});
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    foo = tencentcloud.ProtocolTemplate("foo", protocols=[
        "tcp:80",
        "udp:all",
        "icmp:10-30",
    ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tencentcloud.NewProtocolTemplate(ctx, "foo", &tencentcloud.ProtocolTemplateArgs{
    			Protocols: pulumi.StringArray{
    				pulumi.String("tcp:80"),
    				pulumi.String("udp:all"),
    				pulumi.String("icmp:10-30"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Tencentcloud.ProtocolTemplate("foo", new()
        {
            Protocols = new[]
            {
                "tcp:80",
                "udp:all",
                "icmp:10-30",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.ProtocolTemplate;
    import com.pulumi.tencentcloud.ProtocolTemplateArgs;
    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 foo = new ProtocolTemplate("foo", ProtocolTemplateArgs.builder()
                .protocols(            
                    "tcp:80",
                    "udp:all",
                    "icmp:10-30")
                .build());
    
        }
    }
    
    resources:
      foo:
        type: tencentcloud:ProtocolTemplate
        properties:
          protocols:
            - tcp:80
            - udp:all
            - icmp:10-30
    

    Create ProtocolTemplate Resource

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

    Constructor syntax

    new ProtocolTemplate(name: string, args: ProtocolTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def ProtocolTemplate(resource_name: str,
                         args: ProtocolTemplateArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProtocolTemplate(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         protocols: Optional[Sequence[str]] = None,
                         name: Optional[str] = None,
                         protocol_template_id: Optional[str] = None)
    func NewProtocolTemplate(ctx *Context, name string, args ProtocolTemplateArgs, opts ...ResourceOption) (*ProtocolTemplate, error)
    public ProtocolTemplate(string name, ProtocolTemplateArgs args, CustomResourceOptions? opts = null)
    public ProtocolTemplate(String name, ProtocolTemplateArgs args)
    public ProtocolTemplate(String name, ProtocolTemplateArgs args, CustomResourceOptions options)
    
    type: tencentcloud:ProtocolTemplate
    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 ProtocolTemplateArgs
    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 ProtocolTemplateArgs
    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 ProtocolTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProtocolTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProtocolTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ProtocolTemplate 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 ProtocolTemplate resource accepts the following input properties:

    Protocols List<string>
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    Name string
    Name of the protocol template.
    ProtocolTemplateId string
    ID of the resource.
    Protocols []string
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    Name string
    Name of the protocol template.
    ProtocolTemplateId string
    ID of the resource.
    protocols List<String>
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name String
    Name of the protocol template.
    protocolTemplateId String
    ID of the resource.
    protocols string[]
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name string
    Name of the protocol template.
    protocolTemplateId string
    ID of the resource.
    protocols Sequence[str]
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name str
    Name of the protocol template.
    protocol_template_id str
    ID of the resource.
    protocols List<String>
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name String
    Name of the protocol template.
    protocolTemplateId String
    ID of the resource.

    Outputs

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

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

    Look up Existing ProtocolTemplate Resource

    Get an existing ProtocolTemplate 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?: ProtocolTemplateState, opts?: CustomResourceOptions): ProtocolTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            protocol_template_id: Optional[str] = None,
            protocols: Optional[Sequence[str]] = None) -> ProtocolTemplate
    func GetProtocolTemplate(ctx *Context, name string, id IDInput, state *ProtocolTemplateState, opts ...ResourceOption) (*ProtocolTemplate, error)
    public static ProtocolTemplate Get(string name, Input<string> id, ProtocolTemplateState? state, CustomResourceOptions? opts = null)
    public static ProtocolTemplate get(String name, Output<String> id, ProtocolTemplateState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ProtocolTemplate    get:      id: ${id}
    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:
    Name string
    Name of the protocol template.
    ProtocolTemplateId string
    ID of the resource.
    Protocols List<string>
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    Name string
    Name of the protocol template.
    ProtocolTemplateId string
    ID of the resource.
    Protocols []string
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name String
    Name of the protocol template.
    protocolTemplateId String
    ID of the resource.
    protocols List<String>
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name string
    Name of the protocol template.
    protocolTemplateId string
    ID of the resource.
    protocols string[]
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name str
    Name of the protocol template.
    protocol_template_id str
    ID of the resource.
    protocols Sequence[str]
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.
    name String
    Name of the protocol template.
    protocolTemplateId String
    ID of the resource.
    protocols List<String>
    Protocol list. Valid protocols are tcp, udp, icmp, gre. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol icmp and gre cannot specify port.

    Import

    Protocol template can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/protocolTemplate:ProtocolTemplate foo ppm-nwrggd14
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack