Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixAccount
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixAccount

Explore with Pulumi AI

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

The aviatrix_account resource allows the creation and management of Aviatrix cloud accounts.

NOTE: With the release of Controller 5.4 (compatible with Aviatrix provider R2.13), Role-Based Access Control (RBAC) is now integrated into the Accounts workflow. Any aviatrix_account created in 5.3 by default will have admin privileges (attached to the ‘admin’ RBAC permission group). In 5.4, any new accounts created will not be attached to any RBAC group unless otherwise specified through the aviatrix_rbac_group_access_account_attachment resource.

Create AviatrixAccount Resource

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

Constructor syntax

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

@overload
def AviatrixAccount(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    account_name: Optional[str] = None,
                    cloud_type: Optional[int] = None,
                    alicloud_access_key: Optional[str] = None,
                    alicloud_account_id: Optional[str] = None,
                    alicloud_secret_key: Optional[str] = None,
                    arm_application_id: Optional[str] = None,
                    arm_application_key: Optional[str] = None,
                    arm_directory_id: Optional[str] = None,
                    arm_subscription_id: Optional[str] = None,
                    audit_account: Optional[bool] = None,
                    aws_access_key: Optional[str] = None,
                    aws_account_number: Optional[str] = None,
                    aws_gateway_role_app: Optional[str] = None,
                    aws_gateway_role_ec2: Optional[str] = None,
                    aws_iam: Optional[bool] = None,
                    aws_role_app: Optional[str] = None,
                    aws_role_ec2: Optional[str] = None,
                    aws_secret_key: Optional[str] = None,
                    awschina_access_key: Optional[str] = None,
                    awschina_account_number: Optional[str] = None,
                    awschina_iam: Optional[bool] = None,
                    awschina_role_app: Optional[str] = None,
                    awschina_role_ec2: Optional[str] = None,
                    awschina_secret_key: Optional[str] = None,
                    awsgov_access_key: Optional[str] = None,
                    awsgov_account_number: Optional[str] = None,
                    awsgov_iam: Optional[bool] = None,
                    awsgov_role_app: Optional[str] = None,
                    awsgov_role_ec2: Optional[str] = None,
                    awsgov_secret_key: Optional[str] = None,
                    awss_account_number: Optional[str] = None,
                    awss_ca_chain_cert: Optional[str] = None,
                    awss_cap_account_name: Optional[str] = None,
                    awss_cap_agency: Optional[str] = None,
                    awss_cap_cert: Optional[str] = None,
                    awss_cap_cert_key: Optional[str] = None,
                    awss_cap_role_name: Optional[str] = None,
                    awss_cap_url: Optional[str] = None,
                    awsts_account_number: Optional[str] = None,
                    awsts_ca_chain_cert: Optional[str] = None,
                    awsts_cap_agency: Optional[str] = None,
                    awsts_cap_cert: Optional[str] = None,
                    awsts_cap_cert_key: Optional[str] = None,
                    awsts_cap_mission: Optional[str] = None,
                    awsts_cap_role_name: Optional[str] = None,
                    awsts_cap_url: Optional[str] = None,
                    azurechina_application_id: Optional[str] = None,
                    azurechina_application_key: Optional[str] = None,
                    azurechina_directory_id: Optional[str] = None,
                    azurechina_subscription_id: Optional[str] = None,
                    azuregov_application_id: Optional[str] = None,
                    azuregov_application_key: Optional[str] = None,
                    azuregov_directory_id: Optional[str] = None,
                    azuregov_subscription_id: Optional[str] = None,
                    gcloud_project_credentials_filepath: Optional[str] = None,
                    gcloud_project_id: Optional[str] = None,
                    oci_api_private_key_filepath: Optional[str] = None,
                    oci_compartment_id: Optional[str] = None,
                    oci_tenancy_id: Optional[str] = None,
                    oci_user_id: Optional[str] = None,
                    rbac_groups: Optional[Sequence[str]] = None)
func NewAviatrixAccount(ctx *Context, name string, args AviatrixAccountArgs, opts ...ResourceOption) (*AviatrixAccount, error)
public AviatrixAccount(string name, AviatrixAccountArgs args, CustomResourceOptions? opts = null)
public AviatrixAccount(String name, AviatrixAccountArgs args)
public AviatrixAccount(String name, AviatrixAccountArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixAccount
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. AviatrixAccountArgs
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. AviatrixAccountArgs
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. AviatrixAccountArgs
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. AviatrixAccountArgs
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. AviatrixAccountArgs
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 aviatrixAccountResource = new Aviatrix.AviatrixAccount("aviatrixAccountResource", new()
{
    AccountName = "string",
    CloudType = 0,
    AlicloudAccessKey = "string",
    AlicloudAccountId = "string",
    AlicloudSecretKey = "string",
    ArmApplicationId = "string",
    ArmApplicationKey = "string",
    ArmDirectoryId = "string",
    ArmSubscriptionId = "string",
    AuditAccount = false,
    AwsAccessKey = "string",
    AwsAccountNumber = "string",
    AwsGatewayRoleApp = "string",
    AwsGatewayRoleEc2 = "string",
    AwsIam = false,
    AwsRoleApp = "string",
    AwsRoleEc2 = "string",
    AwsSecretKey = "string",
    AwschinaAccessKey = "string",
    AwschinaAccountNumber = "string",
    AwschinaIam = false,
    AwschinaRoleApp = "string",
    AwschinaRoleEc2 = "string",
    AwschinaSecretKey = "string",
    AwsgovAccessKey = "string",
    AwsgovAccountNumber = "string",
    AwsgovIam = false,
    AwsgovRoleApp = "string",
    AwsgovRoleEc2 = "string",
    AwsgovSecretKey = "string",
    AwssAccountNumber = "string",
    AwssCaChainCert = "string",
    AwssCapAccountName = "string",
    AwssCapAgency = "string",
    AwssCapCert = "string",
    AwssCapCertKey = "string",
    AwssCapRoleName = "string",
    AwssCapUrl = "string",
    AwstsAccountNumber = "string",
    AwstsCaChainCert = "string",
    AwstsCapAgency = "string",
    AwstsCapCert = "string",
    AwstsCapCertKey = "string",
    AwstsCapMission = "string",
    AwstsCapRoleName = "string",
    AwstsCapUrl = "string",
    AzurechinaApplicationId = "string",
    AzurechinaApplicationKey = "string",
    AzurechinaDirectoryId = "string",
    AzurechinaSubscriptionId = "string",
    AzuregovApplicationId = "string",
    AzuregovApplicationKey = "string",
    AzuregovDirectoryId = "string",
    AzuregovSubscriptionId = "string",
    GcloudProjectCredentialsFilepath = "string",
    GcloudProjectId = "string",
    OciApiPrivateKeyFilepath = "string",
    OciCompartmentId = "string",
    OciTenancyId = "string",
    OciUserId = "string",
    RbacGroups = new[]
    {
        "string",
    },
});
Copy
example, err := aviatrix.NewAviatrixAccount(ctx, "aviatrixAccountResource", &aviatrix.AviatrixAccountArgs{
	AccountName:                      pulumi.String("string"),
	CloudType:                        pulumi.Int(0),
	AlicloudAccessKey:                pulumi.String("string"),
	AlicloudAccountId:                pulumi.String("string"),
	AlicloudSecretKey:                pulumi.String("string"),
	ArmApplicationId:                 pulumi.String("string"),
	ArmApplicationKey:                pulumi.String("string"),
	ArmDirectoryId:                   pulumi.String("string"),
	ArmSubscriptionId:                pulumi.String("string"),
	AuditAccount:                     pulumi.Bool(false),
	AwsAccessKey:                     pulumi.String("string"),
	AwsAccountNumber:                 pulumi.String("string"),
	AwsGatewayRoleApp:                pulumi.String("string"),
	AwsGatewayRoleEc2:                pulumi.String("string"),
	AwsIam:                           pulumi.Bool(false),
	AwsRoleApp:                       pulumi.String("string"),
	AwsRoleEc2:                       pulumi.String("string"),
	AwsSecretKey:                     pulumi.String("string"),
	AwschinaAccessKey:                pulumi.String("string"),
	AwschinaAccountNumber:            pulumi.String("string"),
	AwschinaIam:                      pulumi.Bool(false),
	AwschinaRoleApp:                  pulumi.String("string"),
	AwschinaRoleEc2:                  pulumi.String("string"),
	AwschinaSecretKey:                pulumi.String("string"),
	AwsgovAccessKey:                  pulumi.String("string"),
	AwsgovAccountNumber:              pulumi.String("string"),
	AwsgovIam:                        pulumi.Bool(false),
	AwsgovRoleApp:                    pulumi.String("string"),
	AwsgovRoleEc2:                    pulumi.String("string"),
	AwsgovSecretKey:                  pulumi.String("string"),
	AwssAccountNumber:                pulumi.String("string"),
	AwssCaChainCert:                  pulumi.String("string"),
	AwssCapAccountName:               pulumi.String("string"),
	AwssCapAgency:                    pulumi.String("string"),
	AwssCapCert:                      pulumi.String("string"),
	AwssCapCertKey:                   pulumi.String("string"),
	AwssCapRoleName:                  pulumi.String("string"),
	AwssCapUrl:                       pulumi.String("string"),
	AwstsAccountNumber:               pulumi.String("string"),
	AwstsCaChainCert:                 pulumi.String("string"),
	AwstsCapAgency:                   pulumi.String("string"),
	AwstsCapCert:                     pulumi.String("string"),
	AwstsCapCertKey:                  pulumi.String("string"),
	AwstsCapMission:                  pulumi.String("string"),
	AwstsCapRoleName:                 pulumi.String("string"),
	AwstsCapUrl:                      pulumi.String("string"),
	AzurechinaApplicationId:          pulumi.String("string"),
	AzurechinaApplicationKey:         pulumi.String("string"),
	AzurechinaDirectoryId:            pulumi.String("string"),
	AzurechinaSubscriptionId:         pulumi.String("string"),
	AzuregovApplicationId:            pulumi.String("string"),
	AzuregovApplicationKey:           pulumi.String("string"),
	AzuregovDirectoryId:              pulumi.String("string"),
	AzuregovSubscriptionId:           pulumi.String("string"),
	GcloudProjectCredentialsFilepath: pulumi.String("string"),
	GcloudProjectId:                  pulumi.String("string"),
	OciApiPrivateKeyFilepath:         pulumi.String("string"),
	OciCompartmentId:                 pulumi.String("string"),
	OciTenancyId:                     pulumi.String("string"),
	OciUserId:                        pulumi.String("string"),
	RbacGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var aviatrixAccountResource = new AviatrixAccount("aviatrixAccountResource", AviatrixAccountArgs.builder()
    .accountName("string")
    .cloudType(0)
    .alicloudAccessKey("string")
    .alicloudAccountId("string")
    .alicloudSecretKey("string")
    .armApplicationId("string")
    .armApplicationKey("string")
    .armDirectoryId("string")
    .armSubscriptionId("string")
    .auditAccount(false)
    .awsAccessKey("string")
    .awsAccountNumber("string")
    .awsGatewayRoleApp("string")
    .awsGatewayRoleEc2("string")
    .awsIam(false)
    .awsRoleApp("string")
    .awsRoleEc2("string")
    .awsSecretKey("string")
    .awschinaAccessKey("string")
    .awschinaAccountNumber("string")
    .awschinaIam(false)
    .awschinaRoleApp("string")
    .awschinaRoleEc2("string")
    .awschinaSecretKey("string")
    .awsgovAccessKey("string")
    .awsgovAccountNumber("string")
    .awsgovIam(false)
    .awsgovRoleApp("string")
    .awsgovRoleEc2("string")
    .awsgovSecretKey("string")
    .awssAccountNumber("string")
    .awssCaChainCert("string")
    .awssCapAccountName("string")
    .awssCapAgency("string")
    .awssCapCert("string")
    .awssCapCertKey("string")
    .awssCapRoleName("string")
    .awssCapUrl("string")
    .awstsAccountNumber("string")
    .awstsCaChainCert("string")
    .awstsCapAgency("string")
    .awstsCapCert("string")
    .awstsCapCertKey("string")
    .awstsCapMission("string")
    .awstsCapRoleName("string")
    .awstsCapUrl("string")
    .azurechinaApplicationId("string")
    .azurechinaApplicationKey("string")
    .azurechinaDirectoryId("string")
    .azurechinaSubscriptionId("string")
    .azuregovApplicationId("string")
    .azuregovApplicationKey("string")
    .azuregovDirectoryId("string")
    .azuregovSubscriptionId("string")
    .gcloudProjectCredentialsFilepath("string")
    .gcloudProjectId("string")
    .ociApiPrivateKeyFilepath("string")
    .ociCompartmentId("string")
    .ociTenancyId("string")
    .ociUserId("string")
    .rbacGroups("string")
    .build());
Copy
aviatrix_account_resource = aviatrix.AviatrixAccount("aviatrixAccountResource",
    account_name="string",
    cloud_type=0,
    alicloud_access_key="string",
    alicloud_account_id="string",
    alicloud_secret_key="string",
    arm_application_id="string",
    arm_application_key="string",
    arm_directory_id="string",
    arm_subscription_id="string",
    audit_account=False,
    aws_access_key="string",
    aws_account_number="string",
    aws_gateway_role_app="string",
    aws_gateway_role_ec2="string",
    aws_iam=False,
    aws_role_app="string",
    aws_role_ec2="string",
    aws_secret_key="string",
    awschina_access_key="string",
    awschina_account_number="string",
    awschina_iam=False,
    awschina_role_app="string",
    awschina_role_ec2="string",
    awschina_secret_key="string",
    awsgov_access_key="string",
    awsgov_account_number="string",
    awsgov_iam=False,
    awsgov_role_app="string",
    awsgov_role_ec2="string",
    awsgov_secret_key="string",
    awss_account_number="string",
    awss_ca_chain_cert="string",
    awss_cap_account_name="string",
    awss_cap_agency="string",
    awss_cap_cert="string",
    awss_cap_cert_key="string",
    awss_cap_role_name="string",
    awss_cap_url="string",
    awsts_account_number="string",
    awsts_ca_chain_cert="string",
    awsts_cap_agency="string",
    awsts_cap_cert="string",
    awsts_cap_cert_key="string",
    awsts_cap_mission="string",
    awsts_cap_role_name="string",
    awsts_cap_url="string",
    azurechina_application_id="string",
    azurechina_application_key="string",
    azurechina_directory_id="string",
    azurechina_subscription_id="string",
    azuregov_application_id="string",
    azuregov_application_key="string",
    azuregov_directory_id="string",
    azuregov_subscription_id="string",
    gcloud_project_credentials_filepath="string",
    gcloud_project_id="string",
    oci_api_private_key_filepath="string",
    oci_compartment_id="string",
    oci_tenancy_id="string",
    oci_user_id="string",
    rbac_groups=["string"])
Copy
const aviatrixAccountResource = new aviatrix.AviatrixAccount("aviatrixAccountResource", {
    accountName: "string",
    cloudType: 0,
    alicloudAccessKey: "string",
    alicloudAccountId: "string",
    alicloudSecretKey: "string",
    armApplicationId: "string",
    armApplicationKey: "string",
    armDirectoryId: "string",
    armSubscriptionId: "string",
    auditAccount: false,
    awsAccessKey: "string",
    awsAccountNumber: "string",
    awsGatewayRoleApp: "string",
    awsGatewayRoleEc2: "string",
    awsIam: false,
    awsRoleApp: "string",
    awsRoleEc2: "string",
    awsSecretKey: "string",
    awschinaAccessKey: "string",
    awschinaAccountNumber: "string",
    awschinaIam: false,
    awschinaRoleApp: "string",
    awschinaRoleEc2: "string",
    awschinaSecretKey: "string",
    awsgovAccessKey: "string",
    awsgovAccountNumber: "string",
    awsgovIam: false,
    awsgovRoleApp: "string",
    awsgovRoleEc2: "string",
    awsgovSecretKey: "string",
    awssAccountNumber: "string",
    awssCaChainCert: "string",
    awssCapAccountName: "string",
    awssCapAgency: "string",
    awssCapCert: "string",
    awssCapCertKey: "string",
    awssCapRoleName: "string",
    awssCapUrl: "string",
    awstsAccountNumber: "string",
    awstsCaChainCert: "string",
    awstsCapAgency: "string",
    awstsCapCert: "string",
    awstsCapCertKey: "string",
    awstsCapMission: "string",
    awstsCapRoleName: "string",
    awstsCapUrl: "string",
    azurechinaApplicationId: "string",
    azurechinaApplicationKey: "string",
    azurechinaDirectoryId: "string",
    azurechinaSubscriptionId: "string",
    azuregovApplicationId: "string",
    azuregovApplicationKey: "string",
    azuregovDirectoryId: "string",
    azuregovSubscriptionId: "string",
    gcloudProjectCredentialsFilepath: "string",
    gcloudProjectId: "string",
    ociApiPrivateKeyFilepath: "string",
    ociCompartmentId: "string",
    ociTenancyId: "string",
    ociUserId: "string",
    rbacGroups: ["string"],
});
Copy
type: aviatrix:AviatrixAccount
properties:
    accountName: string
    alicloudAccessKey: string
    alicloudAccountId: string
    alicloudSecretKey: string
    armApplicationId: string
    armApplicationKey: string
    armDirectoryId: string
    armSubscriptionId: string
    auditAccount: false
    awsAccessKey: string
    awsAccountNumber: string
    awsGatewayRoleApp: string
    awsGatewayRoleEc2: string
    awsIam: false
    awsRoleApp: string
    awsRoleEc2: string
    awsSecretKey: string
    awschinaAccessKey: string
    awschinaAccountNumber: string
    awschinaIam: false
    awschinaRoleApp: string
    awschinaRoleEc2: string
    awschinaSecretKey: string
    awsgovAccessKey: string
    awsgovAccountNumber: string
    awsgovIam: false
    awsgovRoleApp: string
    awsgovRoleEc2: string
    awsgovSecretKey: string
    awssAccountNumber: string
    awssCaChainCert: string
    awssCapAccountName: string
    awssCapAgency: string
    awssCapCert: string
    awssCapCertKey: string
    awssCapRoleName: string
    awssCapUrl: string
    awstsAccountNumber: string
    awstsCaChainCert: string
    awstsCapAgency: string
    awstsCapCert: string
    awstsCapCertKey: string
    awstsCapMission: string
    awstsCapRoleName: string
    awstsCapUrl: string
    azurechinaApplicationId: string
    azurechinaApplicationKey: string
    azurechinaDirectoryId: string
    azurechinaSubscriptionId: string
    azuregovApplicationId: string
    azuregovApplicationKey: string
    azuregovDirectoryId: string
    azuregovSubscriptionId: string
    cloudType: 0
    gcloudProjectCredentialsFilepath: string
    gcloudProjectId: string
    ociApiPrivateKeyFilepath: string
    ociCompartmentId: string
    ociTenancyId: string
    ociUserId: string
    rbacGroups:
        - string
Copy

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

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Account name. This can be used for logging in to CloudN console or UserConnect controller.
CloudType This property is required. int
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
AlicloudAccessKey string
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
AlicloudAccountId string
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
AlicloudSecretKey string
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
ArmApplicationId string
Azure ARM Application ID. Required when creating an account for Azure.
ArmApplicationKey string
Azure ARM Application key. Required when creating an account for Azure.
ArmDirectoryId string
Azure ARM Directory ID. Required when creating an account for Azure.
ArmSubscriptionId string
Azure ARM Subscription ID. Required when creating an account for Azure.
AuditAccount bool
Enable account audit.
AwsAccessKey string
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
AwsAccountNumber string
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
AwsGatewayRoleApp string
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsGatewayRoleEc2 string
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsIam bool
AWS IAM-role based flag, this option is for UserConnect.
AwsRoleApp string
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsRoleEc2 string
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsSecretKey string
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
AwschinaAccessKey string
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaAccountNumber string
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaIam bool
AWSChina IAM-role based flag. Available as of provider version 2.19+.
AwschinaRoleApp string
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaRoleEc2 string
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaSecretKey string
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwsgovAccessKey string
AWS Access Key. Required when creating an account for AWSGov.
AwsgovAccountNumber string
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
AwsgovIam bool
AWSGov IAM-role based flag. Available as of provider version 2.19+.
AwsgovRoleApp string
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovRoleEc2 string
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovSecretKey string
AWS Secret Key. Required when creating an account for AWSGov.
AwssAccountNumber string
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCaChainCert string
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAccountName string
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAgency string
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCert string
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCertKey string
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapRoleName string
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapUrl string
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwstsAccountNumber string
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCaChainCert string
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapAgency string
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCert string
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCertKey string
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapMission string
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapRoleName string
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapUrl string
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AzurechinaApplicationId string
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaApplicationKey string
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaDirectoryId string
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaSubscriptionId string
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzuregovApplicationId string
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovApplicationKey string
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovDirectoryId string
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovSubscriptionId string
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
GcloudProjectCredentialsFilepath string
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
GcloudProjectId string
GCloud Project ID.
OciApiPrivateKeyFilepath string
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
OciCompartmentId string
Oracle OCI Compartment ID. Required when creating an account for OCI.
OciTenancyId string
Oracle OCI Tenancy ID. Required when creating an account for OCI.
OciUserId string
Oracle OCI User ID. Required when creating an account for OCI.
RbacGroups List<string>
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Account name. This can be used for logging in to CloudN console or UserConnect controller.
CloudType This property is required. int
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
AlicloudAccessKey string
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
AlicloudAccountId string
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
AlicloudSecretKey string
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
ArmApplicationId string
Azure ARM Application ID. Required when creating an account for Azure.
ArmApplicationKey string
Azure ARM Application key. Required when creating an account for Azure.
ArmDirectoryId string
Azure ARM Directory ID. Required when creating an account for Azure.
ArmSubscriptionId string
Azure ARM Subscription ID. Required when creating an account for Azure.
AuditAccount bool
Enable account audit.
AwsAccessKey string
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
AwsAccountNumber string
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
AwsGatewayRoleApp string
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsGatewayRoleEc2 string
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsIam bool
AWS IAM-role based flag, this option is for UserConnect.
AwsRoleApp string
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsRoleEc2 string
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsSecretKey string
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
AwschinaAccessKey string
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaAccountNumber string
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaIam bool
AWSChina IAM-role based flag. Available as of provider version 2.19+.
AwschinaRoleApp string
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaRoleEc2 string
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaSecretKey string
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwsgovAccessKey string
AWS Access Key. Required when creating an account for AWSGov.
AwsgovAccountNumber string
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
AwsgovIam bool
AWSGov IAM-role based flag. Available as of provider version 2.19+.
AwsgovRoleApp string
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovRoleEc2 string
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovSecretKey string
AWS Secret Key. Required when creating an account for AWSGov.
AwssAccountNumber string
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCaChainCert string
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAccountName string
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAgency string
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCert string
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCertKey string
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapRoleName string
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapUrl string
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwstsAccountNumber string
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCaChainCert string
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapAgency string
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCert string
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCertKey string
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapMission string
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapRoleName string
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapUrl string
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AzurechinaApplicationId string
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaApplicationKey string
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaDirectoryId string
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaSubscriptionId string
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzuregovApplicationId string
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovApplicationKey string
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovDirectoryId string
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovSubscriptionId string
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
GcloudProjectCredentialsFilepath string
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
GcloudProjectId string
GCloud Project ID.
OciApiPrivateKeyFilepath string
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
OciCompartmentId string
Oracle OCI Compartment ID. Required when creating an account for OCI.
OciTenancyId string
Oracle OCI Tenancy ID. Required when creating an account for OCI.
OciUserId string
Oracle OCI User ID. Required when creating an account for OCI.
RbacGroups []string
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Account name. This can be used for logging in to CloudN console or UserConnect controller.
cloudType This property is required. Integer
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
alicloudAccessKey String
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloudAccountId String
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloudSecretKey String
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
armApplicationId String
Azure ARM Application ID. Required when creating an account for Azure.
armApplicationKey String
Azure ARM Application key. Required when creating an account for Azure.
armDirectoryId String
Azure ARM Directory ID. Required when creating an account for Azure.
armSubscriptionId String
Azure ARM Subscription ID. Required when creating an account for Azure.
auditAccount Boolean
Enable account audit.
awsAccessKey String
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
awsAccountNumber String
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
awsGatewayRoleApp String
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsGatewayRoleEc2 String
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsIam Boolean
AWS IAM-role based flag, this option is for UserConnect.
awsRoleApp String
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsRoleEc2 String
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsSecretKey String
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschinaAccessKey String
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaAccountNumber String
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaIam Boolean
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschinaRoleApp String
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaRoleEc2 String
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaSecretKey String
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgovAccessKey String
AWS Access Key. Required when creating an account for AWSGov.
awsgovAccountNumber String
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgovIam Boolean
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgovRoleApp String
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovRoleEc2 String
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovSecretKey String
AWS Secret Key. Required when creating an account for AWSGov.
awssAccountNumber String
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCaChainCert String
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAccountName String
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAgency String
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCert String
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKey String
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapRoleName String
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapUrl String
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awstsAccountNumber String
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCaChainCert String
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapAgency String
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCert String
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKey String
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapMission String
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapRoleName String
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapUrl String
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechinaApplicationId String
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaApplicationKey String
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaDirectoryId String
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaSubscriptionId String
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregovApplicationId String
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovApplicationKey String
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovDirectoryId String
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovSubscriptionId String
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
gcloudProjectCredentialsFilepath String
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloudProjectId String
GCloud Project ID.
ociApiPrivateKeyFilepath String
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
ociCompartmentId String
Oracle OCI Compartment ID. Required when creating an account for OCI.
ociTenancyId String
Oracle OCI Tenancy ID. Required when creating an account for OCI.
ociUserId String
Oracle OCI User ID. Required when creating an account for OCI.
rbacGroups List<String>
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Account name. This can be used for logging in to CloudN console or UserConnect controller.
cloudType This property is required. number
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
alicloudAccessKey string
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloudAccountId string
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloudSecretKey string
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
armApplicationId string
Azure ARM Application ID. Required when creating an account for Azure.
armApplicationKey string
Azure ARM Application key. Required when creating an account for Azure.
armDirectoryId string
Azure ARM Directory ID. Required when creating an account for Azure.
armSubscriptionId string
Azure ARM Subscription ID. Required when creating an account for Azure.
auditAccount boolean
Enable account audit.
awsAccessKey string
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
awsAccountNumber string
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
awsGatewayRoleApp string
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsGatewayRoleEc2 string
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsIam boolean
AWS IAM-role based flag, this option is for UserConnect.
awsRoleApp string
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsRoleEc2 string
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsSecretKey string
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschinaAccessKey string
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaAccountNumber string
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaIam boolean
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschinaRoleApp string
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaRoleEc2 string
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaSecretKey string
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgovAccessKey string
AWS Access Key. Required when creating an account for AWSGov.
awsgovAccountNumber string
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgovIam boolean
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgovRoleApp string
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovRoleEc2 string
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovSecretKey string
AWS Secret Key. Required when creating an account for AWSGov.
awssAccountNumber string
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCaChainCert string
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAccountName string
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAgency string
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCert string
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKey string
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapRoleName string
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapUrl string
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awstsAccountNumber string
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCaChainCert string
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapAgency string
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCert string
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKey string
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapMission string
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapRoleName string
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapUrl string
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechinaApplicationId string
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaApplicationKey string
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaDirectoryId string
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaSubscriptionId string
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregovApplicationId string
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovApplicationKey string
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovDirectoryId string
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovSubscriptionId string
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
gcloudProjectCredentialsFilepath string
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloudProjectId string
GCloud Project ID.
ociApiPrivateKeyFilepath string
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
ociCompartmentId string
Oracle OCI Compartment ID. Required when creating an account for OCI.
ociTenancyId string
Oracle OCI Tenancy ID. Required when creating an account for OCI.
ociUserId string
Oracle OCI User ID. Required when creating an account for OCI.
rbacGroups string[]
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Account name. This can be used for logging in to CloudN console or UserConnect controller.
cloud_type This property is required. int
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
alicloud_access_key str
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloud_account_id str
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloud_secret_key str
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
arm_application_id str
Azure ARM Application ID. Required when creating an account for Azure.
arm_application_key str
Azure ARM Application key. Required when creating an account for Azure.
arm_directory_id str
Azure ARM Directory ID. Required when creating an account for Azure.
arm_subscription_id str
Azure ARM Subscription ID. Required when creating an account for Azure.
audit_account bool
Enable account audit.
aws_access_key str
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
aws_account_number str
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
aws_gateway_role_app str
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
aws_gateway_role_ec2 str
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
aws_iam bool
AWS IAM-role based flag, this option is for UserConnect.
aws_role_app str
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
aws_role_ec2 str
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
aws_secret_key str
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschina_access_key str
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschina_account_number str
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschina_iam bool
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschina_role_app str
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschina_role_ec2 str
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschina_secret_key str
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgov_access_key str
AWS Access Key. Required when creating an account for AWSGov.
awsgov_account_number str
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgov_iam bool
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgov_role_app str
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgov_role_ec2 str
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgov_secret_key str
AWS Secret Key. Required when creating an account for AWSGov.
awss_account_number str
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_ca_chain_cert str
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_account_name str
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_agency str
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_cert str
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_cert_key str
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_role_name str
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_url str
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awsts_account_number str
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_ca_chain_cert str
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_agency str
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_cert str
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_cert_key str
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_mission str
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_role_name str
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_url str
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechina_application_id str
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechina_application_key str
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechina_directory_id str
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechina_subscription_id str
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregov_application_id str
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregov_application_key str
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregov_directory_id str
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregov_subscription_id str
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
gcloud_project_credentials_filepath str
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloud_project_id str
GCloud Project ID.
oci_api_private_key_filepath str
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
oci_compartment_id str
Oracle OCI Compartment ID. Required when creating an account for OCI.
oci_tenancy_id str
Oracle OCI Tenancy ID. Required when creating an account for OCI.
oci_user_id str
Oracle OCI User ID. Required when creating an account for OCI.
rbac_groups Sequence[str]
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Account name. This can be used for logging in to CloudN console or UserConnect controller.
cloudType This property is required. Number
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
alicloudAccessKey String
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloudAccountId String
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloudSecretKey String
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
armApplicationId String
Azure ARM Application ID. Required when creating an account for Azure.
armApplicationKey String
Azure ARM Application key. Required when creating an account for Azure.
armDirectoryId String
Azure ARM Directory ID. Required when creating an account for Azure.
armSubscriptionId String
Azure ARM Subscription ID. Required when creating an account for Azure.
auditAccount Boolean
Enable account audit.
awsAccessKey String
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
awsAccountNumber String
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
awsGatewayRoleApp String
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsGatewayRoleEc2 String
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsIam Boolean
AWS IAM-role based flag, this option is for UserConnect.
awsRoleApp String
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsRoleEc2 String
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsSecretKey String
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschinaAccessKey String
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaAccountNumber String
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaIam Boolean
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschinaRoleApp String
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaRoleEc2 String
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaSecretKey String
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgovAccessKey String
AWS Access Key. Required when creating an account for AWSGov.
awsgovAccountNumber String
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgovIam Boolean
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgovRoleApp String
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovRoleEc2 String
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovSecretKey String
AWS Secret Key. Required when creating an account for AWSGov.
awssAccountNumber String
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCaChainCert String
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAccountName String
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAgency String
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCert String
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKey String
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapRoleName String
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapUrl String
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awstsAccountNumber String
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCaChainCert String
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapAgency String
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCert String
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKey String
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapMission String
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapRoleName String
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapUrl String
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechinaApplicationId String
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaApplicationKey String
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaDirectoryId String
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaSubscriptionId String
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregovApplicationId String
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovApplicationKey String
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovDirectoryId String
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovSubscriptionId String
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
gcloudProjectCredentialsFilepath String
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloudProjectId String
GCloud Project ID.
ociApiPrivateKeyFilepath String
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
ociCompartmentId String
Oracle OCI Compartment ID. Required when creating an account for OCI.
ociTenancyId String
Oracle OCI Tenancy ID. Required when creating an account for OCI.
ociUserId String
Oracle OCI User ID. Required when creating an account for OCI.
rbacGroups List<String>
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixAccount resource produces the following output properties:

AwsCaCertPath string
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
AwssCapCertKeyPath string
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwssCapCertPath string
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
AwstsCapCertKeyPath string
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwstsCapCertPath string
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
Id string
The provider-assigned unique ID for this managed resource.
AwsCaCertPath string
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
AwssCapCertKeyPath string
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwssCapCertPath string
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
AwstsCapCertKeyPath string
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwstsCapCertPath string
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
Id string
The provider-assigned unique ID for this managed resource.
awsCaCertPath String
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
awssCapCertKeyPath String
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awssCapCertPath String
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awstsCapCertKeyPath String
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awstsCapCertPath String
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
id String
The provider-assigned unique ID for this managed resource.
awsCaCertPath string
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
awssCapCertKeyPath string
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awssCapCertPath string
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awstsCapCertKeyPath string
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awstsCapCertPath string
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
id string
The provider-assigned unique ID for this managed resource.
aws_ca_cert_path str
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
awss_cap_cert_key_path str
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awss_cap_cert_path str
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awsts_cap_cert_key_path str
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awsts_cap_cert_path str
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
id str
The provider-assigned unique ID for this managed resource.
awsCaCertPath String
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
awssCapCertKeyPath String
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awssCapCertPath String
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awstsCapCertKeyPath String
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awstsCapCertPath String
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AviatrixAccount Resource

Get an existing AviatrixAccount 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?: AviatrixAccountState, opts?: CustomResourceOptions): AviatrixAccount
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        alicloud_access_key: Optional[str] = None,
        alicloud_account_id: Optional[str] = None,
        alicloud_secret_key: Optional[str] = None,
        arm_application_id: Optional[str] = None,
        arm_application_key: Optional[str] = None,
        arm_directory_id: Optional[str] = None,
        arm_subscription_id: Optional[str] = None,
        audit_account: Optional[bool] = None,
        aws_access_key: Optional[str] = None,
        aws_account_number: Optional[str] = None,
        aws_ca_cert_path: Optional[str] = None,
        aws_gateway_role_app: Optional[str] = None,
        aws_gateway_role_ec2: Optional[str] = None,
        aws_iam: Optional[bool] = None,
        aws_role_app: Optional[str] = None,
        aws_role_ec2: Optional[str] = None,
        aws_secret_key: Optional[str] = None,
        awschina_access_key: Optional[str] = None,
        awschina_account_number: Optional[str] = None,
        awschina_iam: Optional[bool] = None,
        awschina_role_app: Optional[str] = None,
        awschina_role_ec2: Optional[str] = None,
        awschina_secret_key: Optional[str] = None,
        awsgov_access_key: Optional[str] = None,
        awsgov_account_number: Optional[str] = None,
        awsgov_iam: Optional[bool] = None,
        awsgov_role_app: Optional[str] = None,
        awsgov_role_ec2: Optional[str] = None,
        awsgov_secret_key: Optional[str] = None,
        awss_account_number: Optional[str] = None,
        awss_ca_chain_cert: Optional[str] = None,
        awss_cap_account_name: Optional[str] = None,
        awss_cap_agency: Optional[str] = None,
        awss_cap_cert: Optional[str] = None,
        awss_cap_cert_key: Optional[str] = None,
        awss_cap_cert_key_path: Optional[str] = None,
        awss_cap_cert_path: Optional[str] = None,
        awss_cap_role_name: Optional[str] = None,
        awss_cap_url: Optional[str] = None,
        awsts_account_number: Optional[str] = None,
        awsts_ca_chain_cert: Optional[str] = None,
        awsts_cap_agency: Optional[str] = None,
        awsts_cap_cert: Optional[str] = None,
        awsts_cap_cert_key: Optional[str] = None,
        awsts_cap_cert_key_path: Optional[str] = None,
        awsts_cap_cert_path: Optional[str] = None,
        awsts_cap_mission: Optional[str] = None,
        awsts_cap_role_name: Optional[str] = None,
        awsts_cap_url: Optional[str] = None,
        azurechina_application_id: Optional[str] = None,
        azurechina_application_key: Optional[str] = None,
        azurechina_directory_id: Optional[str] = None,
        azurechina_subscription_id: Optional[str] = None,
        azuregov_application_id: Optional[str] = None,
        azuregov_application_key: Optional[str] = None,
        azuregov_directory_id: Optional[str] = None,
        azuregov_subscription_id: Optional[str] = None,
        cloud_type: Optional[int] = None,
        gcloud_project_credentials_filepath: Optional[str] = None,
        gcloud_project_id: Optional[str] = None,
        oci_api_private_key_filepath: Optional[str] = None,
        oci_compartment_id: Optional[str] = None,
        oci_tenancy_id: Optional[str] = None,
        oci_user_id: Optional[str] = None,
        rbac_groups: Optional[Sequence[str]] = None) -> AviatrixAccount
func GetAviatrixAccount(ctx *Context, name string, id IDInput, state *AviatrixAccountState, opts ...ResourceOption) (*AviatrixAccount, error)
public static AviatrixAccount Get(string name, Input<string> id, AviatrixAccountState? state, CustomResourceOptions? opts = null)
public static AviatrixAccount get(String name, Output<String> id, AviatrixAccountState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixAccount    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 Changes to this property will trigger replacement. string
Account name. This can be used for logging in to CloudN console or UserConnect controller.
AlicloudAccessKey string
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
AlicloudAccountId string
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
AlicloudSecretKey string
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
ArmApplicationId string
Azure ARM Application ID. Required when creating an account for Azure.
ArmApplicationKey string
Azure ARM Application key. Required when creating an account for Azure.
ArmDirectoryId string
Azure ARM Directory ID. Required when creating an account for Azure.
ArmSubscriptionId string
Azure ARM Subscription ID. Required when creating an account for Azure.
AuditAccount bool
Enable account audit.
AwsAccessKey string
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
AwsAccountNumber string
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
AwsCaCertPath string
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
AwsGatewayRoleApp string
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsGatewayRoleEc2 string
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsIam bool
AWS IAM-role based flag, this option is for UserConnect.
AwsRoleApp string
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsRoleEc2 string
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsSecretKey string
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
AwschinaAccessKey string
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaAccountNumber string
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaIam bool
AWSChina IAM-role based flag. Available as of provider version 2.19+.
AwschinaRoleApp string
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaRoleEc2 string
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaSecretKey string
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwsgovAccessKey string
AWS Access Key. Required when creating an account for AWSGov.
AwsgovAccountNumber string
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
AwsgovIam bool
AWSGov IAM-role based flag. Available as of provider version 2.19+.
AwsgovRoleApp string
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovRoleEc2 string
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovSecretKey string
AWS Secret Key. Required when creating an account for AWSGov.
AwssAccountNumber string
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCaChainCert string
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAccountName string
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAgency string
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCert string
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCertKey string
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCertKeyPath string
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwssCapCertPath string
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
AwssCapRoleName string
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapUrl string
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwstsAccountNumber string
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCaChainCert string
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapAgency string
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCert string
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCertKey string
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCertKeyPath string
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwstsCapCertPath string
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
AwstsCapMission string
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapRoleName string
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapUrl string
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AzurechinaApplicationId string
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaApplicationKey string
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaDirectoryId string
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaSubscriptionId string
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzuregovApplicationId string
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovApplicationKey string
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovDirectoryId string
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovSubscriptionId string
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
CloudType int
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
GcloudProjectCredentialsFilepath string
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
GcloudProjectId string
GCloud Project ID.
OciApiPrivateKeyFilepath string
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
OciCompartmentId string
Oracle OCI Compartment ID. Required when creating an account for OCI.
OciTenancyId string
Oracle OCI Tenancy ID. Required when creating an account for OCI.
OciUserId string
Oracle OCI User ID. Required when creating an account for OCI.
RbacGroups List<string>
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
AccountName Changes to this property will trigger replacement. string
Account name. This can be used for logging in to CloudN console or UserConnect controller.
AlicloudAccessKey string
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
AlicloudAccountId string
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
AlicloudSecretKey string
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
ArmApplicationId string
Azure ARM Application ID. Required when creating an account for Azure.
ArmApplicationKey string
Azure ARM Application key. Required when creating an account for Azure.
ArmDirectoryId string
Azure ARM Directory ID. Required when creating an account for Azure.
ArmSubscriptionId string
Azure ARM Subscription ID. Required when creating an account for Azure.
AuditAccount bool
Enable account audit.
AwsAccessKey string
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
AwsAccountNumber string
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
AwsCaCertPath string
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
AwsGatewayRoleApp string
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsGatewayRoleEc2 string
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
AwsIam bool
AWS IAM-role based flag, this option is for UserConnect.
AwsRoleApp string
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsRoleEc2 string
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
AwsSecretKey string
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
AwschinaAccessKey string
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaAccountNumber string
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
AwschinaIam bool
AWSChina IAM-role based flag. Available as of provider version 2.19+.
AwschinaRoleApp string
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaRoleEc2 string
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwschinaSecretKey string
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
AwsgovAccessKey string
AWS Access Key. Required when creating an account for AWSGov.
AwsgovAccountNumber string
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
AwsgovIam bool
AWSGov IAM-role based flag. Available as of provider version 2.19+.
AwsgovRoleApp string
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovRoleEc2 string
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
AwsgovSecretKey string
AWS Secret Key. Required when creating an account for AWSGov.
AwssAccountNumber string
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCaChainCert string
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAccountName string
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapAgency string
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCert string
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCertKey string
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapCertKeyPath string
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwssCapCertPath string
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
AwssCapRoleName string
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwssCapUrl string
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
AwstsAccountNumber string
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCaChainCert string
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapAgency string
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCert string
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCertKey string
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapCertKeyPath string
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
AwstsCapCertPath string
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
AwstsCapMission string
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapRoleName string
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AwstsCapUrl string
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
AzurechinaApplicationId string
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaApplicationKey string
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaDirectoryId string
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzurechinaSubscriptionId string
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
AzuregovApplicationId string
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovApplicationKey string
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovDirectoryId string
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
AzuregovSubscriptionId string
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
CloudType int
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
GcloudProjectCredentialsFilepath string
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
GcloudProjectId string
GCloud Project ID.
OciApiPrivateKeyFilepath string
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
OciCompartmentId string
Oracle OCI Compartment ID. Required when creating an account for OCI.
OciTenancyId string
Oracle OCI Tenancy ID. Required when creating an account for OCI.
OciUserId string
Oracle OCI User ID. Required when creating an account for OCI.
RbacGroups []string
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
accountName Changes to this property will trigger replacement. String
Account name. This can be used for logging in to CloudN console or UserConnect controller.
alicloudAccessKey String
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloudAccountId String
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloudSecretKey String
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
armApplicationId String
Azure ARM Application ID. Required when creating an account for Azure.
armApplicationKey String
Azure ARM Application key. Required when creating an account for Azure.
armDirectoryId String
Azure ARM Directory ID. Required when creating an account for Azure.
armSubscriptionId String
Azure ARM Subscription ID. Required when creating an account for Azure.
auditAccount Boolean
Enable account audit.
awsAccessKey String
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
awsAccountNumber String
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
awsCaCertPath String
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
awsGatewayRoleApp String
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsGatewayRoleEc2 String
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsIam Boolean
AWS IAM-role based flag, this option is for UserConnect.
awsRoleApp String
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsRoleEc2 String
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsSecretKey String
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschinaAccessKey String
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaAccountNumber String
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaIam Boolean
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschinaRoleApp String
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaRoleEc2 String
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaSecretKey String
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgovAccessKey String
AWS Access Key. Required when creating an account for AWSGov.
awsgovAccountNumber String
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgovIam Boolean
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgovRoleApp String
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovRoleEc2 String
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovSecretKey String
AWS Secret Key. Required when creating an account for AWSGov.
awssAccountNumber String
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCaChainCert String
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAccountName String
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAgency String
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCert String
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKey String
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKeyPath String
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awssCapCertPath String
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awssCapRoleName String
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapUrl String
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awstsAccountNumber String
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCaChainCert String
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapAgency String
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCert String
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKey String
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKeyPath String
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awstsCapCertPath String
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awstsCapMission String
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapRoleName String
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapUrl String
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechinaApplicationId String
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaApplicationKey String
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaDirectoryId String
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaSubscriptionId String
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregovApplicationId String
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovApplicationKey String
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovDirectoryId String
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovSubscriptionId String
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
cloudType Integer
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
gcloudProjectCredentialsFilepath String
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloudProjectId String
GCloud Project ID.
ociApiPrivateKeyFilepath String
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
ociCompartmentId String
Oracle OCI Compartment ID. Required when creating an account for OCI.
ociTenancyId String
Oracle OCI Tenancy ID. Required when creating an account for OCI.
ociUserId String
Oracle OCI User ID. Required when creating an account for OCI.
rbacGroups List<String>
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
accountName Changes to this property will trigger replacement. string
Account name. This can be used for logging in to CloudN console or UserConnect controller.
alicloudAccessKey string
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloudAccountId string
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloudSecretKey string
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
armApplicationId string
Azure ARM Application ID. Required when creating an account for Azure.
armApplicationKey string
Azure ARM Application key. Required when creating an account for Azure.
armDirectoryId string
Azure ARM Directory ID. Required when creating an account for Azure.
armSubscriptionId string
Azure ARM Subscription ID. Required when creating an account for Azure.
auditAccount boolean
Enable account audit.
awsAccessKey string
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
awsAccountNumber string
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
awsCaCertPath string
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
awsGatewayRoleApp string
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsGatewayRoleEc2 string
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsIam boolean
AWS IAM-role based flag, this option is for UserConnect.
awsRoleApp string
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsRoleEc2 string
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsSecretKey string
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschinaAccessKey string
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaAccountNumber string
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaIam boolean
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschinaRoleApp string
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaRoleEc2 string
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaSecretKey string
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgovAccessKey string
AWS Access Key. Required when creating an account for AWSGov.
awsgovAccountNumber string
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgovIam boolean
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgovRoleApp string
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovRoleEc2 string
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovSecretKey string
AWS Secret Key. Required when creating an account for AWSGov.
awssAccountNumber string
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCaChainCert string
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAccountName string
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAgency string
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCert string
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKey string
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKeyPath string
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awssCapCertPath string
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awssCapRoleName string
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapUrl string
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awstsAccountNumber string
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCaChainCert string
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapAgency string
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCert string
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKey string
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKeyPath string
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awstsCapCertPath string
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awstsCapMission string
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapRoleName string
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapUrl string
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechinaApplicationId string
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaApplicationKey string
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaDirectoryId string
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaSubscriptionId string
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregovApplicationId string
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovApplicationKey string
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovDirectoryId string
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovSubscriptionId string
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
cloudType number
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
gcloudProjectCredentialsFilepath string
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloudProjectId string
GCloud Project ID.
ociApiPrivateKeyFilepath string
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
ociCompartmentId string
Oracle OCI Compartment ID. Required when creating an account for OCI.
ociTenancyId string
Oracle OCI Tenancy ID. Required when creating an account for OCI.
ociUserId string
Oracle OCI User ID. Required when creating an account for OCI.
rbacGroups string[]
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
account_name Changes to this property will trigger replacement. str
Account name. This can be used for logging in to CloudN console or UserConnect controller.
alicloud_access_key str
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloud_account_id str
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloud_secret_key str
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
arm_application_id str
Azure ARM Application ID. Required when creating an account for Azure.
arm_application_key str
Azure ARM Application key. Required when creating an account for Azure.
arm_directory_id str
Azure ARM Directory ID. Required when creating an account for Azure.
arm_subscription_id str
Azure ARM Subscription ID. Required when creating an account for Azure.
audit_account bool
Enable account audit.
aws_access_key str
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
aws_account_number str
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
aws_ca_cert_path str
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
aws_gateway_role_app str
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
aws_gateway_role_ec2 str
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
aws_iam bool
AWS IAM-role based flag, this option is for UserConnect.
aws_role_app str
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
aws_role_ec2 str
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
aws_secret_key str
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschina_access_key str
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschina_account_number str
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschina_iam bool
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschina_role_app str
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschina_role_ec2 str
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschina_secret_key str
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgov_access_key str
AWS Access Key. Required when creating an account for AWSGov.
awsgov_account_number str
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgov_iam bool
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgov_role_app str
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgov_role_ec2 str
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgov_secret_key str
AWS Secret Key. Required when creating an account for AWSGov.
awss_account_number str
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_ca_chain_cert str
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_account_name str
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_agency str
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_cert str
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_cert_key str
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_cert_key_path str
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awss_cap_cert_path str
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awss_cap_role_name str
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awss_cap_url str
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awsts_account_number str
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_ca_chain_cert str
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_agency str
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_cert str
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_cert_key str
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_cert_key_path str
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awsts_cap_cert_path str
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awsts_cap_mission str
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_role_name str
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awsts_cap_url str
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechina_application_id str
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechina_application_key str
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechina_directory_id str
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechina_subscription_id str
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregov_application_id str
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregov_application_key str
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregov_directory_id str
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregov_subscription_id str
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
cloud_type int
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
gcloud_project_credentials_filepath str
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloud_project_id str
GCloud Project ID.
oci_api_private_key_filepath str
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
oci_compartment_id str
Oracle OCI Compartment ID. Required when creating an account for OCI.
oci_tenancy_id str
Oracle OCI Tenancy ID. Required when creating an account for OCI.
oci_user_id str
Oracle OCI User ID. Required when creating an account for OCI.
rbac_groups Sequence[str]
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.
accountName Changes to this property will trigger replacement. String
Account name. This can be used for logging in to CloudN console or UserConnect controller.
alicloudAccessKey String
Alibaba Cloud Access Key. Required when creating an account for Alibaba Cloud.
alicloudAccountId String
Alibaba Cloud Account number to associate with Aviatrix account. Required when creating an account for Alibaba Cloud.
alicloudSecretKey String
Alibaba Cloud Secret Key. Required when creating an account for Alibaba Cloud.
armApplicationId String
Azure ARM Application ID. Required when creating an account for Azure.
armApplicationKey String
Azure ARM Application key. Required when creating an account for Azure.
armDirectoryId String
Azure ARM Directory ID. Required when creating an account for Azure.
armSubscriptionId String
Azure ARM Subscription ID. Required when creating an account for Azure.
auditAccount Boolean
Enable account audit.
awsAccessKey String
AWS Access Key. Required when aws_iam is "false" and when creating an account for AWS.
awsAccountNumber String
AWS Account number to associate with Aviatrix account. Required when creating an account for AWS.
awsCaCertPath String
(Optional) AWS Top Secret Region or Secret Region Custom Certificate Authority file name on the controller. Available as of provider R2.19.5+.
awsGatewayRoleApp String
A separate AWS App role ARN to assign to gateways created by the controller. Required when aws_gateway_role_ec2 is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsGatewayRoleEc2 String
A separate AWS EC2 role ARN to assign to gateways created by the controller. Required when aws_gateway_role_app is set. Only allowed when aws_iam, awsgov_iam, or awschina_iam is "true" when creating an account for AWS, AWSGov or AWSChina, respectively. Available as of provider version R2.19+.
awsIam Boolean
AWS IAM-role based flag, this option is for UserConnect.
awsRoleApp String
AWS App role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsRoleEc2 String
AWS EC2 role ARN, this option is for UserConnect. Required when aws_iam is "true" and when creating an account for AWS.
awsSecretKey String
AWS Secret Key. Required when aws_iam is "false" and when creating an account for AWS.
awschinaAccessKey String
AWSChina Access Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaAccountNumber String
AWSChina Account number to associate with Aviatrix account. Required when creating an account for AWSChina. Available as of provider version 2.19+.
awschinaIam Boolean
AWSChina IAM-role based flag. Available as of provider version 2.19+.
awschinaRoleApp String
AWSChina App role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaRoleEc2 String
AWSChina EC2 role ARN. Available when awschina_iam is "true" and when creating an account for AWSChina. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awschinaSecretKey String
AWSChina Secret Key. Required when awschina_iam is "false" and when creating an account for AWSChina. Available as of provider version 2.19+.
awsgovAccessKey String
AWS Access Key. Required when creating an account for AWSGov.
awsgovAccountNumber String
AWSGov Account number to associate with Aviatrix account. Required when creating an account for AWSGov.
awsgovIam Boolean
AWSGov IAM-role based flag. Available as of provider version 2.19+.
awsgovRoleApp String
AWSGov App role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovRoleEc2 String
AWSGov EC2 role ARN. Available when awsgov_iam is "true" and when creating an account for AWSGov. If left empty, the ARN will be computed. Available as of provider version 2.19+.
awsgovSecretKey String
AWS Secret Key. Required when creating an account for AWSGov.
awssAccountNumber String
AWS Secret Region Account Number. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCaChainCert String
AWS Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAccountName String
AWS Secret Region Account Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapAgency String
AWS Secret Region CAP Agency. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCert String
AWS Secret Region CAP Certificate local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKey String
AWS Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapCertKeyPath String
(Optional) AWS Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awssCapCertPath String
(Optional) AWS Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awssCapRoleName String
AWS Secret Region Role Name. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awssCapUrl String
AWS Secret Region CAP Url. Required when creating an account in AWS Secret Region. Available as of provider version R2.19.5+.
awstsAccountNumber String
AWS Top Secret Region Account Number. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCaChainCert String
AWS Top Secret Region Custom Certificate Authority local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapAgency String
AWS Top Secret Region CAP Agency. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCert String
AWS Top Secret Region CAP Certificate local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKey String
AWS Top Secret Region CAP Certificate Key local file path. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapCertKeyPath String
(Optional) AWS Top Secret Region CAP Certificate Key file name on the controller. Available as of provider R2.19.5+.
awstsCapCertPath String
(Optional) AWS Top Secret Region CAP Certificate file name on the controller. Available as of provider R2.19.5+.
awstsCapMission String
AWS Top Secret Region Mission. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapRoleName String
AWS Top Secret Region Role Name. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
awstsCapUrl String
AWS Top Secret Region CAP Url. Required when creating an account in AWS Top Secret Region. Available as of provider version R2.19.5+.
azurechinaApplicationId String
AzureChina ARM Application ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaApplicationKey String
AzureChina ARM Application key. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaDirectoryId String
AzureChina ARM Directory ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azurechinaSubscriptionId String
AzureChina ARM Subscription ID. Required when creating an account for AzureChina. Available as of provider version 2.19+.
azuregovApplicationId String
AzureGov ARM Application ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovApplicationKey String
AzureGov ARM Application key. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovDirectoryId String
AzureGov ARM Directory ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
azuregovSubscriptionId String
AzureGov ARM Subscription ID. Required when creating an account for AzureGov. Available as of provider version R2.19+.
cloudType Number
Type of cloud service provider. Only AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina and Alibaba Cloud are supported currently. Enter 1 for AWS, 4 for GCP, 8 for Azure, 16 for OCI, 32 for AzureGov, 256 for AWSGov, 1024 for AWSChina or 2048 for AzureChina, 8192 for Alibaba Cloud.
gcloudProjectCredentialsFilepath String
GCloud Project Credentials [local filepath].json. Required when creating an account for GCP.
gcloudProjectId String
GCloud Project ID.
ociApiPrivateKeyFilepath String
Oracle OCI API Private Key local file path. Required when creating an account for OCI.
ociCompartmentId String
Oracle OCI Compartment ID. Required when creating an account for OCI.
ociTenancyId String
Oracle OCI Tenancy ID. Required when creating an account for OCI.
ociUserId String
Oracle OCI User ID. Required when creating an account for OCI.
rbacGroups List<String>
A list of existing RBAC group names. This attribute should only be used when creating an account. Updating this attribute will have no effect. Available as of provider version R2.23.0+.

Import

account can be imported using the account_name (when doing import, need to leave sensitive attributes blank), e.g.

 $ pulumi import aviatrix:index/aviatrixAccount:AviatrixAccount test account_name
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.
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix