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

aviatrix.AviatrixCloudnRegistration

Explore with Pulumi AI

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

    The aviatrix_cloudn_registration resource allows the registration and deregistration of Aviatrix CloudN as a Gateway. This resource is available as of provider version R2.21+.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a CloudN Registration
        var testCloudnRegistration = new Aviatrix.AviatrixCloudnRegistration("testCloudnRegistration", new()
        {
            Address = "10.210.38.100",
            LocalAsNumber = "65000",
            Password = "password",
            PrependAsPaths = new[]
            {
                "65000",
                "65000",
            },
            Username = "admin",
        });
    
    });
    
    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.NewAviatrixCloudnRegistration(ctx, "testCloudnRegistration", &aviatrix.AviatrixCloudnRegistrationArgs{
    			Address:       pulumi.String("10.210.38.100"),
    			LocalAsNumber: pulumi.String("65000"),
    			Password:      pulumi.String("password"),
    			PrependAsPaths: pulumi.StringArray{
    				pulumi.String("65000"),
    				pulumi.String("65000"),
    			},
    			Username: pulumi.String("admin"),
    		})
    		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.AviatrixCloudnRegistration;
    import com.pulumi.aviatrix.AviatrixCloudnRegistrationArgs;
    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 testCloudnRegistration = new AviatrixCloudnRegistration("testCloudnRegistration", AviatrixCloudnRegistrationArgs.builder()        
                .address("10.210.38.100")
                .localAsNumber("65000")
                .password("password")
                .prependAsPaths(            
                    "65000",
                    "65000")
                .username("admin")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create a CloudN Registration
    test_cloudn_registration = aviatrix.AviatrixCloudnRegistration("testCloudnRegistration",
        address="10.210.38.100",
        local_as_number="65000",
        password="password",
        prepend_as_paths=[
            "65000",
            "65000",
        ],
        username="admin")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create a CloudN Registration
    const testCloudnRegistration = new aviatrix.AviatrixCloudnRegistration("test_cloudn_registration", {
        address: "10.210.38.100",
        localAsNumber: "65000",
        password: "password",
        prependAsPaths: [
            "65000",
            "65000",
        ],
        username: "admin",
    });
    
    resources:
      # Create a CloudN Registration
      testCloudnRegistration:
        type: aviatrix:AviatrixCloudnRegistration
        properties:
          address: 10.210.38.100
          localAsNumber: '65000'
          password: password
          prependAsPaths:
            - '65000'
            - '65000'
          username: admin
    

    Create AviatrixCloudnRegistration Resource

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

    Constructor syntax

    new AviatrixCloudnRegistration(name: string, args: AviatrixCloudnRegistrationArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixCloudnRegistration(resource_name: str,
                                   args: AviatrixCloudnRegistrationArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixCloudnRegistration(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   address: Optional[str] = None,
                                   password: Optional[str] = None,
                                   username: Optional[str] = None,
                                   local_as_number: Optional[str] = None,
                                   name: Optional[str] = None,
                                   prepend_as_paths: Optional[Sequence[str]] = None)
    func NewAviatrixCloudnRegistration(ctx *Context, name string, args AviatrixCloudnRegistrationArgs, opts ...ResourceOption) (*AviatrixCloudnRegistration, error)
    public AviatrixCloudnRegistration(string name, AviatrixCloudnRegistrationArgs args, CustomResourceOptions? opts = null)
    public AviatrixCloudnRegistration(String name, AviatrixCloudnRegistrationArgs args)
    public AviatrixCloudnRegistration(String name, AviatrixCloudnRegistrationArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixCloudnRegistration
    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 AviatrixCloudnRegistrationArgs
    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 AviatrixCloudnRegistrationArgs
    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 AviatrixCloudnRegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixCloudnRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixCloudnRegistrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var aviatrixCloudnRegistrationResource = new Aviatrix.AviatrixCloudnRegistration("aviatrixCloudnRegistrationResource", new()
    {
        Address = "string",
        Password = "string",
        Username = "string",
        LocalAsNumber = "string",
        Name = "string",
        PrependAsPaths = new[]
        {
            "string",
        },
    });
    
    example, err := aviatrix.NewAviatrixCloudnRegistration(ctx, "aviatrixCloudnRegistrationResource", &aviatrix.AviatrixCloudnRegistrationArgs{
    	Address:       pulumi.String("string"),
    	Password:      pulumi.String("string"),
    	Username:      pulumi.String("string"),
    	LocalAsNumber: pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	PrependAsPaths: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var aviatrixCloudnRegistrationResource = new AviatrixCloudnRegistration("aviatrixCloudnRegistrationResource", AviatrixCloudnRegistrationArgs.builder()        
        .address("string")
        .password("string")
        .username("string")
        .localAsNumber("string")
        .name("string")
        .prependAsPaths("string")
        .build());
    
    aviatrix_cloudn_registration_resource = aviatrix.AviatrixCloudnRegistration("aviatrixCloudnRegistrationResource",
        address="string",
        password="string",
        username="string",
        local_as_number="string",
        name="string",
        prepend_as_paths=["string"])
    
    const aviatrixCloudnRegistrationResource = new aviatrix.AviatrixCloudnRegistration("aviatrixCloudnRegistrationResource", {
        address: "string",
        password: "string",
        username: "string",
        localAsNumber: "string",
        name: "string",
        prependAsPaths: ["string"],
    });
    
    type: aviatrix:AviatrixCloudnRegistration
    properties:
        address: string
        localAsNumber: string
        name: string
        password: string
        prependAsPaths:
            - string
        username: string
    

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

    Address string
    Aviatrix CloudN's public or private IP. Type: String.
    Password string
    Aviatrix account password corresponding to above username. Type: String.
    Username string
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    LocalAsNumber string
    BGP AS Number to assign to the Transit Gateway. Type: String.
    Name string
    Gateway name to assign to the CloudN device. Type: String.
    PrependAsPaths List<string>
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    Address string
    Aviatrix CloudN's public or private IP. Type: String.
    Password string
    Aviatrix account password corresponding to above username. Type: String.
    Username string
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    LocalAsNumber string
    BGP AS Number to assign to the Transit Gateway. Type: String.
    Name string
    Gateway name to assign to the CloudN device. Type: String.
    PrependAsPaths []string
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    address String
    Aviatrix CloudN's public or private IP. Type: String.
    password String
    Aviatrix account password corresponding to above username. Type: String.
    username String
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    localAsNumber String
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name String
    Gateway name to assign to the CloudN device. Type: String.
    prependAsPaths List<String>
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    address string
    Aviatrix CloudN's public or private IP. Type: String.
    password string
    Aviatrix account password corresponding to above username. Type: String.
    username string
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    localAsNumber string
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name string
    Gateway name to assign to the CloudN device. Type: String.
    prependAsPaths string[]
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    address str
    Aviatrix CloudN's public or private IP. Type: String.
    password str
    Aviatrix account password corresponding to above username. Type: String.
    username str
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    local_as_number str
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name str
    Gateway name to assign to the CloudN device. Type: String.
    prepend_as_paths Sequence[str]
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    address String
    Aviatrix CloudN's public or private IP. Type: String.
    password String
    Aviatrix account password corresponding to above username. Type: String.
    username String
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    localAsNumber String
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name String
    Gateway name to assign to the CloudN device. Type: String.
    prependAsPaths List<String>
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.

    Outputs

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

    Get an existing AviatrixCloudnRegistration 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?: AviatrixCloudnRegistrationState, opts?: CustomResourceOptions): AviatrixCloudnRegistration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            local_as_number: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            prepend_as_paths: Optional[Sequence[str]] = None,
            username: Optional[str] = None) -> AviatrixCloudnRegistration
    func GetAviatrixCloudnRegistration(ctx *Context, name string, id IDInput, state *AviatrixCloudnRegistrationState, opts ...ResourceOption) (*AviatrixCloudnRegistration, error)
    public static AviatrixCloudnRegistration Get(string name, Input<string> id, AviatrixCloudnRegistrationState? state, CustomResourceOptions? opts = null)
    public static AviatrixCloudnRegistration get(String name, Output<String> id, AviatrixCloudnRegistrationState 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:
    Address string
    Aviatrix CloudN's public or private IP. Type: String.
    LocalAsNumber string
    BGP AS Number to assign to the Transit Gateway. Type: String.
    Name string
    Gateway name to assign to the CloudN device. Type: String.
    Password string
    Aviatrix account password corresponding to above username. Type: String.
    PrependAsPaths List<string>
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    Username string
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    Address string
    Aviatrix CloudN's public or private IP. Type: String.
    LocalAsNumber string
    BGP AS Number to assign to the Transit Gateway. Type: String.
    Name string
    Gateway name to assign to the CloudN device. Type: String.
    Password string
    Aviatrix account password corresponding to above username. Type: String.
    PrependAsPaths []string
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    Username string
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    address String
    Aviatrix CloudN's public or private IP. Type: String.
    localAsNumber String
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name String
    Gateway name to assign to the CloudN device. Type: String.
    password String
    Aviatrix account password corresponding to above username. Type: String.
    prependAsPaths List<String>
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    username String
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    address string
    Aviatrix CloudN's public or private IP. Type: String.
    localAsNumber string
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name string
    Gateway name to assign to the CloudN device. Type: String.
    password string
    Aviatrix account password corresponding to above username. Type: String.
    prependAsPaths string[]
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    username string
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    address str
    Aviatrix CloudN's public or private IP. Type: String.
    local_as_number str
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name str
    Gateway name to assign to the CloudN device. Type: String.
    password str
    Aviatrix account password corresponding to above username. Type: String.
    prepend_as_paths Sequence[str]
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    username str
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.
    address String
    Aviatrix CloudN's public or private IP. Type: String.
    localAsNumber String
    BGP AS Number to assign to the Transit Gateway. Type: String.
    name String
    Gateway name to assign to the CloudN device. Type: String.
    password String
    Aviatrix account password corresponding to above username. Type: String.
    prependAsPaths List<String>
    Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
    username String
    Aviatrix account username which will be used to log in to Aviatrix CloudN. Type: String.

    Import

    cloudn_registration can be imported using the name, e.g.

     $ pulumi import aviatrix:index/aviatrixCloudnRegistration:AviatrixCloudnRegistration test_cloudn_registration 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