aviatrix.AviatrixControllerPrivateModeConfig
Explore with Pulumi AI
The aviatrix_controller_private_mode_config resource allows management of an Aviatrix Controller’s Private Mode configuration. 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.AviatrixControllerPrivateModeConfig("test", new()
{
EnablePrivateMode = true,
});
});
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.NewAviatrixControllerPrivateModeConfig(ctx, "test", &aviatrix.AviatrixControllerPrivateModeConfigArgs{
EnablePrivateMode: pulumi.Bool(true),
})
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.AviatrixControllerPrivateModeConfig;
import com.pulumi.aviatrix.AviatrixControllerPrivateModeConfigArgs;
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 AviatrixControllerPrivateModeConfig("test", AviatrixControllerPrivateModeConfigArgs.builder()
.enablePrivateMode(true)
.build());
}
}
import pulumi
import pulumi_aviatrix as aviatrix
# Create an Aviatrix Controller Private Mode config
test = aviatrix.AviatrixControllerPrivateModeConfig("test", enable_private_mode=True)
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";
// Create an Aviatrix Controller Private Mode config
const test = new aviatrix.AviatrixControllerPrivateModeConfig("test", {
enablePrivateMode: true,
});
resources:
# Create an Aviatrix Controller Private Mode config
test:
type: aviatrix:AviatrixControllerPrivateModeConfig
properties:
enablePrivateMode: true
Create AviatrixControllerPrivateModeConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AviatrixControllerPrivateModeConfig(name: string, args: AviatrixControllerPrivateModeConfigArgs, opts?: CustomResourceOptions);
@overload
def AviatrixControllerPrivateModeConfig(resource_name: str,
args: AviatrixControllerPrivateModeConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AviatrixControllerPrivateModeConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
enable_private_mode: Optional[bool] = None,
copilot_instance_id: Optional[str] = None,
proxies: Optional[Sequence[str]] = None)
func NewAviatrixControllerPrivateModeConfig(ctx *Context, name string, args AviatrixControllerPrivateModeConfigArgs, opts ...ResourceOption) (*AviatrixControllerPrivateModeConfig, error)
public AviatrixControllerPrivateModeConfig(string name, AviatrixControllerPrivateModeConfigArgs args, CustomResourceOptions? opts = null)
public AviatrixControllerPrivateModeConfig(String name, AviatrixControllerPrivateModeConfigArgs args)
public AviatrixControllerPrivateModeConfig(String name, AviatrixControllerPrivateModeConfigArgs args, CustomResourceOptions options)
type: aviatrix:AviatrixControllerPrivateModeConfig
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 AviatrixControllerPrivateModeConfigArgs
- 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 AviatrixControllerPrivateModeConfigArgs
- 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 AviatrixControllerPrivateModeConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AviatrixControllerPrivateModeConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AviatrixControllerPrivateModeConfigArgs
- 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 aviatrixControllerPrivateModeConfigResource = new Aviatrix.AviatrixControllerPrivateModeConfig("aviatrixControllerPrivateModeConfigResource", new()
{
EnablePrivateMode = false,
CopilotInstanceId = "string",
Proxies = new[]
{
"string",
},
});
example, err := aviatrix.NewAviatrixControllerPrivateModeConfig(ctx, "aviatrixControllerPrivateModeConfigResource", &aviatrix.AviatrixControllerPrivateModeConfigArgs{
EnablePrivateMode: pulumi.Bool(false),
CopilotInstanceId: pulumi.String("string"),
Proxies: pulumi.StringArray{
pulumi.String("string"),
},
})
var aviatrixControllerPrivateModeConfigResource = new AviatrixControllerPrivateModeConfig("aviatrixControllerPrivateModeConfigResource", AviatrixControllerPrivateModeConfigArgs.builder()
.enablePrivateMode(false)
.copilotInstanceId("string")
.proxies("string")
.build());
aviatrix_controller_private_mode_config_resource = aviatrix.AviatrixControllerPrivateModeConfig("aviatrixControllerPrivateModeConfigResource",
enable_private_mode=False,
copilot_instance_id="string",
proxies=["string"])
const aviatrixControllerPrivateModeConfigResource = new aviatrix.AviatrixControllerPrivateModeConfig("aviatrixControllerPrivateModeConfigResource", {
enablePrivateMode: false,
copilotInstanceId: "string",
proxies: ["string"],
});
type: aviatrix:AviatrixControllerPrivateModeConfig
properties:
copilotInstanceId: string
enablePrivateMode: false
proxies:
- string
AviatrixControllerPrivateModeConfig 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 AviatrixControllerPrivateModeConfig resource accepts the following input properties:
- Enable
Private boolMode - Whether to enable Private Mode on an Aviatrix Controller.
- Copilot
Instance stringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- Proxies List<string>
- Set of Controller proxies for Private Mode.
- Enable
Private boolMode - Whether to enable Private Mode on an Aviatrix Controller.
- Copilot
Instance stringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- Proxies []string
- Set of Controller proxies for Private Mode.
- enable
Private BooleanMode - Whether to enable Private Mode on an Aviatrix Controller.
- copilot
Instance StringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- proxies List<String>
- Set of Controller proxies for Private Mode.
- enable
Private booleanMode - Whether to enable Private Mode on an Aviatrix Controller.
- copilot
Instance stringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- proxies string[]
- Set of Controller proxies for Private Mode.
- enable_
private_ boolmode - Whether to enable Private Mode on an Aviatrix Controller.
- copilot_
instance_ strid - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- proxies Sequence[str]
- Set of Controller proxies for Private Mode.
- enable
Private BooleanMode - Whether to enable Private Mode on an Aviatrix Controller.
- copilot
Instance StringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- proxies List<String>
- Set of Controller proxies for Private Mode.
Outputs
All input properties are implicitly available as output properties. Additionally, the AviatrixControllerPrivateModeConfig 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 AviatrixControllerPrivateModeConfig Resource
Get an existing AviatrixControllerPrivateModeConfig 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?: AviatrixControllerPrivateModeConfigState, opts?: CustomResourceOptions): AviatrixControllerPrivateModeConfig
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
copilot_instance_id: Optional[str] = None,
enable_private_mode: Optional[bool] = None,
proxies: Optional[Sequence[str]] = None) -> AviatrixControllerPrivateModeConfig
func GetAviatrixControllerPrivateModeConfig(ctx *Context, name string, id IDInput, state *AviatrixControllerPrivateModeConfigState, opts ...ResourceOption) (*AviatrixControllerPrivateModeConfig, error)
public static AviatrixControllerPrivateModeConfig Get(string name, Input<string> id, AviatrixControllerPrivateModeConfigState? state, CustomResourceOptions? opts = null)
public static AviatrixControllerPrivateModeConfig get(String name, Output<String> id, AviatrixControllerPrivateModeConfigState 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.
- Copilot
Instance stringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- Enable
Private boolMode - Whether to enable Private Mode on an Aviatrix Controller.
- Proxies List<string>
- Set of Controller proxies for Private Mode.
- Copilot
Instance stringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- Enable
Private boolMode - Whether to enable Private Mode on an Aviatrix Controller.
- Proxies []string
- Set of Controller proxies for Private Mode.
- copilot
Instance StringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- enable
Private BooleanMode - Whether to enable Private Mode on an Aviatrix Controller.
- proxies List<String>
- Set of Controller proxies for Private Mode.
- copilot
Instance stringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- enable
Private booleanMode - Whether to enable Private Mode on an Aviatrix Controller.
- proxies string[]
- Set of Controller proxies for Private Mode.
- copilot_
instance_ strid - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- enable_
private_ boolmode - Whether to enable Private Mode on an Aviatrix Controller.
- proxies Sequence[str]
- Set of Controller proxies for Private Mode.
- copilot
Instance StringId - Instance ID of a copilot instance to associate with an Aviatrix Controller in Private Mode. The copilot instance must be in the same VPC as the Aviatrix Controller.
- enable
Private BooleanMode - Whether to enable Private Mode on an Aviatrix Controller.
- proxies List<String>
- Set of Controller proxies for Private Mode.
Import
aviatrix_controller_private_mode_config can be imported using controller IP, e.g. controller IP is 10.11.12.13
$ pulumi import aviatrix:index/aviatrixControllerPrivateModeConfig:AviatrixControllerPrivateModeConfig test 10-11-12-13
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.