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

aviatrix.AviatrixCopilotAssociation

Explore with Pulumi AI

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

    The aviatrix_copilot_association resource allows management of controller CoPilot Association. This resource is available as of provider version R2.19+.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a CoPilot Association
        var testCopilotAssociation = new Aviatrix.AviatrixCopilotAssociation("testCopilotAssociation", new()
        {
            CopilotAddress = "copilot.aviatrix.com",
        });
    
    });
    
    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.NewAviatrixCopilotAssociation(ctx, "testCopilotAssociation", &aviatrix.AviatrixCopilotAssociationArgs{
    			CopilotAddress: pulumi.String("copilot.aviatrix.com"),
    		})
    		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.AviatrixCopilotAssociation;
    import com.pulumi.aviatrix.AviatrixCopilotAssociationArgs;
    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 testCopilotAssociation = new AviatrixCopilotAssociation("testCopilotAssociation", AviatrixCopilotAssociationArgs.builder()        
                .copilotAddress("copilot.aviatrix.com")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create a CoPilot Association
    test_copilot_association = aviatrix.AviatrixCopilotAssociation("testCopilotAssociation", copilot_address="copilot.aviatrix.com")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create a CoPilot Association
    const testCopilotAssociation = new aviatrix.AviatrixCopilotAssociation("test_copilot_association", {
        copilotAddress: "copilot.aviatrix.com",
    });
    
    resources:
      # Create a CoPilot Association
      testCopilotAssociation:
        type: aviatrix:AviatrixCopilotAssociation
        properties:
          copilotAddress: copilot.aviatrix.com
    

    Create AviatrixCopilotAssociation Resource

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

    Constructor syntax

    new AviatrixCopilotAssociation(name: string, args: AviatrixCopilotAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixCopilotAssociation(resource_name: str,
                                   args: AviatrixCopilotAssociationArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AviatrixCopilotAssociation(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   copilot_address: Optional[str] = None)
    func NewAviatrixCopilotAssociation(ctx *Context, name string, args AviatrixCopilotAssociationArgs, opts ...ResourceOption) (*AviatrixCopilotAssociation, error)
    public AviatrixCopilotAssociation(string name, AviatrixCopilotAssociationArgs args, CustomResourceOptions? opts = null)
    public AviatrixCopilotAssociation(String name, AviatrixCopilotAssociationArgs args)
    public AviatrixCopilotAssociation(String name, AviatrixCopilotAssociationArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixCopilotAssociation
    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 AviatrixCopilotAssociationArgs
    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 AviatrixCopilotAssociationArgs
    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 AviatrixCopilotAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixCopilotAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixCopilotAssociationArgs
    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 aviatrixCopilotAssociationResource = new Aviatrix.AviatrixCopilotAssociation("aviatrixCopilotAssociationResource", new()
    {
        CopilotAddress = "string",
    });
    
    example, err := aviatrix.NewAviatrixCopilotAssociation(ctx, "aviatrixCopilotAssociationResource", &aviatrix.AviatrixCopilotAssociationArgs{
    	CopilotAddress: pulumi.String("string"),
    })
    
    var aviatrixCopilotAssociationResource = new AviatrixCopilotAssociation("aviatrixCopilotAssociationResource", AviatrixCopilotAssociationArgs.builder()
        .copilotAddress("string")
        .build());
    
    aviatrix_copilot_association_resource = aviatrix.AviatrixCopilotAssociation("aviatrixCopilotAssociationResource", copilot_address="string")
    
    const aviatrixCopilotAssociationResource = new aviatrix.AviatrixCopilotAssociation("aviatrixCopilotAssociationResource", {copilotAddress: "string"});
    
    type: aviatrix:AviatrixCopilotAssociation
    properties:
        copilotAddress: string
    

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

    CopilotAddress string
    CoPilot instance IP Address or Hostname.
    CopilotAddress string
    CoPilot instance IP Address or Hostname.
    copilotAddress String
    CoPilot instance IP Address or Hostname.
    copilotAddress string
    CoPilot instance IP Address or Hostname.
    copilot_address str
    CoPilot instance IP Address or Hostname.
    copilotAddress String
    CoPilot instance IP Address or Hostname.

    Outputs

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

    Get an existing AviatrixCopilotAssociation 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?: AviatrixCopilotAssociationState, opts?: CustomResourceOptions): AviatrixCopilotAssociation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            copilot_address: Optional[str] = None) -> AviatrixCopilotAssociation
    func GetAviatrixCopilotAssociation(ctx *Context, name string, id IDInput, state *AviatrixCopilotAssociationState, opts ...ResourceOption) (*AviatrixCopilotAssociation, error)
    public static AviatrixCopilotAssociation Get(string name, Input<string> id, AviatrixCopilotAssociationState? state, CustomResourceOptions? opts = null)
    public static AviatrixCopilotAssociation get(String name, Output<String> id, AviatrixCopilotAssociationState 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:
    CopilotAddress string
    CoPilot instance IP Address or Hostname.
    CopilotAddress string
    CoPilot instance IP Address or Hostname.
    copilotAddress String
    CoPilot instance IP Address or Hostname.
    copilotAddress string
    CoPilot instance IP Address or Hostname.
    copilot_address str
    CoPilot instance IP Address or Hostname.
    copilotAddress String
    CoPilot instance IP Address or Hostname.

    Import

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

     $ pulumi import aviatrix:index/aviatrixCopilotAssociation:AviatrixCopilotAssociation test_copilot_association 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