1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixSpokeGatewaySubnetGroup
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixSpokeGatewaySubnetGroup

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

    The aviatrix_spoke_gateway_subnet_group resource creates and manages the spoke gateway subnet groups.

    NOTE: This feature is only valid for Azure.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix Spoke Inspection Subnet Group
        var test = new Aviatrix.AviatrixSpokeGatewaySubnetGroup("test", new()
        {
            GwName = "spoke",
            Subnets = new[]
            {
                "10.2.48.0/20~~subnet1",
                "10.2.64.0/20~~subnet2",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aviatrix.NewAviatrixSpokeGatewaySubnetGroup(ctx, "test", &aviatrix.AviatrixSpokeGatewaySubnetGroupArgs{
    			GwName: pulumi.String("spoke"),
    			Subnets: pulumi.StringArray{
    				pulumi.String("10.2.48.0/20~~subnet1"),
    				pulumi.String("10.2.64.0/20~~subnet2"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aviatrix.AviatrixSpokeGatewaySubnetGroup;
    import com.pulumi.aviatrix.AviatrixSpokeGatewaySubnetGroupArgs;
    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 test = new AviatrixSpokeGatewaySubnetGroup("test", AviatrixSpokeGatewaySubnetGroupArgs.builder()        
                .gwName("spoke")
                .subnets(            
                    "10.2.48.0/20~~subnet1",
                    "10.2.64.0/20~~subnet2")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix Spoke Inspection Subnet Group
    test = aviatrix.AviatrixSpokeGatewaySubnetGroup("test",
        gw_name="spoke",
        subnets=[
            "10.2.48.0/20~~subnet1",
            "10.2.64.0/20~~subnet2",
        ])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Aviatrix Spoke Inspection Subnet Group
    const test = new aviatrix.AviatrixSpokeGatewaySubnetGroup("test", {
        gwName: "spoke",
        subnets: [
            "10.2.48.0/20~~subnet1",
            "10.2.64.0/20~~subnet2",
        ],
    });
    
    resources:
      # Create an Aviatrix Spoke Inspection Subnet Group
      test:
        type: aviatrix:AviatrixSpokeGatewaySubnetGroup
        properties:
          gwName: spoke
          subnets:
            - 10.2.48.0/20~~subnet1
            - 10.2.64.0/20~~subnet2
    

    Create AviatrixSpokeGatewaySubnetGroup Resource

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

    Constructor syntax

    new AviatrixSpokeGatewaySubnetGroup(name: string, args: AviatrixSpokeGatewaySubnetGroupArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixSpokeGatewaySubnetGroup(resource_name: str,
                                        args: AviatrixSpokeGatewaySubnetGroupArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixSpokeGatewaySubnetGroup(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        gw_name: Optional[str] = None,
                                        name: Optional[str] = None,
                                        subnets: Optional[Sequence[str]] = None)
    func NewAviatrixSpokeGatewaySubnetGroup(ctx *Context, name string, args AviatrixSpokeGatewaySubnetGroupArgs, opts ...ResourceOption) (*AviatrixSpokeGatewaySubnetGroup, error)
    public AviatrixSpokeGatewaySubnetGroup(string name, AviatrixSpokeGatewaySubnetGroupArgs args, CustomResourceOptions? opts = null)
    public AviatrixSpokeGatewaySubnetGroup(String name, AviatrixSpokeGatewaySubnetGroupArgs args)
    public AviatrixSpokeGatewaySubnetGroup(String name, AviatrixSpokeGatewaySubnetGroupArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixSpokeGatewaySubnetGroup
    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 AviatrixSpokeGatewaySubnetGroupArgs
    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 AviatrixSpokeGatewaySubnetGroupArgs
    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 AviatrixSpokeGatewaySubnetGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixSpokeGatewaySubnetGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixSpokeGatewaySubnetGroupArgs
    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 aviatrixSpokeGatewaySubnetGroupResource = new Aviatrix.AviatrixSpokeGatewaySubnetGroup("aviatrixSpokeGatewaySubnetGroupResource", new()
    {
        GwName = "string",
        Name = "string",
        Subnets = new[]
        {
            "string",
        },
    });
    
    example, err := aviatrix.NewAviatrixSpokeGatewaySubnetGroup(ctx, "aviatrixSpokeGatewaySubnetGroupResource", &aviatrix.AviatrixSpokeGatewaySubnetGroupArgs{
    	GwName: pulumi.String("string"),
    	Name:   pulumi.String("string"),
    	Subnets: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var aviatrixSpokeGatewaySubnetGroupResource = new AviatrixSpokeGatewaySubnetGroup("aviatrixSpokeGatewaySubnetGroupResource", AviatrixSpokeGatewaySubnetGroupArgs.builder()
        .gwName("string")
        .name("string")
        .subnets("string")
        .build());
    
    aviatrix_spoke_gateway_subnet_group_resource = aviatrix.AviatrixSpokeGatewaySubnetGroup("aviatrixSpokeGatewaySubnetGroupResource",
        gw_name="string",
        name="string",
        subnets=["string"])
    
    const aviatrixSpokeGatewaySubnetGroupResource = new aviatrix.AviatrixSpokeGatewaySubnetGroup("aviatrixSpokeGatewaySubnetGroupResource", {
        gwName: "string",
        name: "string",
        subnets: ["string"],
    });
    
    type: aviatrix:AviatrixSpokeGatewaySubnetGroup
    properties:
        gwName: string
        name: string
        subnets:
            - string
    

    AviatrixSpokeGatewaySubnetGroup Resource Properties

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

    Inputs

    The AviatrixSpokeGatewaySubnetGroup resource accepts the following input properties:

    GwName string
    Aviatrix spoke gateway name.
    Name string
    Name of spoke gateway subnet group.
    Subnets List<string>
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    GwName string
    Aviatrix spoke gateway name.
    Name string
    Name of spoke gateway subnet group.
    Subnets []string
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gwName String
    Aviatrix spoke gateway name.
    name String
    Name of spoke gateway subnet group.
    subnets List<String>
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gwName string
    Aviatrix spoke gateway name.
    name string
    Name of spoke gateway subnet group.
    subnets string[]
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gw_name str
    Aviatrix spoke gateway name.
    name str
    Name of spoke gateway subnet group.
    subnets Sequence[str]
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gwName String
    Aviatrix spoke gateway name.
    name String
    Name of spoke gateway subnet group.
    subnets List<String>
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]

    Outputs

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

    Get an existing AviatrixSpokeGatewaySubnetGroup 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?: AviatrixSpokeGatewaySubnetGroupState, opts?: CustomResourceOptions): AviatrixSpokeGatewaySubnetGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            gw_name: Optional[str] = None,
            name: Optional[str] = None,
            subnets: Optional[Sequence[str]] = None) -> AviatrixSpokeGatewaySubnetGroup
    func GetAviatrixSpokeGatewaySubnetGroup(ctx *Context, name string, id IDInput, state *AviatrixSpokeGatewaySubnetGroupState, opts ...ResourceOption) (*AviatrixSpokeGatewaySubnetGroup, error)
    public static AviatrixSpokeGatewaySubnetGroup Get(string name, Input<string> id, AviatrixSpokeGatewaySubnetGroupState? state, CustomResourceOptions? opts = null)
    public static AviatrixSpokeGatewaySubnetGroup get(String name, Output<String> id, AviatrixSpokeGatewaySubnetGroupState 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:
    GwName string
    Aviatrix spoke gateway name.
    Name string
    Name of spoke gateway subnet group.
    Subnets List<string>
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    GwName string
    Aviatrix spoke gateway name.
    Name string
    Name of spoke gateway subnet group.
    Subnets []string
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gwName String
    Aviatrix spoke gateway name.
    name String
    Name of spoke gateway subnet group.
    subnets List<String>
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gwName string
    Aviatrix spoke gateway name.
    name string
    Name of spoke gateway subnet group.
    subnets string[]
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gw_name str
    Aviatrix spoke gateway name.
    name str
    Name of spoke gateway subnet group.
    subnets Sequence[str]
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]
    gwName String
    Aviatrix spoke gateway name.
    name String
    Name of spoke gateway subnet group.
    subnets List<String>
    A set of subnets in the subnet group. The format of each subnet must be "CIDR~~subnet name". Example: ["10.2.48.0/20~~subnet1", "10.2.64.0/20~~subnet2"]

    Import

    spoke_gateway_subnet_group can be imported using the gw_name and name, e.g.

     $ pulumi import aviatrix:index/aviatrixSpokeGatewaySubnetGroup:AviatrixSpokeGatewaySubnetGroup test gw_name~name
    

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

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix