Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixAwsTgwPeering
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixAwsTgwPeering

Explore with Pulumi AI

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-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",
    });

});
Copy
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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix AWS Tgw Peering
test = aviatrix.AviatrixAwsTgwPeering("test",
    tgw_name1="tgw1",
    tgw_name2="tgw2")
Copy
resources:
  # Create an Aviatrix AWS Tgw Peering
  test:
    type: aviatrix:AviatrixAwsTgwPeering
    properties:
      tgwName1: tgw1
      tgwName2: tgw2
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. AviatrixAwsTgwPeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. AviatrixAwsTgwPeeringArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixAwsTgwPeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
example, err := aviatrix.NewAviatrixAwsTgwPeering(ctx, "aviatrixAwsTgwPeeringResource", &aviatrix.AviatrixAwsTgwPeeringArgs{
	TgwName1: pulumi.String("string"),
	TgwName2: pulumi.String("string"),
})
Copy
var aviatrixAwsTgwPeeringResource = new AviatrixAwsTgwPeering("aviatrixAwsTgwPeeringResource", AviatrixAwsTgwPeeringArgs.builder()
    .tgwName1("string")
    .tgwName2("string")
    .build());
Copy
aviatrix_aws_tgw_peering_resource = aviatrix.AviatrixAwsTgwPeering("aviatrixAwsTgwPeeringResource",
    tgw_name1="string",
    tgw_name2="string")
Copy
const aviatrixAwsTgwPeeringResource = new aviatrix.AviatrixAwsTgwPeering("aviatrixAwsTgwPeeringResource", {
    tgwName1: "string",
    tgwName2: "string",
});
Copy
type: aviatrix:AviatrixAwsTgwPeering
properties:
    tgwName1: string
    tgwName2: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AviatrixAwsTgwPeering resource accepts the following input properties:

TgwName1
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents name of the first AWS TGW to make a peer pair.
TgwName2
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents name of the second AWS TGW to make a peer pair.
TgwName1
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents name of the first AWS TGW to make a peer pair.
TgwName2
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents name of the second AWS TGW to make a peer pair.
tgwName1
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents name of the first AWS TGW to make a peer pair.
tgwName2
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents name of the second AWS TGW to make a peer pair.
tgwName1
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents name of the first AWS TGW to make a peer pair.
tgwName2
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents name of the second AWS TGW to make a peer pair.
tgw_name1
This property is required.
Changes to this property will trigger replacement.
str
This parameter represents name of the first AWS TGW to make a peer pair.
tgw_name2
This property is required.
Changes to this property will trigger replacement.
str
This parameter represents name of the second AWS TGW to make a peer pair.
tgwName1
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents name of the first AWS TGW to make a peer pair.
tgwName2
This property is required.
Changes to this property will trigger replacement.
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)
resources:  _:    type: aviatrix:AviatrixAwsTgwPeering    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
This parameter represents name of the first AWS TGW to make a peer pair.
TgwName2 Changes to this property will trigger replacement. string
This parameter represents name of the second AWS TGW to make a peer pair.
TgwName1 Changes to this property will trigger replacement. string
This parameter represents name of the first AWS TGW to make a peer pair.
TgwName2 Changes to this property will trigger replacement. string
This parameter represents name of the second AWS TGW to make a peer pair.
tgwName1 Changes to this property will trigger replacement. String
This parameter represents name of the first AWS TGW to make a peer pair.
tgwName2 Changes to this property will trigger replacement. String
This parameter represents name of the second AWS TGW to make a peer pair.
tgwName1 Changes to this property will trigger replacement. string
This parameter represents name of the first AWS TGW to make a peer pair.
tgwName2 Changes to this property will trigger replacement. string
This parameter represents name of the second AWS TGW to make a peer pair.
tgw_name1 Changes to this property will trigger replacement. str
This parameter represents name of the first AWS TGW to make a peer pair.
tgw_name2 Changes to this property will trigger replacement. str
This parameter represents name of the second AWS TGW to make a peer pair.
tgwName1 Changes to this property will trigger replacement. String
This parameter represents name of the first AWS TGW to make a peer pair.
tgwName2 Changes to this property will trigger replacement. 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
Copy

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 v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix