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

aviatrix.AviatrixControllerPrivateOob

Explore with Pulumi AI

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

    The aviatrix_controller_private_oob resource allows management of an Aviatrix Controller’s private OOB configurations.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix Controller Private OOB
        var testPrivateOob = new Aviatrix.AviatrixControllerPrivateOob("testPrivateOob", new()
        {
            EnablePrivateOob = 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.NewAviatrixControllerPrivateOob(ctx, "testPrivateOob", &aviatrix.AviatrixControllerPrivateOobArgs{
    			EnablePrivateOob: 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.AviatrixControllerPrivateOob;
    import com.pulumi.aviatrix.AviatrixControllerPrivateOobArgs;
    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 testPrivateOob = new AviatrixControllerPrivateOob("testPrivateOob", AviatrixControllerPrivateOobArgs.builder()        
                .enablePrivateOob(true)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix Controller Private OOB
    test_private_oob = aviatrix.AviatrixControllerPrivateOob("testPrivateOob", enable_private_oob=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Aviatrix Controller Private OOB
    const testPrivateOob = new aviatrix.AviatrixControllerPrivateOob("test_private_oob", {
        enablePrivateOob: true,
    });
    
    resources:
      # Create an Aviatrix Controller Private OOB
      testPrivateOob:
        type: aviatrix:AviatrixControllerPrivateOob
        properties:
          enablePrivateOob: true
    

    Create AviatrixControllerPrivateOob Resource

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

    Constructor syntax

    new AviatrixControllerPrivateOob(name: string, args?: AviatrixControllerPrivateOobArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixControllerPrivateOob(resource_name: str,
                                     args: Optional[AviatrixControllerPrivateOobArgs] = None,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixControllerPrivateOob(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     enable_private_oob: Optional[bool] = None)
    func NewAviatrixControllerPrivateOob(ctx *Context, name string, args *AviatrixControllerPrivateOobArgs, opts ...ResourceOption) (*AviatrixControllerPrivateOob, error)
    public AviatrixControllerPrivateOob(string name, AviatrixControllerPrivateOobArgs? args = null, CustomResourceOptions? opts = null)
    public AviatrixControllerPrivateOob(String name, AviatrixControllerPrivateOobArgs args)
    public AviatrixControllerPrivateOob(String name, AviatrixControllerPrivateOobArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixControllerPrivateOob
    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 AviatrixControllerPrivateOobArgs
    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 AviatrixControllerPrivateOobArgs
    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 AviatrixControllerPrivateOobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixControllerPrivateOobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixControllerPrivateOobArgs
    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 aviatrixControllerPrivateOobResource = new Aviatrix.AviatrixControllerPrivateOob("aviatrixControllerPrivateOobResource", new()
    {
        EnablePrivateOob = false,
    });
    
    example, err := aviatrix.NewAviatrixControllerPrivateOob(ctx, "aviatrixControllerPrivateOobResource", &aviatrix.AviatrixControllerPrivateOobArgs{
    	EnablePrivateOob: pulumi.Bool(false),
    })
    
    var aviatrixControllerPrivateOobResource = new AviatrixControllerPrivateOob("aviatrixControllerPrivateOobResource", AviatrixControllerPrivateOobArgs.builder()
        .enablePrivateOob(false)
        .build());
    
    aviatrix_controller_private_oob_resource = aviatrix.AviatrixControllerPrivateOob("aviatrixControllerPrivateOobResource", enable_private_oob=False)
    
    const aviatrixControllerPrivateOobResource = new aviatrix.AviatrixControllerPrivateOob("aviatrixControllerPrivateOobResource", {enablePrivateOob: false});
    
    type: aviatrix:AviatrixControllerPrivateOob
    properties:
        enablePrivateOob: false
    

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

    EnablePrivateOob bool
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    EnablePrivateOob bool
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enablePrivateOob Boolean
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enablePrivateOob boolean
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enable_private_oob bool
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enablePrivateOob Boolean
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.

    Outputs

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

    Get an existing AviatrixControllerPrivateOob 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?: AviatrixControllerPrivateOobState, opts?: CustomResourceOptions): AviatrixControllerPrivateOob
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enable_private_oob: Optional[bool] = None) -> AviatrixControllerPrivateOob
    func GetAviatrixControllerPrivateOob(ctx *Context, name string, id IDInput, state *AviatrixControllerPrivateOobState, opts ...ResourceOption) (*AviatrixControllerPrivateOob, error)
    public static AviatrixControllerPrivateOob Get(string name, Input<string> id, AviatrixControllerPrivateOobState? state, CustomResourceOptions? opts = null)
    public static AviatrixControllerPrivateOob get(String name, Output<String> id, AviatrixControllerPrivateOobState 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:
    EnablePrivateOob bool
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    EnablePrivateOob bool
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enablePrivateOob Boolean
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enablePrivateOob boolean
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enable_private_oob bool
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.
    enablePrivateOob Boolean
    Switch to enable/disable Aviatrix controller private OOB. Valid values: true, false. Default value: false.

    Import

    controller_private_oob can be imported using controller IP, e.g. controller IP is 10.11.12.13

     $ pulumi import aviatrix:index/aviatrixControllerPrivateOob:AviatrixControllerPrivateOob 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.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix