HuaweiCloud Provider

https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs
Admin
The HuaweiCloud provider for Terraform allows users to interact with and manage various resources...
Tokens:6,381
Snippets:68
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Manage Enterprise Project Lifecycle

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project

Examples demonstrating different behaviors during the destroy operation for an enterprise project.

```hcl
variable "name" {}
variable "description" {}

resource "huaweicloud_enterprise_project" "test" {
  name                    = var.name
  description             = var.description
  skip_disable_on_destroy = true
}
```

```hcl
variable "name" {}
variable "description" {}

resource "huaweicloud_enterprise_project" "test" {
  name        = var.name
  description = var.description
}
```

```hcl
variable "name" {}
variable "description" {}

resource "huaweicloud_enterprise_project" "test" {
  name        = var.name
  description = var.description
  delete_flag = true
}
```

--------------------------------

### Configure Environment Variables

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Use environment variables for authentication. The provider block remains empty when using this method.

```hcl
provider "huaweicloud" {}
```

```bash
$ export HW_ACCESS_KEY="anaccesskey"
$ export HW_SECRET_KEY="asecretkey"
$ export HW_REGION_NAME="cn-north-4"
$ terraform plan
```

--------------------------------

### Configure Static Credentials

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Provide credentials directly in the provider block. Avoid committing these to version control.

```hcl
provider "huaweicloud" {
  region     = "cn-north-4"
  access_key = "my-access-key"
  secret_key = "my-secret-key"
}
```

```hcl
provider "huaweicloud" {
  region         = "cn-north-4"
  access_key     = "my-access-key"
  secret_key     = "my-secret-key"
  security_token = "my-security-token"
}
```

--------------------------------

### Import Enterprise Project

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project

Command to import an existing enterprise project into Terraform state.

```bash
$ terraform import huaweicloud_enterprise_project.test <id>
```

--------------------------------

### Retrieve Enterprise Project Configurations

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_configs

Fetches the current configurations of Enterprise Projects within the HuaweiCloud environment.

```hcl
data "huaweicloud_enterprise_project_configs" "test" {}
```

--------------------------------

### Configure HuaweiCloud Provider for Terraform 0.12

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Legacy configuration syntax for Terraform 0.12 and earlier versions.

```hcl
# Configure the HuaweiCloud Provider
provider "huaweicloud" {
  version    = ">= 1.36.0"
  region     = "cn-north-4"
  access_key = "my-access-key"
  secret_key = "my-secret-key"
}

# Create a VPC
resource "huaweicloud_vpc" "example" {
  name = "my_vpc"
  cidr = "192.168.0.0/16"
}
```

--------------------------------

### Retrieve Enterprise Project Migration Records

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_migrate_record

Basic configuration to fetch migration records for all resources.

```hcl
data "huaweicloud_enterprise_project_migrate_record" "test" {}
```

--------------------------------

### Configure ECS Instance Metadata Service

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Use credentials automatically provided by the ECS instance metadata service when running on Huawei Cloud ECS.

```hcl
provider "huaweicloud" {
  region = "cn-north-4"
}
```

--------------------------------

### data "huaweicloud_enterprise_project_services"

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_services

Retrieves a list of cloud services and resource types supported by EPS.

```APIDOC
## data "huaweicloud_enterprise_project_services"

### Description
Use this data source to get the services supported by EPS within HuaweiCloud.

### Arguments
- **locale** (String) - Optional - Specifies the display language.
- **service** (String) - Optional - Specifies the cloud service name.

### Attributes
- **id** (String) - The data source ID.
- **services** (List) - Indicates the cloud services.
  - **service** (String) - Indicates the cloud service name.
  - **service_i18n_display_name** (String) - Indicates the display name of the cloud service.
  - **resource_types** (List) - Indicates the resource type list.
    - **resource_type** (String) - Indicates the name of the resource type.
    - **resource_type_i18n_display_name** (String) - Indicates the display name of the resource type.
    - **global** (Boolean) - Whether the resource is a global resource.
    - **regions** (List) - Indicates regions supported.

### Example Usage
```
data "huaweicloud_enterprise_project_services" "test" {}
```
```

--------------------------------

### data "huaweicloud_enterprise_project_configs"

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_configs

Retrieves the configurations of Enterprise Projects (EPS) within HuaweiCloud.

```APIDOC
## data "huaweicloud_enterprise_project_configs"

### Description
Use this data source to get the configurations of EPS within HuaweiCloud.

### Example Usage
```hcl
data "huaweicloud_enterprise_project_configs" "test" {}
```

### Attribute Reference
- **id** (string) - The data source ID.
- **support_item_attribute** (list) - The configurations of EPS.

#### support_item_attribute
- **delete_ep_support_attribute** (boolean) - Whether enterprise projects can be deleted.
```

--------------------------------

### Configure Shared Configuration File

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Use a HuaweiCloud CLI configuration file. Ensure encryption is disabled for the file to be readable by Terraform.

```bash
hcloud configure set --cli-auth-encrypt=false
```

```hcl
provider "huaweicloud" {
  shared_config_file = "/home/tf_user/.hcloud/config.json"
  profile            = "customprofile"
}
```

--------------------------------

### huaweicloud_enterprise_project_action

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project_action

Resource for performing operations on an enterprise project.

```APIDOC
## Resource: huaweicloud_enterprise_project_action

### Description
Use this resource to perform a one-time action on an enterprise project within HuaweiCloud. Deleting this resource from the configuration will only remove it from the tfstate file and will not revert the action performed.

### Arguments
- **enterprise_project_id** (String) - Required - The ID of the enterprise project to be operated.
- **action** (String) - Required - The action type to perform. Valid values are "enable" or "disable".

### Attributes
- **id** (String) - The resource ID.

### Example Usage
```hcl
resource "huaweicloud_enterprise_project_action" "test" {
  enterprise_project_id = var.enterprise_project_id
  action                = "disable"
}
```
```

--------------------------------

### Retrieve EPS services

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_services

Fetches the list of services supported by EPS in HuaweiCloud.

```hcl
data "huaweicloud_enterprise_project_services" "test" {}
```

--------------------------------

### Enterprise Project Action Usage

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project_action

Configures an enterprise project action by specifying the project ID and the desired action type.

```hcl
variable "enterprise_project_id" {}

resource "huaweicloud_enterprise_project_action" "test" {
  enterprise_project_id = var.enterprise_project_id
  action                = "disable"
}
```

--------------------------------

### Retrieve EPS resource mapping

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_resources_mapping

Fetches the resource type mapping for Enterprise Projects.

```hcl
data "huaweicloud_enterprise_project_resources_mapping" "test" {}
```

--------------------------------

### Retrieve Enterprise Projects

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_projects

Fetches a list of enterprise projects filtered by a specified name.

```hcl
variable "name" {}

data "huaweicloud_enterprise_projects" "test" {
  name = var.name
}
```

--------------------------------

### Configure HuaweiCloud Provider and VPC Resource

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Standard configuration for Terraform 0.13 and later, including the required providers block and provider authentication.

```hcl
terraform {
  required_providers {
    huaweicloud = {
      source  = "huaweicloud/huaweicloud"
      version = ">= 1.36.0"
    }
  }
}

# Configure the HuaweiCloud Provider
provider "huaweicloud" {
  region     = "cn-north-4"
  access_key = "my-access-key"
  secret_key = "my-secret-key"
}

# Create a VPC
resource "huaweicloud_vpc" "example" {
  name = "my_vpc"
  cidr = "192.168.0.0/16"
}
```

--------------------------------

### Retrieve Enterprise Project Details

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project

Fetches an enterprise project by its name using the huaweicloud_enterprise_project data source.

```hcl
data "huaweicloud_enterprise_project" "test" {
  name = "test"
}
```

--------------------------------

### data "huaweicloud_enterprise_project_associated_resources"

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_associated_resources

Retrieves the list of associated resources for a given EPS resource.

```APIDOC
## data "huaweicloud_enterprise_project_associated_resources"

### Description
Use this data source to get the list of associated resources of an EPS resource within HuaweiCloud.

### Arguments
- **resource_id** (String) - Required - Specifies the resource id.
- **resource_type** (String) - Required - Specifies the resource type.

### Attributes
- **id** (String) - The resource ID.
- **name** (String) - The resource name.
- **type** (String) - The type of associated resource.
- **associated_resources** (List) - The list of the associated resources.
  - **id** (String) - The resource ID.
  - **name** (String) - The resource name.
  - **eip** (String) - The EIP information.
  - **resource_type** (String) - The resource type.
- **errors** (List) - The list of errors.
  - **project_id** (String) - Indicates the project ID.
  - **resource_type** (String) - Indicates the resource type.
  - **resource_id** (String) - Indicates the resource id.
  - **error_code** (String) - Indicates the error code.
  - **error_msg** (String) - Indicates the error message.
```

--------------------------------

### data "huaweicloud_enterprise_project_quotas"

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_quotas

Retrieves the list of quotas for EPS resources within HuaweiCloud.

```APIDOC
## Data Source: huaweicloud_enterprise_project_quotas

### Description
Use this data source to get the list of quotas of EPS resources within HuaweiCloud.

### Arguments
- **region** (String) - Optional - Specifies the region in which to query the resource quotas. If omitted, the provider-level region will be used.

### Attributes
- **id** (String) - The data source ID.
- **quotas** (List) - The list of the resource quotas.

### Quotas Structure
- **quota** (Integer) - The total number of the resource quota.
- **type** (String) - The resource type corresponding to quota.
- **used** (Integer) - The used quota number.

### Example Usage
```hcl
data "huaweicloud_enterprise_project_quotas" "test" {}
```
```

--------------------------------

### huaweicloud_enterprise_project_migrate_record

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_migrate_record

Data source to retrieve resource move records of EPS within HuaweiCloud.

```APIDOC
## Data Source: huaweicloud_enterprise_project_migrate_record

### Description
Use this data source to get the resource move records of EPS within HuaweiCloud.

### Argument Reference
- **resource_id** (String) - Optional - Specifies the resource ID. If omitted, the migration record of all resources will be queried.
- **start_time** (String) - Optional - Specifies the start time. This parameter needs to be used in conjunction with end_time. If omitted, the migration record for the most recent week will be queried. The time format is YYYY-MM-DD hh:mm:ss.
- **end_time** (String) - Optional - Specifies the end time. This parameter needs to be used in conjunction with start_time. If omitted, the migration record for the most recent week will be queried. The time format is YYYY-MM-DD hh:mm:ss.

### Attribute Reference
- **id** (String) - The data source ID.
- **records** (List) - The list of the resource move records.

### migrate-record Structure
- **associated** (Boolean) - Whether associated resources are moved.
- **code** (String) - The response code.
- **message** (String) - The response information.
- **project_id** (String) - The project ID.
- **project_name** (String) - The project name.
- **region_id** (String) - The region ID.
- **event_time** (String) - The event time.
- **user_name** (String) - The user name.
- **operate_type** (String) - The move type.
- **resource_id** (String) - The resource ID.
- **resource_name** (String) - The resource name.
- **resource_type** (String) - The resource type.
- **initiate_ep_id** (String) - The ID of the enterprise project that initiates a resource move.
- **initiate_ep_name** (String) - The name of the enterprise project that initiates a resource move.
- **origin_ep_id** (String) - The ID of the source enterprise project.
- **origin_ep_name** (String) - The name of the source enterprise project.
- **target_ep_id** (String) - The ID of the destination enterprise project.
- **target_ep_name** (String) - The name of the destination enterprise project.
- **exist_failed** (Boolean) - Whether there are failed tasks.
```

--------------------------------

### huaweicloud_enterprise_project

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project

Resource definition for managing an enterprise project in HuaweiCloud.

```APIDOC
## Resource: huaweicloud_enterprise_project

### Description
Use this resource to manage an enterprise project within HuaweiCloud. This resource supports various lifecycle behaviors during destruction, including skipping disablement or explicitly deleting the project.

### Arguments
- **name** (String) - Required - Specifies the name of the enterprise project (1-64 characters, unique in domain).
- **description** (String) - Optional - Specifies the description of the enterprise project.
- **type** (String) - Optional - Specifies the type of the enterprise project (poc or prod). Defaults to prod.
- **enable** (Bool) - Optional - Specifies whether to enable the enterprise project. Defaults to true.
- **skip_disable_on_destroy** (Bool) - Optional - Specifies whether to skip disabling the enterprise project on destroy. Defaults to false.
- **delete_flag** (Bool) - Optional - Specifies whether to delete the enterprise project on destroy. Defaults to false.

### Attributes
- **id** (String) - The ID of the enterprise project.
- **status** (Integer) - The status of the enterprise project (1: enabled, 2: disabled).
- **created_at** (String) - The creation time in UTC.
- **updated_at** (String) - The last modification time in UTC.

### Timeouts
- **create** - Default 5 minutes.
- **update** - Default 5 minutes.
- **delete** - Default 5 minutes.

### Import
Import an existing enterprise project using its ID:
`terraform import huaweicloud_enterprise_project.test <id>`
```

--------------------------------

### data "huaweicloud_enterprise_project_resources_mapping"

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_resources_mapping

Retrieves the resource type mapping of EPS within HuaweiCloud.

```APIDOC
## data "huaweicloud_enterprise_project_resources_mapping"

### Description
Use this data source to get the resource type mapping of EPS (Enterprise Projects) within HuaweiCloud.

### Example Usage
```hcl
data "huaweicloud_enterprise_project_resources_mapping" "test" {}
```

### Attribute Reference
- **id** (string) - The data source ID.
- **resource_mapping** (map) - The resource type mapping of EPS, represented as a key-value pair.
```

--------------------------------

### Retrieve Enterprise Project Quotas

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_quotas

Fetches the list of EPS resource quotas within the configured region.

```hcl
data "huaweicloud_enterprise_project_quotas" "test" {}
```

--------------------------------

### huaweicloud_enterprise_project

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project

Use this data source to retrieve details of an enterprise project from HuaweiCloud.

```APIDOC
## huaweicloud_enterprise_project

### Description
Use this data source to get an enterprise project from HuaweiCloud.

### Arguments
- **name** (String) - Optional - Specifies the enterprise project name. Fuzzy search is supported.
- **id** (String) - Optional - Specifies the ID of an enterprise project. The value 0 indicates enterprise project default.
- **status** (Int) - Optional - Specifies the status of an enterprise project. 1 indicates Enabled, 2 indicates Disabled.

### Attributes
- **id** (String) - The data source ID.
- **description** (String) - Provides supplementary information about the enterprise project.
- **created_at** (String) - Specifies the time (UTC) when the enterprise project was created.
- **updated_at** (String) - Specifies the time (UTC) when the enterprise project was modified.

### Example Usage
```hcl
data "huaweicloud_enterprise_project" "test" {
  name = "test"
}
```
```

--------------------------------

### data "huaweicloud_enterprise_projects"

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_projects

Retrieves a list of enterprise projects based on specified filter criteria.

```APIDOC
## data "huaweicloud_enterprise_projects"

### Description
Use this data source to get the list of EPS enterprise projects.

### Arguments
- **name** (String) - Optional - Specifies the enterprise project name. Fuzzy search is supported.
- **enterprise_project_id** (String) - Optional - Specifies the ID of an enterprise project. The value 0 indicates enterprise project default.
- **status** (Int) - Optional - Specifies the status of an enterprise project. Valid values: 1 (Enabled), 2 (Disabled).
- **type** (String) - Optional - Specifies the type of an enterprise project. Valid values: prod (Commercial project), poc (Test project).

### Attributes
- **id** (String) - Data source ID.
- **enterprise_projects** (List) - All projects that match the filter parameters.

### enterprise_projects Block
- **id** (String) - The ID of the enterprise project.
- **name** (String) - The name of the enterprise project.
- **status** (Int) - The status of the enterprise project.
- **type** (String) - The type of the enterprise project.
- **description** (String) - The description of the enterprise project.
- **created_at** (String) - The time (UTC) when the enterprise project was created.
- **updated_at** (String) - The time (UTC) when the enterprise project was modified.
```

--------------------------------

### Assume Role with OIDC

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Authenticate using an IAM agency and an OIDC identity provider token.

```hcl
provider "huaweicloud" {
  region = "cn-north-4"

  assume_role_with_oidc {
    agency_name   = "agency"
    domain_id     = "agency_domain"
    idp_id        = "idp_id"
    id_token_file = "/Users/tf_user/secrets/oidc-token"
  }
}
```

--------------------------------

### Configure Custom Service Endpoints

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Use the endpoints block to override default service URLs for specific services.

```hcl
provider "huaweicloud" {
  ...
  endpoints = {
    ecs = "https://ecs-customizing-endpoint.com"
  }
}
```

--------------------------------

### Retrieve Enterprise Project Associated Resources

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/enterprise_project_associated_resources

Fetches a list of resources associated with a specified EPS resource using its ID and type.

```hcl
variable "resource_id" {}
variable "resource_type" {}

data "huaweicloud_enterprise_project_associated_resources" "test" {
  resource_id   = var.resource_id
  resource_type = var.resource_type
}
```

--------------------------------

### Ignore Changes on Import

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project

Configuration to ignore specific attributes that are not returned by the API during import.

```hcl
resource "huaweicloud_enterprise_project" "test" {
    ...

  lifecycle {
    ignore_changes = [
      delete_flag,
      skip_disable_on_destroy
    ]
  }
}
```

--------------------------------

### Assume IAM Role

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs

Assume an IAM agency role. Supports role chaining by defining multiple assume_role blocks.

```hcl
provider "huaweicloud" {
  region     = "cn-north-4"
  access_key = "my-access-key"
  secret_key = "my-secret-key"

  assume_role {
    agency_name = "agency"
    domain_name = "agency_domain"
  }
}
```

```hcl
provider "huaweicloud" {
  region     = "cn-north-4"
  access_key = "my-access-key"
  secret_key = "my-secret-key"

  assume_role {
    agency_name = "initial_agency"
    domain_name = "initial_agency_domain"
  }

  assume_role {
    agency_name = "final_agency"
    domain_name = "final_agency_domain"
  }
}
```

--------------------------------

### Grant enterprise project authority

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project_authority

Basic configuration to enable enterprise project capabilities for the current account.

```hcl
resource "huaweicloud_enterprise_project_authority" "test" {}
```

--------------------------------

### huaweicloud_enterprise_project_authority

Source: https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/enterprise_project_authority

Resource used to grant enterprise project capability for the current account.

```APIDOC
## Resource: huaweicloud_enterprise_project_authority

### Description
Use this resource to grant the enterprise project capability for the current account within HuaweiCloud. Note that deleting this resource will not reclaim the enterprise project authorization of the current account.

### Example Usage
```hcl
resource "huaweicloud_enterprise_project_authority" "test" {}
```

### Attribute Reference
- **id** (string) - The resource ID.
```
Tokens:
Raw