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

aviatrix.AviatrixControllerPrivateModeConfig

Explore with Pulumi AI

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

    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

    new AviatrixControllerPrivateModeConfig(name: string, args: AviatrixControllerPrivateModeConfigArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixControllerPrivateModeConfig(resource_name: str,
                                            opts: Optional[ResourceOptions] = None,
                                            copilot_instance_id: Optional[str] = None,
                                            enable_private_mode: Optional[bool] = None,
                                            proxies: Optional[Sequence[str]] = None)
    @overload
    def AviatrixControllerPrivateModeConfig(resource_name: str,
                                            args: AviatrixControllerPrivateModeConfigArgs,
                                            opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The AviatrixControllerPrivateModeConfig resource accepts the following input properties:

    EnablePrivateMode bool
    Whether to enable Private Mode on an Aviatrix Controller.
    CopilotInstanceId string
    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.
    EnablePrivateMode bool
    Whether to enable Private Mode on an Aviatrix Controller.
    CopilotInstanceId string
    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.
    enablePrivateMode Boolean
    Whether to enable Private Mode on an Aviatrix Controller.
    copilotInstanceId String
    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.
    enablePrivateMode boolean
    Whether to enable Private Mode on an Aviatrix Controller.
    copilotInstanceId string
    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_mode bool
    Whether to enable Private Mode on an Aviatrix Controller.
    copilot_instance_id str
    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.
    enablePrivateMode Boolean
    Whether to enable Private Mode on an Aviatrix Controller.
    copilotInstanceId String
    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.
    The following state arguments are supported:
    CopilotInstanceId string
    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.
    EnablePrivateMode bool
    Whether to enable Private Mode on an Aviatrix Controller.
    Proxies List<string>
    Set of Controller proxies for Private Mode.
    CopilotInstanceId string
    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.
    EnablePrivateMode bool
    Whether to enable Private Mode on an Aviatrix Controller.
    Proxies []string
    Set of Controller proxies for Private Mode.
    copilotInstanceId String
    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.
    enablePrivateMode Boolean
    Whether to enable Private Mode on an Aviatrix Controller.
    proxies List<String>
    Set of Controller proxies for Private Mode.
    copilotInstanceId string
    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.
    enablePrivateMode boolean
    Whether to enable Private Mode on an Aviatrix Controller.
    proxies string[]
    Set of Controller proxies for Private Mode.
    copilot_instance_id str
    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_mode bool
    Whether to enable Private Mode on an Aviatrix Controller.
    proxies Sequence[str]
    Set of Controller proxies for Private Mode.
    copilotInstanceId String
    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.
    enablePrivateMode Boolean
    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
    

    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