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

aviatrix.AviatrixPrivateModeMulticloudEndpoint

Explore with Pulumi AI

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

The aviatrix_private_mode_multicloud_endpoint resource allows management of a Private Mode multicloud endpoint. 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 an Aviatrix Controller Private Mode config
    var test = new Aviatrix.AviatrixPrivateModeMulticloudEndpoint("test", new()
    {
        AccountName = "devops",
        ControllerLbVpcId = "vpc-abcdefg",
        Region = "us-east-1",
        VpcId = "vpc-abcdef",
    });

});
Copy
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.NewAviatrixPrivateModeMulticloudEndpoint(ctx, "test", &aviatrix.AviatrixPrivateModeMulticloudEndpointArgs{
			AccountName:       pulumi.String("devops"),
			ControllerLbVpcId: pulumi.String("vpc-abcdefg"),
			Region:            pulumi.String("us-east-1"),
			VpcId:             pulumi.String("vpc-abcdef"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixPrivateModeMulticloudEndpoint;
import com.pulumi.aviatrix.AviatrixPrivateModeMulticloudEndpointArgs;
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 AviatrixPrivateModeMulticloudEndpoint("test", AviatrixPrivateModeMulticloudEndpointArgs.builder()        
            .accountName("devops")
            .controllerLbVpcId("vpc-abcdefg")
            .region("us-east-1")
            .vpcId("vpc-abcdef")
            .build());

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

// Create an Aviatrix Controller Private Mode config
const test = new aviatrix.AviatrixPrivateModeMulticloudEndpoint("test", {
    accountName: "devops",
    controllerLbVpcId: "vpc-abcdefg",
    region: "us-east-1",
    vpcId: "vpc-abcdef",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix Controller Private Mode config
test = aviatrix.AviatrixPrivateModeMulticloudEndpoint("test",
    account_name="devops",
    controller_lb_vpc_id="vpc-abcdefg",
    region="us-east-1",
    vpc_id="vpc-abcdef")
Copy
resources:
  # Create an Aviatrix Controller Private Mode config
  test:
    type: aviatrix:AviatrixPrivateModeMulticloudEndpoint
    properties:
      accountName: devops
      controllerLbVpcId: vpc-abcdefg
      region: us-east-1
      vpcId: vpc-abcdef
Copy

Create AviatrixPrivateModeMulticloudEndpoint Resource

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

Constructor syntax

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

@overload
def AviatrixPrivateModeMulticloudEndpoint(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          account_name: Optional[str] = None,
                                          controller_lb_vpc_id: Optional[str] = None,
                                          region: Optional[str] = None,
                                          vpc_id: Optional[str] = None)
func NewAviatrixPrivateModeMulticloudEndpoint(ctx *Context, name string, args AviatrixPrivateModeMulticloudEndpointArgs, opts ...ResourceOption) (*AviatrixPrivateModeMulticloudEndpoint, error)
public AviatrixPrivateModeMulticloudEndpoint(string name, AviatrixPrivateModeMulticloudEndpointArgs args, CustomResourceOptions? opts = null)
public AviatrixPrivateModeMulticloudEndpoint(String name, AviatrixPrivateModeMulticloudEndpointArgs args)
public AviatrixPrivateModeMulticloudEndpoint(String name, AviatrixPrivateModeMulticloudEndpointArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixPrivateModeMulticloudEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AviatrixPrivateModeMulticloudEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AviatrixPrivateModeMulticloudEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixPrivateModeMulticloudEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixPrivateModeMulticloudEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AviatrixPrivateModeMulticloudEndpointArgs
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 aviatrixPrivateModeMulticloudEndpointResource = new Aviatrix.AviatrixPrivateModeMulticloudEndpoint("aviatrixPrivateModeMulticloudEndpointResource", new()
{
    AccountName = "string",
    ControllerLbVpcId = "string",
    Region = "string",
    VpcId = "string",
});
Copy
example, err := aviatrix.NewAviatrixPrivateModeMulticloudEndpoint(ctx, "aviatrixPrivateModeMulticloudEndpointResource", &aviatrix.AviatrixPrivateModeMulticloudEndpointArgs{
	AccountName:       pulumi.String("string"),
	ControllerLbVpcId: pulumi.String("string"),
	Region:            pulumi.String("string"),
	VpcId:             pulumi.String("string"),
})
Copy
var aviatrixPrivateModeMulticloudEndpointResource = new AviatrixPrivateModeMulticloudEndpoint("aviatrixPrivateModeMulticloudEndpointResource", AviatrixPrivateModeMulticloudEndpointArgs.builder()
    .accountName("string")
    .controllerLbVpcId("string")
    .region("string")
    .vpcId("string")
    .build());
Copy
aviatrix_private_mode_multicloud_endpoint_resource = aviatrix.AviatrixPrivateModeMulticloudEndpoint("aviatrixPrivateModeMulticloudEndpointResource",
    account_name="string",
    controller_lb_vpc_id="string",
    region="string",
    vpc_id="string")
Copy
const aviatrixPrivateModeMulticloudEndpointResource = new aviatrix.AviatrixPrivateModeMulticloudEndpoint("aviatrixPrivateModeMulticloudEndpointResource", {
    accountName: "string",
    controllerLbVpcId: "string",
    region: "string",
    vpcId: "string",
});
Copy
type: aviatrix:AviatrixPrivateModeMulticloudEndpoint
properties:
    accountName: string
    controllerLbVpcId: string
    region: string
    vpcId: string
Copy

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

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Name of the access account.
ControllerLbVpcId
This property is required.
Changes to this property will trigger replacement.
string
ID of the VPC containing a Private Mode controller load balancer.
Region
This property is required.
Changes to this property will trigger replacement.
string
Region of the VPC.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
ID of the VPC to create the endpoint in.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Name of the access account.
ControllerLbVpcId
This property is required.
Changes to this property will trigger replacement.
string
ID of the VPC containing a Private Mode controller load balancer.
Region
This property is required.
Changes to this property will trigger replacement.
string
Region of the VPC.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
ID of the VPC to create the endpoint in.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Name of the access account.
controllerLbVpcId
This property is required.
Changes to this property will trigger replacement.
String
ID of the VPC containing a Private Mode controller load balancer.
region
This property is required.
Changes to this property will trigger replacement.
String
Region of the VPC.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
ID of the VPC to create the endpoint in.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Name of the access account.
controllerLbVpcId
This property is required.
Changes to this property will trigger replacement.
string
ID of the VPC containing a Private Mode controller load balancer.
region
This property is required.
Changes to this property will trigger replacement.
string
Region of the VPC.
vpcId
This property is required.
Changes to this property will trigger replacement.
string
ID of the VPC to create the endpoint in.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the access account.
controller_lb_vpc_id
This property is required.
Changes to this property will trigger replacement.
str
ID of the VPC containing a Private Mode controller load balancer.
region
This property is required.
Changes to this property will trigger replacement.
str
Region of the VPC.
vpc_id
This property is required.
Changes to this property will trigger replacement.
str
ID of the VPC to create the endpoint in.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Name of the access account.
controllerLbVpcId
This property is required.
Changes to this property will trigger replacement.
String
ID of the VPC containing a Private Mode controller load balancer.
region
This property is required.
Changes to this property will trigger replacement.
String
Region of the VPC.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
ID of the VPC to create the endpoint in.

Outputs

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

DnsEntry string
DNS entry of the endpoint.
Id string
The provider-assigned unique ID for this managed resource.
DnsEntry string
DNS entry of the endpoint.
Id string
The provider-assigned unique ID for this managed resource.
dnsEntry String
DNS entry of the endpoint.
id String
The provider-assigned unique ID for this managed resource.
dnsEntry string
DNS entry of the endpoint.
id string
The provider-assigned unique ID for this managed resource.
dns_entry str
DNS entry of the endpoint.
id str
The provider-assigned unique ID for this managed resource.
dnsEntry String
DNS entry of the endpoint.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AviatrixPrivateModeMulticloudEndpoint Resource

Get an existing AviatrixPrivateModeMulticloudEndpoint 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?: AviatrixPrivateModeMulticloudEndpointState, opts?: CustomResourceOptions): AviatrixPrivateModeMulticloudEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        controller_lb_vpc_id: Optional[str] = None,
        dns_entry: Optional[str] = None,
        region: Optional[str] = None,
        vpc_id: Optional[str] = None) -> AviatrixPrivateModeMulticloudEndpoint
func GetAviatrixPrivateModeMulticloudEndpoint(ctx *Context, name string, id IDInput, state *AviatrixPrivateModeMulticloudEndpointState, opts ...ResourceOption) (*AviatrixPrivateModeMulticloudEndpoint, error)
public static AviatrixPrivateModeMulticloudEndpoint Get(string name, Input<string> id, AviatrixPrivateModeMulticloudEndpointState? state, CustomResourceOptions? opts = null)
public static AviatrixPrivateModeMulticloudEndpoint get(String name, Output<String> id, AviatrixPrivateModeMulticloudEndpointState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixPrivateModeMulticloudEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
Name of the access account.
ControllerLbVpcId Changes to this property will trigger replacement. string
ID of the VPC containing a Private Mode controller load balancer.
DnsEntry string
DNS entry of the endpoint.
Region Changes to this property will trigger replacement. string
Region of the VPC.
VpcId Changes to this property will trigger replacement. string
ID of the VPC to create the endpoint in.
AccountName Changes to this property will trigger replacement. string
Name of the access account.
ControllerLbVpcId Changes to this property will trigger replacement. string
ID of the VPC containing a Private Mode controller load balancer.
DnsEntry string
DNS entry of the endpoint.
Region Changes to this property will trigger replacement. string
Region of the VPC.
VpcId Changes to this property will trigger replacement. string
ID of the VPC to create the endpoint in.
accountName Changes to this property will trigger replacement. String
Name of the access account.
controllerLbVpcId Changes to this property will trigger replacement. String
ID of the VPC containing a Private Mode controller load balancer.
dnsEntry String
DNS entry of the endpoint.
region Changes to this property will trigger replacement. String
Region of the VPC.
vpcId Changes to this property will trigger replacement. String
ID of the VPC to create the endpoint in.
accountName Changes to this property will trigger replacement. string
Name of the access account.
controllerLbVpcId Changes to this property will trigger replacement. string
ID of the VPC containing a Private Mode controller load balancer.
dnsEntry string
DNS entry of the endpoint.
region Changes to this property will trigger replacement. string
Region of the VPC.
vpcId Changes to this property will trigger replacement. string
ID of the VPC to create the endpoint in.
account_name Changes to this property will trigger replacement. str
Name of the access account.
controller_lb_vpc_id Changes to this property will trigger replacement. str
ID of the VPC containing a Private Mode controller load balancer.
dns_entry str
DNS entry of the endpoint.
region Changes to this property will trigger replacement. str
Region of the VPC.
vpc_id Changes to this property will trigger replacement. str
ID of the VPC to create the endpoint in.
accountName Changes to this property will trigger replacement. String
Name of the access account.
controllerLbVpcId Changes to this property will trigger replacement. String
ID of the VPC containing a Private Mode controller load balancer.
dnsEntry String
DNS entry of the endpoint.
region Changes to this property will trigger replacement. String
Region of the VPC.
vpcId Changes to this property will trigger replacement. String
ID of the VPC to create the endpoint in.

Import

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

 $ pulumi import aviatrix:index/aviatrixPrivateModeMulticloudEndpoint:AviatrixPrivateModeMulticloudEndpoint test vpc-1234567
Copy

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 v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix