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

aviatrix.AviatrixAzureVngConn

Explore with Pulumi AI

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

    The aviatrix_azure_vng_conn resource allows the creation and management of the connection between Aviatrix Transit Gateway and Azure VNG.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Attach an Azure VNG to an Aviatrix Transit Gateway
        var test = new Aviatrix.AviatrixAzureVngConn("test", new()
        {
            ConnectionName = "connection",
            PrimaryGatewayName = "primary-gateway",
        });
    
    });
    
    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.NewAviatrixAzureVngConn(ctx, "test", &aviatrix.AviatrixAzureVngConnArgs{
    			ConnectionName:     pulumi.String("connection"),
    			PrimaryGatewayName: pulumi.String("primary-gateway"),
    		})
    		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.AviatrixAzureVngConn;
    import com.pulumi.aviatrix.AviatrixAzureVngConnArgs;
    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 AviatrixAzureVngConn("test", AviatrixAzureVngConnArgs.builder()        
                .connectionName("connection")
                .primaryGatewayName("primary-gateway")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Attach an Azure VNG to an Aviatrix Transit Gateway
    test = aviatrix.AviatrixAzureVngConn("test",
        connection_name="connection",
        primary_gateway_name="primary-gateway")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Attach an Azure VNG to an Aviatrix Transit Gateway
    const test = new aviatrix.AviatrixAzureVngConn("test", {
        connectionName: "connection",
        primaryGatewayName: "primary-gateway",
    });
    
    resources:
      # Attach an Azure VNG to an Aviatrix Transit Gateway
      test:
        type: aviatrix:AviatrixAzureVngConn
        properties:
          connectionName: connection
          primaryGatewayName: primary-gateway
    

    Create AviatrixAzureVngConn Resource

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

    Constructor syntax

    new AviatrixAzureVngConn(name: string, args: AviatrixAzureVngConnArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixAzureVngConn(resource_name: str,
                             args: AviatrixAzureVngConnArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixAzureVngConn(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             connection_name: Optional[str] = None,
                             primary_gateway_name: Optional[str] = None)
    func NewAviatrixAzureVngConn(ctx *Context, name string, args AviatrixAzureVngConnArgs, opts ...ResourceOption) (*AviatrixAzureVngConn, error)
    public AviatrixAzureVngConn(string name, AviatrixAzureVngConnArgs args, CustomResourceOptions? opts = null)
    public AviatrixAzureVngConn(String name, AviatrixAzureVngConnArgs args)
    public AviatrixAzureVngConn(String name, AviatrixAzureVngConnArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixAzureVngConn
    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 AviatrixAzureVngConnArgs
    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 AviatrixAzureVngConnArgs
    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 AviatrixAzureVngConnArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAzureVngConnArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixAzureVngConnArgs
    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 aviatrixAzureVngConnResource = new Aviatrix.AviatrixAzureVngConn("aviatrixAzureVngConnResource", new()
    {
        ConnectionName = "string",
        PrimaryGatewayName = "string",
    });
    
    example, err := aviatrix.NewAviatrixAzureVngConn(ctx, "aviatrixAzureVngConnResource", &aviatrix.AviatrixAzureVngConnArgs{
    	ConnectionName:     pulumi.String("string"),
    	PrimaryGatewayName: pulumi.String("string"),
    })
    
    var aviatrixAzureVngConnResource = new AviatrixAzureVngConn("aviatrixAzureVngConnResource", AviatrixAzureVngConnArgs.builder()
        .connectionName("string")
        .primaryGatewayName("string")
        .build());
    
    aviatrix_azure_vng_conn_resource = aviatrix.AviatrixAzureVngConn("aviatrixAzureVngConnResource",
        connection_name="string",
        primary_gateway_name="string")
    
    const aviatrixAzureVngConnResource = new aviatrix.AviatrixAzureVngConn("aviatrixAzureVngConnResource", {
        connectionName: "string",
        primaryGatewayName: "string",
    });
    
    type: aviatrix:AviatrixAzureVngConn
    properties:
        connectionName: string
        primaryGatewayName: string
    

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

    ConnectionName string
    Connection name.
    PrimaryGatewayName string
    Primary Aviatrix transit gateway name.
    ConnectionName string
    Connection name.
    PrimaryGatewayName string
    Primary Aviatrix transit gateway name.
    connectionName String
    Connection name.
    primaryGatewayName String
    Primary Aviatrix transit gateway name.
    connectionName string
    Connection name.
    primaryGatewayName string
    Primary Aviatrix transit gateway name.
    connection_name str
    Connection name.
    primary_gateway_name str
    Primary Aviatrix transit gateway name.
    connectionName String
    Connection name.
    primaryGatewayName String
    Primary Aviatrix transit gateway name.

    Outputs

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

    Attached bool
    The status of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    VngName string
    Name of Azure VNG.
    VpcId string
    VPC ID.
    Attached bool
    The status of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    VngName string
    Name of Azure VNG.
    VpcId string
    VPC ID.
    attached Boolean
    The status of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    vngName String
    Name of Azure VNG.
    vpcId String
    VPC ID.
    attached boolean
    The status of the connection.
    id string
    The provider-assigned unique ID for this managed resource.
    vngName string
    Name of Azure VNG.
    vpcId string
    VPC ID.
    attached bool
    The status of the connection.
    id str
    The provider-assigned unique ID for this managed resource.
    vng_name str
    Name of Azure VNG.
    vpc_id str
    VPC ID.
    attached Boolean
    The status of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    vngName String
    Name of Azure VNG.
    vpcId String
    VPC ID.

    Look up Existing AviatrixAzureVngConn Resource

    Get an existing AviatrixAzureVngConn 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?: AviatrixAzureVngConnState, opts?: CustomResourceOptions): AviatrixAzureVngConn
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attached: Optional[bool] = None,
            connection_name: Optional[str] = None,
            primary_gateway_name: Optional[str] = None,
            vng_name: Optional[str] = None,
            vpc_id: Optional[str] = None) -> AviatrixAzureVngConn
    func GetAviatrixAzureVngConn(ctx *Context, name string, id IDInput, state *AviatrixAzureVngConnState, opts ...ResourceOption) (*AviatrixAzureVngConn, error)
    public static AviatrixAzureVngConn Get(string name, Input<string> id, AviatrixAzureVngConnState? state, CustomResourceOptions? opts = null)
    public static AviatrixAzureVngConn get(String name, Output<String> id, AviatrixAzureVngConnState 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:
    Attached bool
    The status of the connection.
    ConnectionName string
    Connection name.
    PrimaryGatewayName string
    Primary Aviatrix transit gateway name.
    VngName string
    Name of Azure VNG.
    VpcId string
    VPC ID.
    Attached bool
    The status of the connection.
    ConnectionName string
    Connection name.
    PrimaryGatewayName string
    Primary Aviatrix transit gateway name.
    VngName string
    Name of Azure VNG.
    VpcId string
    VPC ID.
    attached Boolean
    The status of the connection.
    connectionName String
    Connection name.
    primaryGatewayName String
    Primary Aviatrix transit gateway name.
    vngName String
    Name of Azure VNG.
    vpcId String
    VPC ID.
    attached boolean
    The status of the connection.
    connectionName string
    Connection name.
    primaryGatewayName string
    Primary Aviatrix transit gateway name.
    vngName string
    Name of Azure VNG.
    vpcId string
    VPC ID.
    attached bool
    The status of the connection.
    connection_name str
    Connection name.
    primary_gateway_name str
    Primary Aviatrix transit gateway name.
    vng_name str
    Name of Azure VNG.
    vpc_id str
    VPC ID.
    attached Boolean
    The status of the connection.
    connectionName String
    Connection name.
    primaryGatewayName String
    Primary Aviatrix transit gateway name.
    vngName String
    Name of Azure VNG.
    vpcId String
    VPC ID.

    Import

    aviatrix_azure_vng_conn can be imported using the connection_name, e.g.

     $ pulumi import aviatrix:index/aviatrixAzureVngConn:AviatrixAzureVngConn test connection
    

    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