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

aviatrix.AviatrixAwsTgwPeering

Explore with Pulumi AI

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

    The aviatrix_aws_tgw_peering resource allows the creation and management of Aviatrix-created inter-region peerings between AWS TGWs.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix AWS Tgw Peering
        var test = new Aviatrix.AviatrixAwsTgwPeering("test", new()
        {
            TgwName1 = "tgw1",
            TgwName2 = "tgw2",
        });
    
    });
    
    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.NewAviatrixAwsTgwPeering(ctx, "test", &aviatrix.AviatrixAwsTgwPeeringArgs{
    			TgwName1: pulumi.String("tgw1"),
    			TgwName2: pulumi.String("tgw2"),
    		})
    		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.AviatrixAwsTgwPeering;
    import com.pulumi.aviatrix.AviatrixAwsTgwPeeringArgs;
    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 AviatrixAwsTgwPeering("test", AviatrixAwsTgwPeeringArgs.builder()        
                .tgwName1("tgw1")
                .tgwName2("tgw2")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix AWS Tgw Peering
    test = aviatrix.AviatrixAwsTgwPeering("test",
        tgw_name1="tgw1",
        tgw_name2="tgw2")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Aviatrix AWS Tgw Peering
    const test = new aviatrix.AviatrixAwsTgwPeering("test", {
        tgwName1: "tgw1",
        tgwName2: "tgw2",
    });
    
    resources:
      # Create an Aviatrix AWS Tgw Peering
      test:
        type: aviatrix:AviatrixAwsTgwPeering
        properties:
          tgwName1: tgw1
          tgwName2: tgw2
    

    Create AviatrixAwsTgwPeering Resource

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

    Constructor syntax

    new AviatrixAwsTgwPeering(name: string, args: AviatrixAwsTgwPeeringArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixAwsTgwPeering(resource_name: str,
                              args: AviatrixAwsTgwPeeringArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixAwsTgwPeering(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              tgw_name1: Optional[str] = None,
                              tgw_name2: Optional[str] = None)
    func NewAviatrixAwsTgwPeering(ctx *Context, name string, args AviatrixAwsTgwPeeringArgs, opts ...ResourceOption) (*AviatrixAwsTgwPeering, error)
    public AviatrixAwsTgwPeering(string name, AviatrixAwsTgwPeeringArgs args, CustomResourceOptions? opts = null)
    public AviatrixAwsTgwPeering(String name, AviatrixAwsTgwPeeringArgs args)
    public AviatrixAwsTgwPeering(String name, AviatrixAwsTgwPeeringArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixAwsTgwPeering
    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 AviatrixAwsTgwPeeringArgs
    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 AviatrixAwsTgwPeeringArgs
    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 AviatrixAwsTgwPeeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAwsTgwPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixAwsTgwPeeringArgs
    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 aviatrixAwsTgwPeeringResource = new Aviatrix.AviatrixAwsTgwPeering("aviatrixAwsTgwPeeringResource", new()
    {
        TgwName1 = "string",
        TgwName2 = "string",
    });
    
    example, err := aviatrix.NewAviatrixAwsTgwPeering(ctx, "aviatrixAwsTgwPeeringResource", &aviatrix.AviatrixAwsTgwPeeringArgs{
    	TgwName1: pulumi.String("string"),
    	TgwName2: pulumi.String("string"),
    })
    
    var aviatrixAwsTgwPeeringResource = new AviatrixAwsTgwPeering("aviatrixAwsTgwPeeringResource", AviatrixAwsTgwPeeringArgs.builder()
        .tgwName1("string")
        .tgwName2("string")
        .build());
    
    aviatrix_aws_tgw_peering_resource = aviatrix.AviatrixAwsTgwPeering("aviatrixAwsTgwPeeringResource",
        tgw_name1="string",
        tgw_name2="string")
    
    const aviatrixAwsTgwPeeringResource = new aviatrix.AviatrixAwsTgwPeering("aviatrixAwsTgwPeeringResource", {
        tgwName1: "string",
        tgwName2: "string",
    });
    
    type: aviatrix:AviatrixAwsTgwPeering
    properties:
        tgwName1: string
        tgwName2: string
    

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

    TgwName1 string
    This parameter represents name of the first AWS TGW to make a peer pair.
    TgwName2 string
    This parameter represents name of the second AWS TGW to make a peer pair.
    TgwName1 string
    This parameter represents name of the first AWS TGW to make a peer pair.
    TgwName2 string
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgwName1 String
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgwName2 String
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgwName1 string
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgwName2 string
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgw_name1 str
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgw_name2 str
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgwName1 String
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgwName2 String
    This parameter represents name of the second AWS TGW to make a peer pair.

    Outputs

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

    Get an existing AviatrixAwsTgwPeering 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?: AviatrixAwsTgwPeeringState, opts?: CustomResourceOptions): AviatrixAwsTgwPeering
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            tgw_name1: Optional[str] = None,
            tgw_name2: Optional[str] = None) -> AviatrixAwsTgwPeering
    func GetAviatrixAwsTgwPeering(ctx *Context, name string, id IDInput, state *AviatrixAwsTgwPeeringState, opts ...ResourceOption) (*AviatrixAwsTgwPeering, error)
    public static AviatrixAwsTgwPeering Get(string name, Input<string> id, AviatrixAwsTgwPeeringState? state, CustomResourceOptions? opts = null)
    public static AviatrixAwsTgwPeering get(String name, Output<String> id, AviatrixAwsTgwPeeringState 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:
    TgwName1 string
    This parameter represents name of the first AWS TGW to make a peer pair.
    TgwName2 string
    This parameter represents name of the second AWS TGW to make a peer pair.
    TgwName1 string
    This parameter represents name of the first AWS TGW to make a peer pair.
    TgwName2 string
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgwName1 String
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgwName2 String
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgwName1 string
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgwName2 string
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgw_name1 str
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgw_name2 str
    This parameter represents name of the second AWS TGW to make a peer pair.
    tgwName1 String
    This parameter represents name of the first AWS TGW to make a peer pair.
    tgwName2 String
    This parameter represents name of the second AWS TGW to make a peer pair.

    Import

    aws_tgw_peering can be imported using the tgw_name1 and tgw_name2, e.g.

     $ pulumi import aviatrix:index/aviatrixAwsTgwPeering:AviatrixAwsTgwPeering test tgw_name1~tgw_name2
    

    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