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

aviatrix.AviatrixPrivateModeLb

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

    The aviatrix_private_mode_lb resource allows management of a Private Mode load balancer. This resource is available as of provider version R2.23+.

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create a Private Mode Controller load balancer
    var test = new Aviatrix.AviatrixPrivateModeLb("test", new()
    {
        AccountName = "devops",
        LbType = "controller",
        Region = "us-east-1",
        VpcId = "vpc-abcdef",
    });

});

    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.NewAviatrixPrivateModeLb(ctx, "test", &aviatrix.AviatrixPrivateModeLbArgs{
			AccountName: pulumi.String("devops"),
			LbType:      pulumi.String("controller"),
			Region:      pulumi.String("us-east-1"),
			VpcId:       pulumi.String("vpc-abcdef"),
		})
		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.AviatrixPrivateModeLb;
import com.pulumi.aviatrix.AviatrixPrivateModeLbArgs;
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 AviatrixPrivateModeLb("test", AviatrixPrivateModeLbArgs.builder()        
            .accountName("devops")
            .lbType("controller")
            .region("us-east-1")
            .vpcId("vpc-abcdef")
            .build());

    }
}

    import pulumi
import pulumi_aviatrix as aviatrix

# Create a Private Mode Controller load balancer
test = aviatrix.AviatrixPrivateModeLb("test",
    account_name="devops",
    lb_type="controller",
    region="us-east-1",
    vpc_id="vpc-abcdef")

    import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Create a Private Mode Controller load balancer
const test = new aviatrix.AviatrixPrivateModeLb("test", {
    accountName: "devops",
    lbType: "controller",
    region: "us-east-1",
    vpcId: "vpc-abcdef",
});

    resources:
  # Create a Private Mode Controller load balancer
  test:
    type: aviatrix:AviatrixPrivateModeLb
    properties:
      accountName: devops
      lbType: controller
      region: us-east-1
      vpcId: vpc-abcdef

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixPrivateModeLb;
import com.pulumi.aviatrix.AviatrixPrivateModeLbArgs;
import com.pulumi.aviatrix.inputs.AviatrixPrivateModeLbProxyArgs;
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 test2 = new AviatrixPrivateModeLb("test2", AviatrixPrivateModeLbArgs.builder()        
            .accountName("devops")
            .lbType("multicloud")
            .multicloudAccessVpcId("vpc-abcdef")
            .proxies(AviatrixPrivateModeLbProxyArgs.builder()
                .instanceId("i-123456")
                .proxyType("multicloud")
                .vpcId("vpc-abcdef")
                .build())
            .region("us-east-1")
            .vpcId("vpc-abcdef")
            .build());

    }
}

    Coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Create a Private Mode multicloud load balancer
const test2 = new aviatrix.AviatrixPrivateModeLb("test2", {
    accountName: "devops",
    lbType: "multicloud",
    multicloudAccessVpcId: "vpc-abcdef",
    proxies: [{
        instanceId: "i-123456",
        proxyType: "multicloud",
        vpcId: "vpc-abcdef",
    }],
    region: "us-east-1",
    vpcId: "vpc-abcdef",
});

    resources:
  # Create a Private Mode multicloud load balancer
  test2:
    type: aviatrix:AviatrixPrivateModeLb
    properties:
      accountName: devops
      lbType: multicloud
      multicloudAccessVpcId: vpc-abcdef
      proxies:
        - instanceId: i-123456
          proxyType: multicloud
          vpcId: vpc-abcdef
      region: us-east-1
      vpcId: vpc-abcdef

    Create AviatrixPrivateModeLb Resource

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

    Constructor syntax

    new AviatrixPrivateModeLb(name: string, args: AviatrixPrivateModeLbArgs, opts?: CustomResourceOptions);
    @overload
def AviatrixPrivateModeLb(resource_name: str,
                          args: AviatrixPrivateModeLbArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def AviatrixPrivateModeLb(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          account_name: Optional[str] = None,
                          lb_type: Optional[str] = None,
                          region: Optional[str] = None,
                          vpc_id: Optional[str] = None,
                          multicloud_access_vpc_id: Optional[str] = None,
                          proxies: Optional[Sequence[AviatrixPrivateModeLbProxyArgs]] = None)
    func NewAviatrixPrivateModeLb(ctx *Context, name string, args AviatrixPrivateModeLbArgs, opts ...ResourceOption) (*AviatrixPrivateModeLb, error)
    public AviatrixPrivateModeLb(string name, AviatrixPrivateModeLbArgs args, CustomResourceOptions? opts = null)
    public AviatrixPrivateModeLb(String name, AviatrixPrivateModeLbArgs args)
public AviatrixPrivateModeLb(String name, AviatrixPrivateModeLbArgs args, CustomResourceOptions options)

    type: aviatrix:AviatrixPrivateModeLb
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 AviatrixPrivateModeLbArgs
    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 AviatrixPrivateModeLbArgs
    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 AviatrixPrivateModeLbArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixPrivateModeLbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixPrivateModeLbArgs
    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 aviatrixPrivateModeLbResource = new Aviatrix.AviatrixPrivateModeLb("aviatrixPrivateModeLbResource", new()
{
    AccountName = "string",
    LbType = "string",
    Region = "string",
    VpcId = "string",
    MulticloudAccessVpcId = "string",
    Proxies = new[]
    {
        new Aviatrix.Inputs.AviatrixPrivateModeLbProxyArgs
        {
            InstanceId = "string",
            VpcId = "string",
        },
    },
});

    example, err := aviatrix.NewAviatrixPrivateModeLb(ctx, "aviatrixPrivateModeLbResource", &aviatrix.AviatrixPrivateModeLbArgs{
	AccountName:           pulumi.String("string"),
	LbType:                pulumi.String("string"),
	Region:                pulumi.String("string"),
	VpcId:                 pulumi.String("string"),
	MulticloudAccessVpcId: pulumi.String("string"),
	Proxies: aviatrix.AviatrixPrivateModeLbProxyArray{
		&aviatrix.AviatrixPrivateModeLbProxyArgs{
			InstanceId: pulumi.String("string"),
			VpcId:      pulumi.String("string"),
		},
	},
})

    var aviatrixPrivateModeLbResource = new AviatrixPrivateModeLb("aviatrixPrivateModeLbResource", AviatrixPrivateModeLbArgs.builder()
    .accountName("string")
    .lbType("string")
    .region("string")
    .vpcId("string")
    .multicloudAccessVpcId("string")
    .proxies(AviatrixPrivateModeLbProxyArgs.builder()
        .instanceId("string")
        .vpcId("string")
        .build())
    .build());

    aviatrix_private_mode_lb_resource = aviatrix.AviatrixPrivateModeLb("aviatrixPrivateModeLbResource",
    account_name="string",
    lb_type="string",
    region="string",
    vpc_id="string",
    multicloud_access_vpc_id="string",
    proxies=[{
        "instance_id": "string",
        "vpc_id": "string",
    }])

    const aviatrixPrivateModeLbResource = new aviatrix.AviatrixPrivateModeLb("aviatrixPrivateModeLbResource", {
    accountName: "string",
    lbType: "string",
    region: "string",
    vpcId: "string",
    multicloudAccessVpcId: "string",
    proxies: [{
        instanceId: "string",
        vpcId: "string",
    }],
});

    type: aviatrix:AviatrixPrivateModeLb
properties:
    accountName: string
    lbType: string
    multicloudAccessVpcId: string
    proxies:
        - instanceId: string
          vpcId: string
    region: string
    vpcId: string

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

    AccountName string
    Name of the access account.
    LbType string
    Type of load balancer to create. Must be one of controller or multicloud.
    Region string
    Name of the region containing the VPC.
    VpcId string
    VPC ID of the proxy.
    MulticloudAccessVpcId string
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    Proxies List<AviatrixPrivateModeLbProxy>
    List of multicloud proxies. Only valid when lb_type is multicloud.
    AccountName string
    Name of the access account.
    LbType string
    Type of load balancer to create. Must be one of controller or multicloud.
    Region string
    Name of the region containing the VPC.
    VpcId string
    VPC ID of the proxy.
    MulticloudAccessVpcId string
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    Proxies []AviatrixPrivateModeLbProxyArgs
    List of multicloud proxies. Only valid when lb_type is multicloud.
    accountName String
    Name of the access account.
    lbType String
    Type of load balancer to create. Must be one of controller or multicloud.
    region String
    Name of the region containing the VPC.
    vpcId String
    VPC ID of the proxy.
    multicloudAccessVpcId String
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies List<AviatrixPrivateModeLbProxy>
    List of multicloud proxies. Only valid when lb_type is multicloud.
    accountName string
    Name of the access account.
    lbType string
    Type of load balancer to create. Must be one of controller or multicloud.
    region string
    Name of the region containing the VPC.
    vpcId string
    VPC ID of the proxy.
    multicloudAccessVpcId string
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies AviatrixPrivateModeLbProxy[]
    List of multicloud proxies. Only valid when lb_type is multicloud.
    account_name str
    Name of the access account.
    lb_type str
    Type of load balancer to create. Must be one of controller or multicloud.
    region str
    Name of the region containing the VPC.
    vpc_id str
    VPC ID of the proxy.
    multicloud_access_vpc_id str
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies Sequence[AviatrixPrivateModeLbProxyArgs]
    List of multicloud proxies. Only valid when lb_type is multicloud.
    accountName String
    Name of the access account.
    lbType String
    Type of load balancer to create. Must be one of controller or multicloud.
    region String
    Name of the region containing the VPC.
    vpcId String
    VPC ID of the proxy.
    multicloudAccessVpcId String
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies List<Property Map>
    List of multicloud proxies. Only valid when lb_type is multicloud.

    Outputs

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

    Get an existing AviatrixPrivateModeLb 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?: AviatrixPrivateModeLbState, opts?: CustomResourceOptions): AviatrixPrivateModeLb
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        lb_type: Optional[str] = None,
        multicloud_access_vpc_id: Optional[str] = None,
        proxies: Optional[Sequence[AviatrixPrivateModeLbProxyArgs]] = None,
        region: Optional[str] = None,
        vpc_id: Optional[str] = None) -> AviatrixPrivateModeLb
    func GetAviatrixPrivateModeLb(ctx *Context, name string, id IDInput, state *AviatrixPrivateModeLbState, opts ...ResourceOption) (*AviatrixPrivateModeLb, error)
    public static AviatrixPrivateModeLb Get(string name, Input<string> id, AviatrixPrivateModeLbState? state, CustomResourceOptions? opts = null)
    public static AviatrixPrivateModeLb get(String name, Output<String> id, AviatrixPrivateModeLbState 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:
    AccountName string
    Name of the access account.
    LbType string
    Type of load balancer to create. Must be one of controller or multicloud.
    MulticloudAccessVpcId string
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    Proxies List<AviatrixPrivateModeLbProxy>
    List of multicloud proxies. Only valid when lb_type is multicloud.
    Region string
    Name of the region containing the VPC.
    VpcId string
    VPC ID of the proxy.
    AccountName string
    Name of the access account.
    LbType string
    Type of load balancer to create. Must be one of controller or multicloud.
    MulticloudAccessVpcId string
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    Proxies []AviatrixPrivateModeLbProxyArgs
    List of multicloud proxies. Only valid when lb_type is multicloud.
    Region string
    Name of the region containing the VPC.
    VpcId string
    VPC ID of the proxy.
    accountName String
    Name of the access account.
    lbType String
    Type of load balancer to create. Must be one of controller or multicloud.
    multicloudAccessVpcId String
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies List<AviatrixPrivateModeLbProxy>
    List of multicloud proxies. Only valid when lb_type is multicloud.
    region String
    Name of the region containing the VPC.
    vpcId String
    VPC ID of the proxy.
    accountName string
    Name of the access account.
    lbType string
    Type of load balancer to create. Must be one of controller or multicloud.
    multicloudAccessVpcId string
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies AviatrixPrivateModeLbProxy[]
    List of multicloud proxies. Only valid when lb_type is multicloud.
    region string
    Name of the region containing the VPC.
    vpcId string
    VPC ID of the proxy.
    account_name str
    Name of the access account.
    lb_type str
    Type of load balancer to create. Must be one of controller or multicloud.
    multicloud_access_vpc_id str
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies Sequence[AviatrixPrivateModeLbProxyArgs]
    List of multicloud proxies. Only valid when lb_type is multicloud.
    region str
    Name of the region containing the VPC.
    vpc_id str
    VPC ID of the proxy.
    accountName String
    Name of the access account.
    lbType String
    Type of load balancer to create. Must be one of controller or multicloud.
    multicloudAccessVpcId String
    ID of the VPC with a multicloud endpoint. Required when lb_type is multicloud.
    proxies List<Property Map>
    List of multicloud proxies. Only valid when lb_type is multicloud.
    region String
    Name of the region containing the VPC.
    vpcId String
    VPC ID of the proxy.

    Supporting Types

    AviatrixPrivateModeLbProxy, AviatrixPrivateModeLbProxyArgs

    InstanceId string
    Instance ID of the proxy.
    VpcId string
    VPC ID of the proxy.
    InstanceId string
    Instance ID of the proxy.
    VpcId string
    VPC ID of the proxy.
    instanceId String
    Instance ID of the proxy.
    vpcId String
    VPC ID of the proxy.
    instanceId string
    Instance ID of the proxy.
    vpcId string
    VPC ID of the proxy.
    instance_id str
    Instance ID of the proxy.
    vpc_id str
    VPC ID of the proxy.
    instanceId String
    Instance ID of the proxy.
    vpcId String
    VPC ID of the proxy.

    Import

    aviatrix_private_mode_lb can be imported using the vpc_id, e.g.

     $ pulumi import aviatrix:index/aviatrixPrivateModeLb:AviatrixPrivateModeLb test vpc-1234567

    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
    astipkovits/pulumi-aviatrix