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

aviatrix.AviatrixAwsTgwConnectPeer

Explore with Pulumi AI

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

    The aviatrix_aws_tgw_connect_peer resource allows the creation and management of AWS TGW Connect peers. This resource is available as of provider version R2.18.1+.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix AWS TGW Connect Peer
        var test = new Aviatrix.AviatrixAwsTgwConnectPeer("test", new()
        {
            TgwName = aviatrix_aws_tgw.Test_aws_tgw.Tgw_name,
            ConnectionName = aviatrix_aws_tgw_connect.Test_aws_tgw_connect.Connection_name,
            ConnectPeerName = "connect-peer-test",
            ConnectAttachmentId = aviatrix_aws_tgw_connect.Test_aws_tgw_connect.Connect_attachment_id,
            PeerAsNumber = "65001",
            PeerGreAddress = "172.31.1.11",
            BgpInsideCidrs = new[]
            {
                "169.254.6.0/29",
            },
            TgwGreAddress = "10.0.0.32",
        });
    
    });
    
    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.NewAviatrixAwsTgwConnectPeer(ctx, "test", &aviatrix.AviatrixAwsTgwConnectPeerArgs{
    			TgwName:             pulumi.Any(aviatrix_aws_tgw.Test_aws_tgw.Tgw_name),
    			ConnectionName:      pulumi.Any(aviatrix_aws_tgw_connect.Test_aws_tgw_connect.Connection_name),
    			ConnectPeerName:     pulumi.String("connect-peer-test"),
    			ConnectAttachmentId: pulumi.Any(aviatrix_aws_tgw_connect.Test_aws_tgw_connect.Connect_attachment_id),
    			PeerAsNumber:        pulumi.String("65001"),
    			PeerGreAddress:      pulumi.String("172.31.1.11"),
    			BgpInsideCidrs: pulumi.StringArray{
    				pulumi.String("169.254.6.0/29"),
    			},
    			TgwGreAddress: pulumi.String("10.0.0.32"),
    		})
    		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.AviatrixAwsTgwConnectPeer;
    import com.pulumi.aviatrix.AviatrixAwsTgwConnectPeerArgs;
    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 AviatrixAwsTgwConnectPeer("test", AviatrixAwsTgwConnectPeerArgs.builder()        
                .tgwName(aviatrix_aws_tgw.test_aws_tgw().tgw_name())
                .connectionName(aviatrix_aws_tgw_connect.test_aws_tgw_connect().connection_name())
                .connectPeerName("connect-peer-test")
                .connectAttachmentId(aviatrix_aws_tgw_connect.test_aws_tgw_connect().connect_attachment_id())
                .peerAsNumber("65001")
                .peerGreAddress("172.31.1.11")
                .bgpInsideCidrs("169.254.6.0/29")
                .tgwGreAddress("10.0.0.32")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix AWS TGW Connect Peer
    test = aviatrix.AviatrixAwsTgwConnectPeer("test",
        tgw_name=aviatrix_aws_tgw["test_aws_tgw"]["tgw_name"],
        connection_name=aviatrix_aws_tgw_connect["test_aws_tgw_connect"]["connection_name"],
        connect_peer_name="connect-peer-test",
        connect_attachment_id=aviatrix_aws_tgw_connect["test_aws_tgw_connect"]["connect_attachment_id"],
        peer_as_number="65001",
        peer_gre_address="172.31.1.11",
        bgp_inside_cidrs=["169.254.6.0/29"],
        tgw_gre_address="10.0.0.32")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@astipkovits/aviatrix";
    
    // Create an Aviatrix AWS TGW Connect Peer
    const test = new aviatrix.AviatrixAwsTgwConnectPeer("test", {
        tgwName: aviatrix_aws_tgw.test_aws_tgw.tgw_name,
        connectionName: aviatrix_aws_tgw_connect.test_aws_tgw_connect.connection_name,
        connectPeerName: "connect-peer-test",
        connectAttachmentId: aviatrix_aws_tgw_connect.test_aws_tgw_connect.connect_attachment_id,
        peerAsNumber: "65001",
        peerGreAddress: "172.31.1.11",
        bgpInsideCidrs: ["169.254.6.0/29"],
        tgwGreAddress: "10.0.0.32",
    });
    
    resources:
      # Create an Aviatrix AWS TGW Connect Peer
      test:
        type: aviatrix:AviatrixAwsTgwConnectPeer
        properties:
          tgwName: ${aviatrix_aws_tgw.test_aws_tgw.tgw_name}
          connectionName: ${aviatrix_aws_tgw_connect.test_aws_tgw_connect.connection_name}
          connectPeerName: connect-peer-test
          connectAttachmentId: ${aviatrix_aws_tgw_connect.test_aws_tgw_connect.connect_attachment_id}
          peerAsNumber: '65001'
          peerGreAddress: 172.31.1.11
          bgpInsideCidrs:
            - 169.254.6.0/29
          tgwGreAddress: 10.0.0.32
    

    Create AviatrixAwsTgwConnectPeer Resource

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

    Constructor syntax

    new AviatrixAwsTgwConnectPeer(name: string, args: AviatrixAwsTgwConnectPeerArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixAwsTgwConnectPeer(resource_name: str,
                                  args: AviatrixAwsTgwConnectPeerArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixAwsTgwConnectPeer(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  bgp_inside_cidrs: Optional[Sequence[str]] = None,
                                  connect_attachment_id: Optional[str] = None,
                                  connect_peer_name: Optional[str] = None,
                                  connection_name: Optional[str] = None,
                                  peer_as_number: Optional[str] = None,
                                  peer_gre_address: Optional[str] = None,
                                  tgw_name: Optional[str] = None,
                                  tgw_gre_address: Optional[str] = None)
    func NewAviatrixAwsTgwConnectPeer(ctx *Context, name string, args AviatrixAwsTgwConnectPeerArgs, opts ...ResourceOption) (*AviatrixAwsTgwConnectPeer, error)
    public AviatrixAwsTgwConnectPeer(string name, AviatrixAwsTgwConnectPeerArgs args, CustomResourceOptions? opts = null)
    public AviatrixAwsTgwConnectPeer(String name, AviatrixAwsTgwConnectPeerArgs args)
    public AviatrixAwsTgwConnectPeer(String name, AviatrixAwsTgwConnectPeerArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixAwsTgwConnectPeer
    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 AviatrixAwsTgwConnectPeerArgs
    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 AviatrixAwsTgwConnectPeerArgs
    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 AviatrixAwsTgwConnectPeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAwsTgwConnectPeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixAwsTgwConnectPeerArgs
    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 aviatrixAwsTgwConnectPeerResource = new Aviatrix.AviatrixAwsTgwConnectPeer("aviatrixAwsTgwConnectPeerResource", new()
    {
        BgpInsideCidrs = new[]
        {
            "string",
        },
        ConnectAttachmentId = "string",
        ConnectPeerName = "string",
        ConnectionName = "string",
        PeerAsNumber = "string",
        PeerGreAddress = "string",
        TgwName = "string",
        TgwGreAddress = "string",
    });
    
    example, err := aviatrix.NewAviatrixAwsTgwConnectPeer(ctx, "aviatrixAwsTgwConnectPeerResource", &aviatrix.AviatrixAwsTgwConnectPeerArgs{
    	BgpInsideCidrs: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ConnectAttachmentId: pulumi.String("string"),
    	ConnectPeerName:     pulumi.String("string"),
    	ConnectionName:      pulumi.String("string"),
    	PeerAsNumber:        pulumi.String("string"),
    	PeerGreAddress:      pulumi.String("string"),
    	TgwName:             pulumi.String("string"),
    	TgwGreAddress:       pulumi.String("string"),
    })
    
    var aviatrixAwsTgwConnectPeerResource = new AviatrixAwsTgwConnectPeer("aviatrixAwsTgwConnectPeerResource", AviatrixAwsTgwConnectPeerArgs.builder()
        .bgpInsideCidrs("string")
        .connectAttachmentId("string")
        .connectPeerName("string")
        .connectionName("string")
        .peerAsNumber("string")
        .peerGreAddress("string")
        .tgwName("string")
        .tgwGreAddress("string")
        .build());
    
    aviatrix_aws_tgw_connect_peer_resource = aviatrix.AviatrixAwsTgwConnectPeer("aviatrixAwsTgwConnectPeerResource",
        bgp_inside_cidrs=["string"],
        connect_attachment_id="string",
        connect_peer_name="string",
        connection_name="string",
        peer_as_number="string",
        peer_gre_address="string",
        tgw_name="string",
        tgw_gre_address="string")
    
    const aviatrixAwsTgwConnectPeerResource = new aviatrix.AviatrixAwsTgwConnectPeer("aviatrixAwsTgwConnectPeerResource", {
        bgpInsideCidrs: ["string"],
        connectAttachmentId: "string",
        connectPeerName: "string",
        connectionName: "string",
        peerAsNumber: "string",
        peerGreAddress: "string",
        tgwName: "string",
        tgwGreAddress: "string",
    });
    
    type: aviatrix:AviatrixAwsTgwConnectPeer
    properties:
        bgpInsideCidrs:
            - string
        connectAttachmentId: string
        connectPeerName: string
        connectionName: string
        peerAsNumber: string
        peerGreAddress: string
        tgwGreAddress: string
        tgwName: string
    

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

    BgpInsideCidrs List<string>
    Set of BGP Inside CIDR Block(s).
    ConnectAttachmentId string
    Connect Attachment ID.
    ConnectPeerName string
    TGW Connect peer name.
    ConnectionName string
    TGW Connect connection name.
    PeerAsNumber string
    Peer AS Number.
    PeerGreAddress string
    Peer GRE IP Address.
    TgwName string
    AWS TGW name.
    TgwGreAddress string
    AWS TGW GRE IP Address.
    BgpInsideCidrs []string
    Set of BGP Inside CIDR Block(s).
    ConnectAttachmentId string
    Connect Attachment ID.
    ConnectPeerName string
    TGW Connect peer name.
    ConnectionName string
    TGW Connect connection name.
    PeerAsNumber string
    Peer AS Number.
    PeerGreAddress string
    Peer GRE IP Address.
    TgwName string
    AWS TGW name.
    TgwGreAddress string
    AWS TGW GRE IP Address.
    bgpInsideCidrs List<String>
    Set of BGP Inside CIDR Block(s).
    connectAttachmentId String
    Connect Attachment ID.
    connectPeerName String
    TGW Connect peer name.
    connectionName String
    TGW Connect connection name.
    peerAsNumber String
    Peer AS Number.
    peerGreAddress String
    Peer GRE IP Address.
    tgwName String
    AWS TGW name.
    tgwGreAddress String
    AWS TGW GRE IP Address.
    bgpInsideCidrs string[]
    Set of BGP Inside CIDR Block(s).
    connectAttachmentId string
    Connect Attachment ID.
    connectPeerName string
    TGW Connect peer name.
    connectionName string
    TGW Connect connection name.
    peerAsNumber string
    Peer AS Number.
    peerGreAddress string
    Peer GRE IP Address.
    tgwName string
    AWS TGW name.
    tgwGreAddress string
    AWS TGW GRE IP Address.
    bgp_inside_cidrs Sequence[str]
    Set of BGP Inside CIDR Block(s).
    connect_attachment_id str
    Connect Attachment ID.
    connect_peer_name str
    TGW Connect peer name.
    connection_name str
    TGW Connect connection name.
    peer_as_number str
    Peer AS Number.
    peer_gre_address str
    Peer GRE IP Address.
    tgw_name str
    AWS TGW name.
    tgw_gre_address str
    AWS TGW GRE IP Address.
    bgpInsideCidrs List<String>
    Set of BGP Inside CIDR Block(s).
    connectAttachmentId String
    Connect Attachment ID.
    connectPeerName String
    TGW Connect peer name.
    connectionName String
    TGW Connect connection name.
    peerAsNumber String
    Peer AS Number.
    peerGreAddress String
    Peer GRE IP Address.
    tgwName String
    AWS TGW name.
    tgwGreAddress String
    AWS TGW GRE IP Address.

    Outputs

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

    ConnectPeerId string
    Connect Peer ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConnectPeerId string
    Connect Peer ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    connectPeerId String
    Connect Peer ID.
    id String
    The provider-assigned unique ID for this managed resource.
    connectPeerId string
    Connect Peer ID.
    id string
    The provider-assigned unique ID for this managed resource.
    connect_peer_id str
    Connect Peer ID.
    id str
    The provider-assigned unique ID for this managed resource.
    connectPeerId String
    Connect Peer ID.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AviatrixAwsTgwConnectPeer Resource

    Get an existing AviatrixAwsTgwConnectPeer 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?: AviatrixAwsTgwConnectPeerState, opts?: CustomResourceOptions): AviatrixAwsTgwConnectPeer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bgp_inside_cidrs: Optional[Sequence[str]] = None,
            connect_attachment_id: Optional[str] = None,
            connect_peer_id: Optional[str] = None,
            connect_peer_name: Optional[str] = None,
            connection_name: Optional[str] = None,
            peer_as_number: Optional[str] = None,
            peer_gre_address: Optional[str] = None,
            tgw_gre_address: Optional[str] = None,
            tgw_name: Optional[str] = None) -> AviatrixAwsTgwConnectPeer
    func GetAviatrixAwsTgwConnectPeer(ctx *Context, name string, id IDInput, state *AviatrixAwsTgwConnectPeerState, opts ...ResourceOption) (*AviatrixAwsTgwConnectPeer, error)
    public static AviatrixAwsTgwConnectPeer Get(string name, Input<string> id, AviatrixAwsTgwConnectPeerState? state, CustomResourceOptions? opts = null)
    public static AviatrixAwsTgwConnectPeer get(String name, Output<String> id, AviatrixAwsTgwConnectPeerState 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:
    BgpInsideCidrs List<string>
    Set of BGP Inside CIDR Block(s).
    ConnectAttachmentId string
    Connect Attachment ID.
    ConnectPeerId string
    Connect Peer ID.
    ConnectPeerName string
    TGW Connect peer name.
    ConnectionName string
    TGW Connect connection name.
    PeerAsNumber string
    Peer AS Number.
    PeerGreAddress string
    Peer GRE IP Address.
    TgwGreAddress string
    AWS TGW GRE IP Address.
    TgwName string
    AWS TGW name.
    BgpInsideCidrs []string
    Set of BGP Inside CIDR Block(s).
    ConnectAttachmentId string
    Connect Attachment ID.
    ConnectPeerId string
    Connect Peer ID.
    ConnectPeerName string
    TGW Connect peer name.
    ConnectionName string
    TGW Connect connection name.
    PeerAsNumber string
    Peer AS Number.
    PeerGreAddress string
    Peer GRE IP Address.
    TgwGreAddress string
    AWS TGW GRE IP Address.
    TgwName string
    AWS TGW name.
    bgpInsideCidrs List<String>
    Set of BGP Inside CIDR Block(s).
    connectAttachmentId String
    Connect Attachment ID.
    connectPeerId String
    Connect Peer ID.
    connectPeerName String
    TGW Connect peer name.
    connectionName String
    TGW Connect connection name.
    peerAsNumber String
    Peer AS Number.
    peerGreAddress String
    Peer GRE IP Address.
    tgwGreAddress String
    AWS TGW GRE IP Address.
    tgwName String
    AWS TGW name.
    bgpInsideCidrs string[]
    Set of BGP Inside CIDR Block(s).
    connectAttachmentId string
    Connect Attachment ID.
    connectPeerId string
    Connect Peer ID.
    connectPeerName string
    TGW Connect peer name.
    connectionName string
    TGW Connect connection name.
    peerAsNumber string
    Peer AS Number.
    peerGreAddress string
    Peer GRE IP Address.
    tgwGreAddress string
    AWS TGW GRE IP Address.
    tgwName string
    AWS TGW name.
    bgp_inside_cidrs Sequence[str]
    Set of BGP Inside CIDR Block(s).
    connect_attachment_id str
    Connect Attachment ID.
    connect_peer_id str
    Connect Peer ID.
    connect_peer_name str
    TGW Connect peer name.
    connection_name str
    TGW Connect connection name.
    peer_as_number str
    Peer AS Number.
    peer_gre_address str
    Peer GRE IP Address.
    tgw_gre_address str
    AWS TGW GRE IP Address.
    tgw_name str
    AWS TGW name.
    bgpInsideCidrs List<String>
    Set of BGP Inside CIDR Block(s).
    connectAttachmentId String
    Connect Attachment ID.
    connectPeerId String
    Connect Peer ID.
    connectPeerName String
    TGW Connect peer name.
    connectionName String
    TGW Connect connection name.
    peerAsNumber String
    Peer AS Number.
    peerGreAddress String
    Peer GRE IP Address.
    tgwGreAddress String
    AWS TGW GRE IP Address.
    tgwName String
    AWS TGW name.

    Import

    aws_tgw_connect_peer can be imported using the tgw_name, connection_name and connect_peer_name, e.g.

     $ pulumi import aviatrix:index/aviatrixAwsTgwConnectPeer:AviatrixAwsTgwConnectPeer test tgw_name~~connection_name~~connect_peer_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