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

aviatrix.AviatrixTransPeer

Explore with Pulumi AI

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

    The aviatrix_trans_peer resource allows the creation and management of Aviatrix Encrypted Transitive Peering.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix AWS Transitive Peering
        var testTransPeer = new Aviatrix.AviatrixTransPeer("testTransPeer", new()
        {
            Nexthop = "avtx-us-east-gw2",
            ReachableCidr = "10.152.0.0/16",
            Source = "avtx-us-east-gw1",
        });
    
    });
    
    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.NewAviatrixTransPeer(ctx, "testTransPeer", &aviatrix.AviatrixTransPeerArgs{
    			Nexthop:       pulumi.String("avtx-us-east-gw2"),
    			ReachableCidr: pulumi.String("10.152.0.0/16"),
    			Source:        pulumi.String("avtx-us-east-gw1"),
    		})
    		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.AviatrixTransPeer;
    import com.pulumi.aviatrix.AviatrixTransPeerArgs;
    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 testTransPeer = new AviatrixTransPeer("testTransPeer", AviatrixTransPeerArgs.builder()        
                .nexthop("avtx-us-east-gw2")
                .reachableCidr("10.152.0.0/16")
                .source("avtx-us-east-gw1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix AWS Transitive Peering
    test_trans_peer = aviatrix.AviatrixTransPeer("testTransPeer",
        nexthop="avtx-us-east-gw2",
        reachable_cidr="10.152.0.0/16",
        source="avtx-us-east-gw1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Aviatrix AWS Transitive Peering
    const testTransPeer = new aviatrix.AviatrixTransPeer("test_trans_peer", {
        nexthop: "avtx-us-east-gw2",
        reachableCidr: "10.152.0.0/16",
        source: "avtx-us-east-gw1",
    });
    
    resources:
      # Create an Aviatrix AWS Transitive Peering
      testTransPeer:
        type: aviatrix:AviatrixTransPeer
        properties:
          nexthop: avtx-us-east-gw2
          reachableCidr: 10.152.0.0/16
          source: avtx-us-east-gw1
    

    Create AviatrixTransPeer Resource

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

    Constructor syntax

    new AviatrixTransPeer(name: string, args: AviatrixTransPeerArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixTransPeer(resource_name: str,
                          args: AviatrixTransPeerArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixTransPeer(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          nexthop: Optional[str] = None,
                          reachable_cidr: Optional[str] = None,
                          source: Optional[str] = None)
    func NewAviatrixTransPeer(ctx *Context, name string, args AviatrixTransPeerArgs, opts ...ResourceOption) (*AviatrixTransPeer, error)
    public AviatrixTransPeer(string name, AviatrixTransPeerArgs args, CustomResourceOptions? opts = null)
    public AviatrixTransPeer(String name, AviatrixTransPeerArgs args)
    public AviatrixTransPeer(String name, AviatrixTransPeerArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixTransPeer
    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 AviatrixTransPeerArgs
    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 AviatrixTransPeerArgs
    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 AviatrixTransPeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixTransPeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixTransPeerArgs
    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 aviatrixTransPeerResource = new Aviatrix.AviatrixTransPeer("aviatrixTransPeerResource", new()
    {
        Nexthop = "string",
        ReachableCidr = "string",
        Source = "string",
    });
    
    example, err := aviatrix.NewAviatrixTransPeer(ctx, "aviatrixTransPeerResource", &aviatrix.AviatrixTransPeerArgs{
    	Nexthop:       pulumi.String("string"),
    	ReachableCidr: pulumi.String("string"),
    	Source:        pulumi.String("string"),
    })
    
    var aviatrixTransPeerResource = new AviatrixTransPeer("aviatrixTransPeerResource", AviatrixTransPeerArgs.builder()
        .nexthop("string")
        .reachableCidr("string")
        .source("string")
        .build());
    
    aviatrix_trans_peer_resource = aviatrix.AviatrixTransPeer("aviatrixTransPeerResource",
        nexthop="string",
        reachable_cidr="string",
        source="string")
    
    const aviatrixTransPeerResource = new aviatrix.AviatrixTransPeer("aviatrixTransPeerResource", {
        nexthop: "string",
        reachableCidr: "string",
        source: "string",
    });
    
    type: aviatrix:AviatrixTransPeer
    properties:
        nexthop: string
        reachableCidr: string
        source: string
    

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

    Nexthop string
    Name of nexthop gateway.
    ReachableCidr string
    Destination CIDR.
    Source string
    Name of Source gateway.
    Nexthop string
    Name of nexthop gateway.
    ReachableCidr string
    Destination CIDR.
    Source string
    Name of Source gateway.
    nexthop String
    Name of nexthop gateway.
    reachableCidr String
    Destination CIDR.
    source String
    Name of Source gateway.
    nexthop string
    Name of nexthop gateway.
    reachableCidr string
    Destination CIDR.
    source string
    Name of Source gateway.
    nexthop str
    Name of nexthop gateway.
    reachable_cidr str
    Destination CIDR.
    source str
    Name of Source gateway.
    nexthop String
    Name of nexthop gateway.
    reachableCidr String
    Destination CIDR.
    source String
    Name of Source gateway.

    Outputs

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

    Get an existing AviatrixTransPeer 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?: AviatrixTransPeerState, opts?: CustomResourceOptions): AviatrixTransPeer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            nexthop: Optional[str] = None,
            reachable_cidr: Optional[str] = None,
            source: Optional[str] = None) -> AviatrixTransPeer
    func GetAviatrixTransPeer(ctx *Context, name string, id IDInput, state *AviatrixTransPeerState, opts ...ResourceOption) (*AviatrixTransPeer, error)
    public static AviatrixTransPeer Get(string name, Input<string> id, AviatrixTransPeerState? state, CustomResourceOptions? opts = null)
    public static AviatrixTransPeer get(String name, Output<String> id, AviatrixTransPeerState 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:
    Nexthop string
    Name of nexthop gateway.
    ReachableCidr string
    Destination CIDR.
    Source string
    Name of Source gateway.
    Nexthop string
    Name of nexthop gateway.
    ReachableCidr string
    Destination CIDR.
    Source string
    Name of Source gateway.
    nexthop String
    Name of nexthop gateway.
    reachableCidr String
    Destination CIDR.
    source String
    Name of Source gateway.
    nexthop string
    Name of nexthop gateway.
    reachableCidr string
    Destination CIDR.
    source string
    Name of Source gateway.
    nexthop str
    Name of nexthop gateway.
    reachable_cidr str
    Destination CIDR.
    source str
    Name of Source gateway.
    nexthop String
    Name of nexthop gateway.
    reachableCidr String
    Destination CIDR.
    source String
    Name of Source gateway.

    Import

    trans_peer can be imported using the source, nexthop and reachable_cidr, e.g.

     $ pulumi import aviatrix:index/aviatrixTransPeer:AviatrixTransPeer test source~nexthop~reachable_cidr
    

    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