1. Packages
  2. Exoscale
  3. API Docs
  4. SecurityGroup
Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse

exoscale.SecurityGroup

Explore with Pulumi AI

exoscale logo
Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse

    Manage Exoscale Security Groups.

    Corresponding data source: exoscale_security_group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as exoscale from "@pulumiverse/exoscale";
    
    const mySecurityGroup = new exoscale.SecurityGroup("mySecurityGroup", {});
    
    import pulumi
    import pulumiverse_exoscale as exoscale
    
    my_security_group = exoscale.SecurityGroup("mySecurityGroup")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-exoscale/sdk/go/exoscale"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := exoscale.NewSecurityGroup(ctx, "mySecurityGroup", nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Exoscale = Pulumiverse.Exoscale;
    
    return await Deployment.RunAsync(() => 
    {
        var mySecurityGroup = new Exoscale.SecurityGroup("mySecurityGroup");
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.exoscale.SecurityGroup;
    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 mySecurityGroup = new SecurityGroup("mySecurityGroup");
    
        }
    }
    
    resources:
      mySecurityGroup:
        type: exoscale:SecurityGroup
    

    Next step is to attach exoscale_security_group_rule(s) to the group.

    Please refer to the examples directory for complete configuration examples.

    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,
                      external_sources: Optional[Sequence[str]] = None,
                      name: Optional[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: exoscale: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.

    Constructor example

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

    var securityGroupResource = new Exoscale.SecurityGroup("securityGroupResource", new()
    {
        Description = "string",
        ExternalSources = new[]
        {
            "string",
        },
        Name = "string",
    });
    
    example, err := exoscale.NewSecurityGroup(ctx, "securityGroupResource", &exoscale.SecurityGroupArgs{
    	Description: pulumi.String("string"),
    	ExternalSources: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var securityGroupResource = new SecurityGroup("securityGroupResource", SecurityGroupArgs.builder()
        .description("string")
        .externalSources("string")
        .name("string")
        .build());
    
    security_group_resource = exoscale.SecurityGroup("securityGroupResource",
        description="string",
        external_sources=["string"],
        name="string")
    
    const securityGroupResource = new exoscale.SecurityGroup("securityGroupResource", {
        description: "string",
        externalSources: ["string"],
        name: "string",
    });
    
    type: exoscale:SecurityGroup
    properties:
        description: string
        externalSources:
            - string
        name: string
    

    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
    ❗ A free-form text describing the group.
    ExternalSources List<string>
    A list of external network sources, in CIDR notation.
    Name string
    ❗ The security group name.
    Description string
    ❗ A free-form text describing the group.
    ExternalSources []string
    A list of external network sources, in CIDR notation.
    Name string
    ❗ The security group name.
    description String
    ❗ A free-form text describing the group.
    externalSources List<String>
    A list of external network sources, in CIDR notation.
    name String
    ❗ The security group name.
    description string
    ❗ A free-form text describing the group.
    externalSources string[]
    A list of external network sources, in CIDR notation.
    name string
    ❗ The security group name.
    description str
    ❗ A free-form text describing the group.
    external_sources Sequence[str]
    A list of external network sources, in CIDR notation.
    name str
    ❗ The security group name.
    description String
    ❗ A free-form text describing the group.
    externalSources List<String>
    A list of external network sources, in CIDR notation.
    name String
    ❗ The security group name.

    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,
            external_sources: Optional[Sequence[str]] = None,
            name: Optional[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)
    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
    ❗ A free-form text describing the group.
    ExternalSources List<string>
    A list of external network sources, in CIDR notation.
    Name string
    ❗ The security group name.
    Description string
    ❗ A free-form text describing the group.
    ExternalSources []string
    A list of external network sources, in CIDR notation.
    Name string
    ❗ The security group name.
    description String
    ❗ A free-form text describing the group.
    externalSources List<String>
    A list of external network sources, in CIDR notation.
    name String
    ❗ The security group name.
    description string
    ❗ A free-form text describing the group.
    externalSources string[]
    A list of external network sources, in CIDR notation.
    name string
    ❗ The security group name.
    description str
    ❗ A free-form text describing the group.
    external_sources Sequence[str]
    A list of external network sources, in CIDR notation.
    name str
    ❗ The security group name.
    description String
    ❗ A free-form text describing the group.
    externalSources List<String>
    A list of external network sources, in CIDR notation.
    name String
    ❗ The security group name.

    Import

    An existing security group may be imported by <ID>:

    $ pulumi import exoscale:index/securityGroup:SecurityGroup \
    

    exoscale_security_group.my_security_group \

    f81d4fae-7dec-11d0-a765-00a0c91e6bf6

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

    Package Details

    Repository
    exoscale pulumiverse/pulumi-exoscale
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the exoscale Terraform Provider.
    exoscale logo
    Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse