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

tencentcloud.SecurityGroup

Explore with Pulumi AI

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

    Provides a resource to create security group.

    Example Usage

    Create a basic security group

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const example = new tencentcloud.SecurityGroup("example", {description: "sg test"});
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    example = tencentcloud.SecurityGroup("example", description="sg test")
    
    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.NewSecurityGroup(ctx, "example", &tencentcloud.SecurityGroupArgs{
    			Description: pulumi.String("sg test"),
    		})
    		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 example = new Tencentcloud.SecurityGroup("example", new()
        {
            Description = "sg test",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.SecurityGroup;
    import com.pulumi.tencentcloud.SecurityGroupArgs;
    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 SecurityGroup("example", SecurityGroupArgs.builder()
                .description("sg test")
                .build());
    
        }
    }
    
    resources:
      example:
        type: tencentcloud:SecurityGroup
        properties:
          description: sg test
    

    Create a complete security group

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const example = new tencentcloud.SecurityGroup("example", {
        description: "sg test",
        projectId: 0,
        tags: {
            example: "test",
        },
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    example = tencentcloud.SecurityGroup("example",
        description="sg test",
        project_id=0,
        tags={
            "example": "test",
        })
    
    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.NewSecurityGroup(ctx, "example", &tencentcloud.SecurityGroupArgs{
    			Description: pulumi.String("sg test"),
    			ProjectId:   pulumi.Float64(0),
    			Tags: pulumi.StringMap{
    				"example": pulumi.String("test"),
    			},
    		})
    		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 example = new Tencentcloud.SecurityGroup("example", new()
        {
            Description = "sg test",
            ProjectId = 0,
            Tags = 
            {
                { "example", "test" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.SecurityGroup;
    import com.pulumi.tencentcloud.SecurityGroupArgs;
    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 SecurityGroup("example", SecurityGroupArgs.builder()
                .description("sg test")
                .projectId(0)
                .tags(Map.of("example", "test"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: tencentcloud:SecurityGroup
        properties:
          description: sg test
          projectId: 0
          tags:
            example: test
    

    Create SecurityGroup Resource

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

    Constructor syntax

    new SecurityGroup(name: string, args?: SecurityGroupArgs, opts?: CustomResourceOptions);
    @overload
    def SecurityGroup(resource_name: str,
                      args: Optional[SecurityGroupArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def SecurityGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None,
                      project_id: Optional[float] = None,
                      security_group_id: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewSecurityGroup(ctx *Context, name string, args *SecurityGroupArgs, opts ...ResourceOption) (*SecurityGroup, error)
    public SecurityGroup(string name, SecurityGroupArgs? args = null, CustomResourceOptions? opts = null)
    public SecurityGroup(String name, SecurityGroupArgs args)
    public SecurityGroup(String name, SecurityGroupArgs args, CustomResourceOptions options)
    
    type: tencentcloud:SecurityGroup
    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 SecurityGroupArgs
    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 SecurityGroupArgs
    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 SecurityGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecurityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecurityGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Description string
    Description of the security group.
    Name string
    Name of the security group to be queried.
    ProjectId double
    Project ID of the security group.
    SecurityGroupId string
    ID of the resource.
    Tags Dictionary<string, string>
    Tags of the security group.
    Description string
    Description of the security group.
    Name string
    Name of the security group to be queried.
    ProjectId float64
    Project ID of the security group.
    SecurityGroupId string
    ID of the resource.
    Tags map[string]string
    Tags of the security group.
    description String
    Description of the security group.
    name String
    Name of the security group to be queried.
    projectId Double
    Project ID of the security group.
    securityGroupId String
    ID of the resource.
    tags Map<String,String>
    Tags of the security group.
    description string
    Description of the security group.
    name string
    Name of the security group to be queried.
    projectId number
    Project ID of the security group.
    securityGroupId string
    ID of the resource.
    tags {[key: string]: string}
    Tags of the security group.
    description str
    Description of the security group.
    name str
    Name of the security group to be queried.
    project_id float
    Project ID of the security group.
    security_group_id str
    ID of the resource.
    tags Mapping[str, str]
    Tags of the security group.
    description String
    Description of the security group.
    name String
    Name of the security group to be queried.
    projectId Number
    Project ID of the security group.
    securityGroupId String
    ID of the resource.
    tags Map<String>
    Tags of the security group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SecurityGroup 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 SecurityGroup Resource

    Get an existing SecurityGroup 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?: SecurityGroupState, opts?: CustomResourceOptions): SecurityGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[float] = None,
            security_group_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> SecurityGroup
    func GetSecurityGroup(ctx *Context, name string, id IDInput, state *SecurityGroupState, opts ...ResourceOption) (*SecurityGroup, error)
    public static SecurityGroup Get(string name, Input<string> id, SecurityGroupState? state, CustomResourceOptions? opts = null)
    public static SecurityGroup get(String name, Output<String> id, SecurityGroupState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:SecurityGroup    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:
    Description string
    Description of the security group.
    Name string
    Name of the security group to be queried.
    ProjectId double
    Project ID of the security group.
    SecurityGroupId string
    ID of the resource.
    Tags Dictionary<string, string>
    Tags of the security group.
    Description string
    Description of the security group.
    Name string
    Name of the security group to be queried.
    ProjectId float64
    Project ID of the security group.
    SecurityGroupId string
    ID of the resource.
    Tags map[string]string
    Tags of the security group.
    description String
    Description of the security group.
    name String
    Name of the security group to be queried.
    projectId Double
    Project ID of the security group.
    securityGroupId String
    ID of the resource.
    tags Map<String,String>
    Tags of the security group.
    description string
    Description of the security group.
    name string
    Name of the security group to be queried.
    projectId number
    Project ID of the security group.
    securityGroupId string
    ID of the resource.
    tags {[key: string]: string}
    Tags of the security group.
    description str
    Description of the security group.
    name str
    Name of the security group to be queried.
    project_id float
    Project ID of the security group.
    security_group_id str
    ID of the resource.
    tags Mapping[str, str]
    Tags of the security group.
    description String
    Description of the security group.
    name String
    Name of the security group to be queried.
    projectId Number
    Project ID of the security group.
    securityGroupId String
    ID of the resource.
    tags Map<String>
    Tags of the security group.

    Import

    Security group can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/securityGroup:SecurityGroup  tencentcloud_security_group.sglab sg-ey3wmiz1
    

    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