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

aviatrix.AviatrixCopilotSecurityGroupManagementConfig

Explore with Pulumi AI

The aviatrix_copilot_security_group_management_config resource allows management of controller CoPilot security group management 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(() => 
{
    // Enable the CoPilot Security Group Management
    var test = new Aviatrix.AviatrixCopilotSecurityGroupManagementConfig("test", new()
    {
        AccountName = "aws-account",
        CloudType = 1,
        EnableCopilotSecurityGroupManagement = true,
        InstanceId = "i-1234567890",
        Region = "us-east-1",
        VpcId = "vpc-1234567890",
    });

});
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.NewAviatrixCopilotSecurityGroupManagementConfig(ctx, "test", &aviatrix.AviatrixCopilotSecurityGroupManagementConfigArgs{
			AccountName:                          pulumi.String("aws-account"),
			CloudType:                            pulumi.Int(1),
			EnableCopilotSecurityGroupManagement: pulumi.Bool(true),
			InstanceId:                           pulumi.String("i-1234567890"),
			Region:                               pulumi.String("us-east-1"),
			VpcId:                                pulumi.String("vpc-1234567890"),
		})
		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.AviatrixCopilotSecurityGroupManagementConfig;
import com.pulumi.aviatrix.AviatrixCopilotSecurityGroupManagementConfigArgs;
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 AviatrixCopilotSecurityGroupManagementConfig("test", AviatrixCopilotSecurityGroupManagementConfigArgs.builder()        
            .accountName("aws-account")
            .cloudType(1)
            .enableCopilotSecurityGroupManagement(true)
            .instanceId("i-1234567890")
            .region("us-east-1")
            .vpcId("vpc-1234567890")
            .build());

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

// Enable the CoPilot Security Group Management
const test = new aviatrix.AviatrixCopilotSecurityGroupManagementConfig("test", {
    accountName: "aws-account",
    cloudType: 1,
    enableCopilotSecurityGroupManagement: true,
    instanceId: "i-1234567890",
    region: "us-east-1",
    vpcId: "vpc-1234567890",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Enable the CoPilot Security Group Management
test = aviatrix.AviatrixCopilotSecurityGroupManagementConfig("test",
    account_name="aws-account",
    cloud_type=1,
    enable_copilot_security_group_management=True,
    instance_id="i-1234567890",
    region="us-east-1",
    vpc_id="vpc-1234567890")
Copy
resources:
  # Enable the CoPilot Security Group Management
  test:
    type: aviatrix:AviatrixCopilotSecurityGroupManagementConfig
    properties:
      accountName: aws-account
      cloudType: 1
      enableCopilotSecurityGroupManagement: true
      instanceId: i-1234567890
      region: us-east-1
      vpcId: vpc-1234567890
Copy

Create AviatrixCopilotSecurityGroupManagementConfig Resource

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

Constructor syntax

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

@overload
def AviatrixCopilotSecurityGroupManagementConfig(resource_name: str,
                                                 opts: Optional[ResourceOptions] = None,
                                                 enable_copilot_security_group_management: Optional[bool] = None,
                                                 account_name: Optional[str] = None,
                                                 cloud_type: Optional[int] = None,
                                                 instance_id: Optional[str] = None,
                                                 region: Optional[str] = None,
                                                 vpc_id: Optional[str] = None,
                                                 zone: Optional[str] = None)
func NewAviatrixCopilotSecurityGroupManagementConfig(ctx *Context, name string, args AviatrixCopilotSecurityGroupManagementConfigArgs, opts ...ResourceOption) (*AviatrixCopilotSecurityGroupManagementConfig, error)
public AviatrixCopilotSecurityGroupManagementConfig(string name, AviatrixCopilotSecurityGroupManagementConfigArgs args, CustomResourceOptions? opts = null)
public AviatrixCopilotSecurityGroupManagementConfig(String name, AviatrixCopilotSecurityGroupManagementConfigArgs args)
public AviatrixCopilotSecurityGroupManagementConfig(String name, AviatrixCopilotSecurityGroupManagementConfigArgs args, CustomResourceOptions options)
type: aviatrix:AviatrixCopilotSecurityGroupManagementConfig
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. AviatrixCopilotSecurityGroupManagementConfigArgs
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. AviatrixCopilotSecurityGroupManagementConfigArgs
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. AviatrixCopilotSecurityGroupManagementConfigArgs
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. AviatrixCopilotSecurityGroupManagementConfigArgs
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. AviatrixCopilotSecurityGroupManagementConfigArgs
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 aviatrixCopilotSecurityGroupManagementConfigResource = new Aviatrix.AviatrixCopilotSecurityGroupManagementConfig("aviatrixCopilotSecurityGroupManagementConfigResource", new()
{
    EnableCopilotSecurityGroupManagement = false,
    AccountName = "string",
    CloudType = 0,
    InstanceId = "string",
    Region = "string",
    VpcId = "string",
    Zone = "string",
});
Copy
example, err := aviatrix.NewAviatrixCopilotSecurityGroupManagementConfig(ctx, "aviatrixCopilotSecurityGroupManagementConfigResource", &aviatrix.AviatrixCopilotSecurityGroupManagementConfigArgs{
	EnableCopilotSecurityGroupManagement: pulumi.Bool(false),
	AccountName:                          pulumi.String("string"),
	CloudType:                            pulumi.Int(0),
	InstanceId:                           pulumi.String("string"),
	Region:                               pulumi.String("string"),
	VpcId:                                pulumi.String("string"),
	Zone:                                 pulumi.String("string"),
})
Copy
var aviatrixCopilotSecurityGroupManagementConfigResource = new AviatrixCopilotSecurityGroupManagementConfig("aviatrixCopilotSecurityGroupManagementConfigResource", AviatrixCopilotSecurityGroupManagementConfigArgs.builder()
    .enableCopilotSecurityGroupManagement(false)
    .accountName("string")
    .cloudType(0)
    .instanceId("string")
    .region("string")
    .vpcId("string")
    .zone("string")
    .build());
Copy
aviatrix_copilot_security_group_management_config_resource = aviatrix.AviatrixCopilotSecurityGroupManagementConfig("aviatrixCopilotSecurityGroupManagementConfigResource",
    enable_copilot_security_group_management=False,
    account_name="string",
    cloud_type=0,
    instance_id="string",
    region="string",
    vpc_id="string",
    zone="string")
Copy
const aviatrixCopilotSecurityGroupManagementConfigResource = new aviatrix.AviatrixCopilotSecurityGroupManagementConfig("aviatrixCopilotSecurityGroupManagementConfigResource", {
    enableCopilotSecurityGroupManagement: false,
    accountName: "string",
    cloudType: 0,
    instanceId: "string",
    region: "string",
    vpcId: "string",
    zone: "string",
});
Copy
type: aviatrix:AviatrixCopilotSecurityGroupManagementConfig
properties:
    accountName: string
    cloudType: 0
    enableCopilotSecurityGroupManagement: false
    instanceId: string
    region: string
    vpcId: string
    zone: string
Copy

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

EnableCopilotSecurityGroupManagement This property is required. bool
Switch to enable copilot security group management. Valid values: true, false.
AccountName string
Aviatrix access account name. Required to enable copilot security group management.
CloudType int
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
InstanceId string
CoPilot instance ID. Required to enable copilot security group management.
Region string
Region where CoPilot is deployed. Required and valid for AWS and Azure.
VpcId string
VPC ID. Required to enable copilot security group management.
Zone string
Zone where CoPilot is deployed. Required and valid for GCP.
EnableCopilotSecurityGroupManagement This property is required. bool
Switch to enable copilot security group management. Valid values: true, false.
AccountName string
Aviatrix access account name. Required to enable copilot security group management.
CloudType int
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
InstanceId string
CoPilot instance ID. Required to enable copilot security group management.
Region string
Region where CoPilot is deployed. Required and valid for AWS and Azure.
VpcId string
VPC ID. Required to enable copilot security group management.
Zone string
Zone where CoPilot is deployed. Required and valid for GCP.
enableCopilotSecurityGroupManagement This property is required. Boolean
Switch to enable copilot security group management. Valid values: true, false.
accountName String
Aviatrix access account name. Required to enable copilot security group management.
cloudType Integer
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
instanceId String
CoPilot instance ID. Required to enable copilot security group management.
region String
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpcId String
VPC ID. Required to enable copilot security group management.
zone String
Zone where CoPilot is deployed. Required and valid for GCP.
enableCopilotSecurityGroupManagement This property is required. boolean
Switch to enable copilot security group management. Valid values: true, false.
accountName string
Aviatrix access account name. Required to enable copilot security group management.
cloudType number
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
instanceId string
CoPilot instance ID. Required to enable copilot security group management.
region string
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpcId string
VPC ID. Required to enable copilot security group management.
zone string
Zone where CoPilot is deployed. Required and valid for GCP.
enable_copilot_security_group_management This property is required. bool
Switch to enable copilot security group management. Valid values: true, false.
account_name str
Aviatrix access account name. Required to enable copilot security group management.
cloud_type int
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
instance_id str
CoPilot instance ID. Required to enable copilot security group management.
region str
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpc_id str
VPC ID. Required to enable copilot security group management.
zone str
Zone where CoPilot is deployed. Required and valid for GCP.
enableCopilotSecurityGroupManagement This property is required. Boolean
Switch to enable copilot security group management. Valid values: true, false.
accountName String
Aviatrix access account name. Required to enable copilot security group management.
cloudType Number
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
instanceId String
CoPilot instance ID. Required to enable copilot security group management.
region String
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpcId String
VPC ID. Required to enable copilot security group management.
zone String
Zone where CoPilot is deployed. Required and valid for GCP.

Outputs

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

Get an existing AviatrixCopilotSecurityGroupManagementConfig 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?: AviatrixCopilotSecurityGroupManagementConfigState, opts?: CustomResourceOptions): AviatrixCopilotSecurityGroupManagementConfig
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        cloud_type: Optional[int] = None,
        enable_copilot_security_group_management: Optional[bool] = None,
        instance_id: Optional[str] = None,
        region: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zone: Optional[str] = None) -> AviatrixCopilotSecurityGroupManagementConfig
func GetAviatrixCopilotSecurityGroupManagementConfig(ctx *Context, name string, id IDInput, state *AviatrixCopilotSecurityGroupManagementConfigState, opts ...ResourceOption) (*AviatrixCopilotSecurityGroupManagementConfig, error)
public static AviatrixCopilotSecurityGroupManagementConfig Get(string name, Input<string> id, AviatrixCopilotSecurityGroupManagementConfigState? state, CustomResourceOptions? opts = null)
public static AviatrixCopilotSecurityGroupManagementConfig get(String name, Output<String> id, AviatrixCopilotSecurityGroupManagementConfigState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixCopilotSecurityGroupManagementConfig    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 string
Aviatrix access account name. Required to enable copilot security group management.
CloudType int
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
EnableCopilotSecurityGroupManagement bool
Switch to enable copilot security group management. Valid values: true, false.
InstanceId string
CoPilot instance ID. Required to enable copilot security group management.
Region string
Region where CoPilot is deployed. Required and valid for AWS and Azure.
VpcId string
VPC ID. Required to enable copilot security group management.
Zone string
Zone where CoPilot is deployed. Required and valid for GCP.
AccountName string
Aviatrix access account name. Required to enable copilot security group management.
CloudType int
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
EnableCopilotSecurityGroupManagement bool
Switch to enable copilot security group management. Valid values: true, false.
InstanceId string
CoPilot instance ID. Required to enable copilot security group management.
Region string
Region where CoPilot is deployed. Required and valid for AWS and Azure.
VpcId string
VPC ID. Required to enable copilot security group management.
Zone string
Zone where CoPilot is deployed. Required and valid for GCP.
accountName String
Aviatrix access account name. Required to enable copilot security group management.
cloudType Integer
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
enableCopilotSecurityGroupManagement Boolean
Switch to enable copilot security group management. Valid values: true, false.
instanceId String
CoPilot instance ID. Required to enable copilot security group management.
region String
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpcId String
VPC ID. Required to enable copilot security group management.
zone String
Zone where CoPilot is deployed. Required and valid for GCP.
accountName string
Aviatrix access account name. Required to enable copilot security group management.
cloudType number
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
enableCopilotSecurityGroupManagement boolean
Switch to enable copilot security group management. Valid values: true, false.
instanceId string
CoPilot instance ID. Required to enable copilot security group management.
region string
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpcId string
VPC ID. Required to enable copilot security group management.
zone string
Zone where CoPilot is deployed. Required and valid for GCP.
account_name str
Aviatrix access account name. Required to enable copilot security group management.
cloud_type int
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
enable_copilot_security_group_management bool
Switch to enable copilot security group management. Valid values: true, false.
instance_id str
CoPilot instance ID. Required to enable copilot security group management.
region str
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpc_id str
VPC ID. Required to enable copilot security group management.
zone str
Zone where CoPilot is deployed. Required and valid for GCP.
accountName String
Aviatrix access account name. Required to enable copilot security group management.
cloudType Number
Cloud type. The type of this attribute is Integer. Only support AWS, Azure and OCI. Required to enable copilot security group management.
enableCopilotSecurityGroupManagement Boolean
Switch to enable copilot security group management. Valid values: true, false.
instanceId String
CoPilot instance ID. Required to enable copilot security group management.
region String
Region where CoPilot is deployed. Required and valid for AWS and Azure.
vpcId String
VPC ID. Required to enable copilot security group management.
zone String
Zone where CoPilot is deployed. Required and valid for GCP.

Import

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

 $ pulumi import aviatrix:index/aviatrixCopilotSecurityGroupManagementConfig:AviatrixCopilotSecurityGroupManagementConfig test 10-11-12-13
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.