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

aviatrix.AviatrixAwsTgwDirectconnect

Explore with Pulumi AI

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

    The aviatrix_aws_tgw_directconnect resource allows the creation and management of Aviatrix-created AWS TGW DirectConnect connections.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix AWS TGW Directconnect
        var testAwsTgwDirectconnect = new Aviatrix.AviatrixAwsTgwDirectconnect("testAwsTgwDirectconnect", new()
        {
            AllowedPrefix = "10.12.0.0/24",
            DirectconnectAccountName = "username",
            DxGatewayId = "30321d76-dd01-49bf",
            NetworkDomainName = "my-ndn-1",
            TgwName = "my-aws-tgw-1",
        });
    
    });
    
    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.NewAviatrixAwsTgwDirectconnect(ctx, "testAwsTgwDirectconnect", &aviatrix.AviatrixAwsTgwDirectconnectArgs{
    			AllowedPrefix:            pulumi.String("10.12.0.0/24"),
    			DirectconnectAccountName: pulumi.String("username"),
    			DxGatewayId:              pulumi.String("30321d76-dd01-49bf"),
    			NetworkDomainName:        pulumi.String("my-ndn-1"),
    			TgwName:                  pulumi.String("my-aws-tgw-1"),
    		})
    		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.AviatrixAwsTgwDirectconnect;
    import com.pulumi.aviatrix.AviatrixAwsTgwDirectconnectArgs;
    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 testAwsTgwDirectconnect = new AviatrixAwsTgwDirectconnect("testAwsTgwDirectconnect", AviatrixAwsTgwDirectconnectArgs.builder()        
                .allowedPrefix("10.12.0.0/24")
                .directconnectAccountName("username")
                .dxGatewayId("30321d76-dd01-49bf")
                .networkDomainName("my-ndn-1")
                .tgwName("my-aws-tgw-1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix AWS TGW Directconnect
    test_aws_tgw_directconnect = aviatrix.AviatrixAwsTgwDirectconnect("testAwsTgwDirectconnect",
        allowed_prefix="10.12.0.0/24",
        directconnect_account_name="username",
        dx_gateway_id="30321d76-dd01-49bf",
        network_domain_name="my-ndn-1",
        tgw_name="my-aws-tgw-1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Aviatrix AWS TGW Directconnect
    const testAwsTgwDirectconnect = new aviatrix.AviatrixAwsTgwDirectconnect("test_aws_tgw_directconnect", {
        allowedPrefix: "10.12.0.0/24",
        directconnectAccountName: "username",
        dxGatewayId: "30321d76-dd01-49bf",
        networkDomainName: "my-ndn-1",
        tgwName: "my-aws-tgw-1",
    });
    
    resources:
      # Create an Aviatrix AWS TGW Directconnect
      testAwsTgwDirectconnect:
        type: aviatrix:AviatrixAwsTgwDirectconnect
        properties:
          allowedPrefix: 10.12.0.0/24
          directconnectAccountName: username
          dxGatewayId: 30321d76-dd01-49bf
          networkDomainName: my-ndn-1
          tgwName: my-aws-tgw-1
    

    Create AviatrixAwsTgwDirectconnect Resource

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

    Constructor syntax

    new AviatrixAwsTgwDirectconnect(name: string, args: AviatrixAwsTgwDirectconnectArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixAwsTgwDirectconnect(resource_name: str,
                                    args: AviatrixAwsTgwDirectconnectArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixAwsTgwDirectconnect(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    allowed_prefix: Optional[str] = None,
                                    directconnect_account_name: Optional[str] = None,
                                    dx_gateway_id: Optional[str] = None,
                                    tgw_name: Optional[str] = None,
                                    enable_learned_cidrs_approval: Optional[bool] = None,
                                    network_domain_name: Optional[str] = None,
                                    security_domain_name: Optional[str] = None)
    func NewAviatrixAwsTgwDirectconnect(ctx *Context, name string, args AviatrixAwsTgwDirectconnectArgs, opts ...ResourceOption) (*AviatrixAwsTgwDirectconnect, error)
    public AviatrixAwsTgwDirectconnect(string name, AviatrixAwsTgwDirectconnectArgs args, CustomResourceOptions? opts = null)
    public AviatrixAwsTgwDirectconnect(String name, AviatrixAwsTgwDirectconnectArgs args)
    public AviatrixAwsTgwDirectconnect(String name, AviatrixAwsTgwDirectconnectArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixAwsTgwDirectconnect
    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 AviatrixAwsTgwDirectconnectArgs
    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 AviatrixAwsTgwDirectconnectArgs
    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 AviatrixAwsTgwDirectconnectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAwsTgwDirectconnectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixAwsTgwDirectconnectArgs
    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 aviatrixAwsTgwDirectconnectResource = new Aviatrix.AviatrixAwsTgwDirectconnect("aviatrixAwsTgwDirectconnectResource", new()
    {
        AllowedPrefix = "string",
        DirectconnectAccountName = "string",
        DxGatewayId = "string",
        TgwName = "string",
        EnableLearnedCidrsApproval = false,
        NetworkDomainName = "string",
    });
    
    example, err := aviatrix.NewAviatrixAwsTgwDirectconnect(ctx, "aviatrixAwsTgwDirectconnectResource", &aviatrix.AviatrixAwsTgwDirectconnectArgs{
    	AllowedPrefix:              pulumi.String("string"),
    	DirectconnectAccountName:   pulumi.String("string"),
    	DxGatewayId:                pulumi.String("string"),
    	TgwName:                    pulumi.String("string"),
    	EnableLearnedCidrsApproval: pulumi.Bool(false),
    	NetworkDomainName:          pulumi.String("string"),
    })
    
    var aviatrixAwsTgwDirectconnectResource = new AviatrixAwsTgwDirectconnect("aviatrixAwsTgwDirectconnectResource", AviatrixAwsTgwDirectconnectArgs.builder()
        .allowedPrefix("string")
        .directconnectAccountName("string")
        .dxGatewayId("string")
        .tgwName("string")
        .enableLearnedCidrsApproval(false)
        .networkDomainName("string")
        .build());
    
    aviatrix_aws_tgw_directconnect_resource = aviatrix.AviatrixAwsTgwDirectconnect("aviatrixAwsTgwDirectconnectResource",
        allowed_prefix="string",
        directconnect_account_name="string",
        dx_gateway_id="string",
        tgw_name="string",
        enable_learned_cidrs_approval=False,
        network_domain_name="string")
    
    const aviatrixAwsTgwDirectconnectResource = new aviatrix.AviatrixAwsTgwDirectconnect("aviatrixAwsTgwDirectconnectResource", {
        allowedPrefix: "string",
        directconnectAccountName: "string",
        dxGatewayId: "string",
        tgwName: "string",
        enableLearnedCidrsApproval: false,
        networkDomainName: "string",
    });
    
    type: aviatrix:AviatrixAwsTgwDirectconnect
    properties:
        allowedPrefix: string
        directconnectAccountName: string
        dxGatewayId: string
        enableLearnedCidrsApproval: false
        networkDomainName: string
        tgwName: string
    

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

    AllowedPrefix string
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    DirectconnectAccountName string
    This parameter represents the name of an Account in Aviatrix controller.
    DxGatewayId string
    This parameter represents the name of a Direct Connect Gateway ID.
    TgwName string
    This parameter represents the name of an AWS TGW.
    EnableLearnedCidrsApproval bool
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    NetworkDomainName string
    The name of a network domain, to which the direct connect gateway will be attached.
    SecurityDomainName string
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    AllowedPrefix string
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    DirectconnectAccountName string
    This parameter represents the name of an Account in Aviatrix controller.
    DxGatewayId string
    This parameter represents the name of a Direct Connect Gateway ID.
    TgwName string
    This parameter represents the name of an AWS TGW.
    EnableLearnedCidrsApproval bool
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    NetworkDomainName string
    The name of a network domain, to which the direct connect gateway will be attached.
    SecurityDomainName string
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    allowedPrefix String
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnectAccountName String
    This parameter represents the name of an Account in Aviatrix controller.
    dxGatewayId String
    This parameter represents the name of a Direct Connect Gateway ID.
    tgwName String
    This parameter represents the name of an AWS TGW.
    enableLearnedCidrsApproval Boolean
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    networkDomainName String
    The name of a network domain, to which the direct connect gateway will be attached.
    securityDomainName String
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    allowedPrefix string
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnectAccountName string
    This parameter represents the name of an Account in Aviatrix controller.
    dxGatewayId string
    This parameter represents the name of a Direct Connect Gateway ID.
    tgwName string
    This parameter represents the name of an AWS TGW.
    enableLearnedCidrsApproval boolean
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    networkDomainName string
    The name of a network domain, to which the direct connect gateway will be attached.
    securityDomainName string
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    allowed_prefix str
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnect_account_name str
    This parameter represents the name of an Account in Aviatrix controller.
    dx_gateway_id str
    This parameter represents the name of a Direct Connect Gateway ID.
    tgw_name str
    This parameter represents the name of an AWS TGW.
    enable_learned_cidrs_approval bool
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    network_domain_name str
    The name of a network domain, to which the direct connect gateway will be attached.
    security_domain_name str
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    allowedPrefix String
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnectAccountName String
    This parameter represents the name of an Account in Aviatrix controller.
    dxGatewayId String
    This parameter represents the name of a Direct Connect Gateway ID.
    tgwName String
    This parameter represents the name of an AWS TGW.
    enableLearnedCidrsApproval Boolean
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    networkDomainName String
    The name of a network domain, to which the direct connect gateway will be attached.
    securityDomainName String
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    Outputs

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

    Get an existing AviatrixAwsTgwDirectconnect 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?: AviatrixAwsTgwDirectconnectState, opts?: CustomResourceOptions): AviatrixAwsTgwDirectconnect
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allowed_prefix: Optional[str] = None,
            directconnect_account_name: Optional[str] = None,
            dx_gateway_id: Optional[str] = None,
            enable_learned_cidrs_approval: Optional[bool] = None,
            network_domain_name: Optional[str] = None,
            security_domain_name: Optional[str] = None,
            tgw_name: Optional[str] = None) -> AviatrixAwsTgwDirectconnect
    func GetAviatrixAwsTgwDirectconnect(ctx *Context, name string, id IDInput, state *AviatrixAwsTgwDirectconnectState, opts ...ResourceOption) (*AviatrixAwsTgwDirectconnect, error)
    public static AviatrixAwsTgwDirectconnect Get(string name, Input<string> id, AviatrixAwsTgwDirectconnectState? state, CustomResourceOptions? opts = null)
    public static AviatrixAwsTgwDirectconnect get(String name, Output<String> id, AviatrixAwsTgwDirectconnectState 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:
    AllowedPrefix string
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    DirectconnectAccountName string
    This parameter represents the name of an Account in Aviatrix controller.
    DxGatewayId string
    This parameter represents the name of a Direct Connect Gateway ID.
    EnableLearnedCidrsApproval bool
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    NetworkDomainName string
    The name of a network domain, to which the direct connect gateway will be attached.
    SecurityDomainName string
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    TgwName string
    This parameter represents the name of an AWS TGW.
    AllowedPrefix string
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    DirectconnectAccountName string
    This parameter represents the name of an Account in Aviatrix controller.
    DxGatewayId string
    This parameter represents the name of a Direct Connect Gateway ID.
    EnableLearnedCidrsApproval bool
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    NetworkDomainName string
    The name of a network domain, to which the direct connect gateway will be attached.
    SecurityDomainName string
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    TgwName string
    This parameter represents the name of an AWS TGW.
    allowedPrefix String
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnectAccountName String
    This parameter represents the name of an Account in Aviatrix controller.
    dxGatewayId String
    This parameter represents the name of a Direct Connect Gateway ID.
    enableLearnedCidrsApproval Boolean
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    networkDomainName String
    The name of a network domain, to which the direct connect gateway will be attached.
    securityDomainName String
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    tgwName String
    This parameter represents the name of an AWS TGW.
    allowedPrefix string
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnectAccountName string
    This parameter represents the name of an Account in Aviatrix controller.
    dxGatewayId string
    This parameter represents the name of a Direct Connect Gateway ID.
    enableLearnedCidrsApproval boolean
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    networkDomainName string
    The name of a network domain, to which the direct connect gateway will be attached.
    securityDomainName string
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    tgwName string
    This parameter represents the name of an AWS TGW.
    allowed_prefix str
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnect_account_name str
    This parameter represents the name of an Account in Aviatrix controller.
    dx_gateway_id str
    This parameter represents the name of a Direct Connect Gateway ID.
    enable_learned_cidrs_approval bool
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    network_domain_name str
    The name of a network domain, to which the direct connect gateway will be attached.
    security_domain_name str
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    tgw_name str
    This parameter represents the name of an AWS TGW.
    allowedPrefix String
    A list of comma separated CIDRs for DXGW to advertise to remote(on-prem).
    directconnectAccountName String
    This parameter represents the name of an Account in Aviatrix controller.
    dxGatewayId String
    This parameter represents the name of a Direct Connect Gateway ID.
    enableLearnedCidrsApproval Boolean
    Switch to enable/disable encrypted transit approval for AWS TGW DirectConnect. Valid values: true, false. Default value: false.
    networkDomainName String
    The name of a network domain, to which the direct connect gateway will be attached.
    securityDomainName String
    The name of a security domain, to which the direct connect gateway will be attached.

    Deprecated: Please use network_domain_name instead.

    tgwName String
    This parameter represents the name of an AWS TGW.

    Import

    aws_tgw_directconnect can be imported using the tgw_name and dx_gateway_id, e.g.

     $ pulumi import aviatrix:index/aviatrixAwsTgwDirectconnect:AviatrixAwsTgwDirectconnect test tgw_name~dx_gateway_id
    

    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