Tencentcloud Provider

https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs
Admin
The Tencent Cloud provider for Terraform allows users to manage Tencent Cloud resources through...
Tokens:5,348
Snippets:54
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get TencentCloud Instance Types

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Query available TencentCloud instance types based on specified CPU core count and memory size. This example requests instance types with 1 CPU core and 1 GB of memory.

```terraform
# Get availability instance types
data "tencentcloud_instance_types" "default" {
  cpu_core_count = 1
  memory_size    = 1
}
```

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

### Configure Provider with Shared Credentials Directory (Windows)

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Use shared Tencent Cloud credentials by specifying the 'shared_credentials_dir' and 'profile' in the Terraform configuration. This example is for Windows.

```terraform
provider "tencentcloud" {
  shared_credentials_dir = "C:\\Users\\tf_user\\.tccli"
  profile                = "default"
}
```

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

### Configure Provider with Shared Credentials Directory (Linux/macOS)

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Use shared Tencent Cloud credentials by specifying the 'shared_credentials_dir' and 'profile' in the Terraform configuration. This example is for Linux/macOS.

```terraform
provider "tencentcloud" {
  shared_credentials_dir = "/Users/tf_user/.tccli"
  profile                = "default"
}
```

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

### Get TencentCloud Images

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Retrieve a list of available TencentCloud images, filtering by image type and OS name. This example specifically requests public CentOS images.

```terraform
# Get availability images
data "tencentcloud_images" "default" {
  image_type = ["PUBLIC_IMAGE"]
  os_name    = "centos"
}
```

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

### Get TencentCloud Availability Zones

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Fetch available availability zones for the configured TencentCloud region.

```terraform
# Get availability zones
data "tencentcloud_availability_zones" "default" {}
```

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

### Set MFA Certification via Environment Variables

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configure MFA certification by setting environment variables for serial number, token code, and duration before running 'terraform plan'.

```bash
$ export TENCENTCLOUD_MFA_CERTIFICATION_SERIAL_NUMBER="my-serial-number"
$ export TENCENTCLOUD_MFA_CERTIFICATION_TOKEN_CODE="my-token-code"
$ export TENCENTCLOUD_MFA_CERTIFICATION_DURATION_SECONDS=1800
$ terraform plan
```

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

### Export environment variables for assume role with SAML

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Set environment variables for assume role with SAML parameters, then execute terraform plan.

```bash
$ export TENCENTCLOUD_ASSUME_ROLE_ARN="my-role-arn"
$ export TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME="my-session-name"
$ export TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION=3600
$ export TENCENTCLOUD_ASSUME_ROLE_SAML_ASSERTION="my-saml-assertion"
$ export TENCENTCLOUD_ASSUME_ROLE_PRINCIPAL_ARN="my-principal-arn"
$ terraform plan
```

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

### Set TencentCloud Credentials via Environment Variables

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Sets the TencentCloud Secret ID, Secret Key, and Region using environment variables for authentication. This is an alternative to static credentials.

```bash
$ export TENCENTCLOUD_SECRET_ID="my-secret-id"
$ export TENCENTCLOUD_SECRET_KEY="my-secret-key"
$ export TENCENTCLOUD_REGION="ap-guangzhou"
$ terraform plan
```

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

### Configure assume role with OIDC using web_identity_token_file

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configure assume role with OIDC by providing the path to a file containing the web identity token, along with other role and session details.

```hcl
provider "tencentcloud" {
  assume_role_with_web_identity {
    provider_id             = "OIDC"
    role_arn                = "my-role-arn"
    session_name            = "my-session-name"
    session_duration        = 3600
    web_identity_token_file = "/AbsolutePath/to/your/secrets/web-identity-token-file"
  }
}
```

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

### Create a TencentCloud Instance

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Defines a TencentCloud instance with specified configurations including name, image, type, disk, and network settings. It also associates the instance with a security group.

```terraform
resource "tencentcloud_instance" "web" {
  instance_name              = "web server"
  availability_zone          = data.tencentcloud_availability_zones.default.zones.0.name
  image_id                   = data.tencentcloud_images.default.images.0.image_id
  instance_type              = data.tencentcloud_instance_types.default.instance_types.0.instance_type
  system_disk_type           = "CLOUD_PREMIUM"
  system_disk_size           = 50
  allocate_public_ip         = true
  internet_max_bandwidth_out = 20
  security_groups            = [tencentcloud_security_group.default.id]
  count                      = 1
}
```

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

### Configure assume role with OIDC using role_arn_file

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configure assume role with OIDC by providing the path to a file containing the role ARN, along with session details and web identity token.

```hcl
provider "tencentcloud" {
  assume_role_with_web_identity {
    provider_id        = "OIDC"
    role_arn_file      = "/AbsolutePath/to/your/secrets/role-arn-file"
    session_name       = "my-session-name"
    session_duration   = 3600
    web_identity_token = "my-web-identity-token"
  }
}
```

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

### Configure Provider with MFA Certification

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Authenticate using MFA by providing 'secret_id', 'secret_key', and 'region', along with MFA certification details like 'serial_number', 'token_code', and 'duration_seconds'.

```terraform
provider "tencentcloud" {
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  region     = "ap-guangzhou"

  mfa_certification {
    serial_number    = "qcs::cam:uin/{my-uin}::mfa/softToken"
    token_code       = "523886"
    duration_seconds = 1800
  }
}
```

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

### Enable pod OIDC for TKE

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Enable pod OIDC authentication for the TencentCloud provider within a TKE environment. Ensure CAM OIDC provider and WEBHOOK component are created successfully.

```hcl
provider "tencentcloud" {
  enable_pod_oidc = true
}
```

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

### Configure Provider with CAM Role Name and Assume Role

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Authenticate using 'cam_role_name' first, followed by 'assume_role' configuration for enhanced security. This allows specifying role ARN, session name, policy, duration, and external ID.

```terraform
provider "tencentcloud" {
  cam_role_name = "my-cam-role-name"

  assume_role {
    role_arn         = "my-role-arn"
    session_name     = "my-session-name"
    policy           = "my-role-policy"
    session_duration = 3600
    external_id      = "my-external-id"
  }
}
```

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

### Configure TencentCloud Provider with Environment Variables

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configures the TencentCloud provider to use credentials and region from environment variables (TENCENTCLOUD_SECRET_ID, TENCENTCLOUD_SECRET_KEY, TENCENTCLOUD_REGION).

```terraform
provider "tencentcloud" {}
```

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

### Set Assume Role Credentials via Environment Variables

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Sets assume role configuration parameters (ARN, session name, session duration) using environment variables. This allows dynamic configuration of role assumption.

```bash
$ export TENCENTCLOUD_SECRET_ID="my-secret-id"
$ export TENCENTCLOUD_SECRET_KEY="my-secret-key"
$ export TENCENTCLOUD_REGION="ap-guangzhou"
$ export TENCENTCLOUD_ASSUME_ROLE_ARN="my-role-arn"
$ export TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME="my-session-name"
$ export TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION=3600

```

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

### Configure assume role with SAML in provider block

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configure assume role with SAML by providing role ARN, session name, duration, SAML assertion, and principal ARN directly within the tencentcloud provider block.

```hcl
provider "tencentcloud" {
  assume_role_with_saml {
    role_arn         = "my-role-arn"
    session_name     = "my-session-name"
    session_duration = 3600
    saml_assertion   = "my-saml-assertion"
    principal_arn    = "my-principal-arn"
  }
}
```

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

### Configure TencentCloud Provider with Static Credentials

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configures the TencentCloud provider using static credentials (secret ID and secret key) and a specific region. This method is not recommended for production due to security risks.

```terraform
provider "tencentcloud" {
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  region     = "ap-guangzhou"
}
```

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

### Configure assume role with OIDC using web_identity_token

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configure assume role with OIDC by specifying provider ID, role ARN, session name, duration, and web identity token in the tencentcloud provider block.

```hcl
provider "tencentcloud" {
  assume_role_with_web_identity {
    provider_id        = "OIDC"
    role_arn           = "my-role-arn"
    session_name       = "my-session-name"
    session_duration   = 3600
    web_identity_token = "my-web-identity-token"
  }
}
```

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

### Assume Role with SAML

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configuration block for assuming an IAM role using SAML assertions.

```APIDOC
## Assume Role with SAML

### Description
This block configures authentication by assuming an IAM role using SAML assertions.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **role_arn** (string) - Required - The ARN of the role to assume. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_ARN` environment variable.
- **session_name** (string) - Required - The session name to use when making the AssumeRole call. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME` environment variable.
- **session_duration** (number) - Required - The duration of the session in seconds. Ranges from 0 to 43200, defaults to 7200. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION` environment variable.
- **saml_assertion** (string) - Required - SAML assertion information encoded in base64. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_SAML_ASSERTION` environment variable.
- **principal_arn** (string) - Required - Player Access Description Name. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_PRINCIPAL_ARN` environment variable.
```

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

### Export environment variables for assume role

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Set environment variables for assume role serial number and token code before running terraform plan.

```bash
$ export TENCENTCLOUD_ASSUME_ROLE_SERIAL_NUMBER="my-serial-number"
$ export TENCENTCLOUD_ASSUME_ROLE_TOKEN_CODE="my-token-code"
$ terraform plan
```

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

### Configure TencentCloud Provider with Allowed Account IDs

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configures the TencentCloud provider with static credentials and specifies a list of allowed account IDs. This restricts the provider's access to only the specified accounts.

```terraform
provider "tencentcloud" {
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  region     = "ap-guangzhou"

  allowed_account_ids   = ["100023201586", "100023201349"]
}
```

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

### Export environment variables for assume role with OIDC

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Set various environment variables for OIDC assume role configuration, including secret ID/key, role ARN, session duration, web identity token, and provider ID, before running terraform plan.

```bash
$ export TENCENTCLOUD_SECRET_ID="my-secret-id"
$ export TENCENTCLOUD_SECRET_KEY="my-secret-key"
$ export TENCENTCLOUD_ASSUME_ROLE_ARN="my-role-arn"
$ export TENCENTCLOUD_ASSUME_ROLE_ARNN_FILE="/AbsolutePath/to/your/secrets/role-arn-file"
$ export TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION=3600
$ export TENCENTCLOUD_ASSUME_ROLE_WEB_IDENTITY_TOKEN="my-web-identity-token"
$ export TENCENTCLOUD_ASSUME_ROLE_WEB_IDENTITY_TOKEN_FILE="/AbsolutePath/to/your/secrets/web-identity-token-file"
$ export TENCENTCLOUD_ASSUME_ROLE_PROVIDER_ID="OIDC"
$ terraform plan
```

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

### JSON format for role ARN file

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

The content of the role ARN file must be in JSON format and include the 'role_arn' key.

```json
{
    "role_arn": "my-role-arn"
}
```

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

### Configure TencentCloud Provider with Assume Role and MFA

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configures the TencentCloud provider to assume an IAM role with Multi-Factor Authentication (MFA). Requires role ARN, session name, MFA serial number, and token code.

```terraform
provider "tencentcloud" {
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  region     = "ap-guangzhou"

  assume_role {
    role_arn         = "my-role-arn"
    session_name     = "my-session-name"
    policy           = "my-role-policy"
    session_duration = 3600
    serial_number    = "qcs::cam:uin/{my-uin}::mfa/softToken"
    token_code       = "523886"
  }
}
```

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

### Assume Role with Web Identity

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configuration block for assuming an IAM role using Web Identity tokens.

```APIDOC
## Assume Role with Web Identity

### Description
This block configures authentication by assuming an IAM role using Web Identity tokens.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **provider_id** (string) - Optional - Identity provider name. Defaults to OIDC. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_PROVIDER_ID` environment variable.
- **role_arn** (string) - Required - The ARN of the role to assume. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_ARN` environment variable.
- **session_name** (string) - Required - The session name to use when making the AssumeRole call. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME` environment variable.
- **session_duration** (number) - Required - The duration of the session in seconds. Ranges from 0 to 43200, defaults to 7200. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION` environment variable.
- **web_identity_token** (string) - Optional - OIDC token issued by IdP. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_WEB_IDENTITY_TOKEN` environment variable. One of `web_identity_token` or `web_identity_token_file` is required.
- **web_identity_token_file** (string) - Optional - File containing a web identity token from an OpenID Connect (OIDC) or OAuth provider. Can be sourced from `TENCENTCLOUD_ASSUME_ROLE_WEB_IDENTITY_TOKEN_FILE` environment variable. One of `web_identity_token` or `web_identity_token_file` is required.
```

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

### Configure Provider with CAM Role Name

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Use 'cam_role_name' to authenticate by accessing the metadata URL for STS credentials. This method does not require 'secret_id' or 'secret_key'.

```terraform
provider "tencentcloud" {
  cam_role_name = "my-cam-role-name"
}
```

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

### JSON format for web identity token file

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

The content of the web identity token file must be in JSON format and include the 'web_identity_token' key.

```json
{
    "web_identity_token": "eyJ0eXAiOiJKV1QiLCJh......E8T0qyVA7hWM55_g"
}
```

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

### Configure TencentCloud Provider

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configure the TencentCloud provider with your credentials and desired region. Ensure Terraform version 0.12.x or later is used for provider version 1.9.0 and above.

```terraform
terraform {
  required_providers {
    tencentcloud = {
      source = "tencentcloudstack/tencentcloud"
    }
  }
}

# Configure the TencentCloud Provider
provider "tencentcloud" {
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  region     = "ap-guangzhou"
}
```

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

### Configure TencentCloud Provider with Assume Role

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configures the TencentCloud provider to assume an IAM role for authentication. It includes role ARN, session name, optional policy, and session duration.

```terraform
provider "tencentcloud" {
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  region     = "ap-guangzhou"

  assume_role {
    role_arn         = "my-role-arn"
    session_name     = "my-session-name"
    policy           = "my-role-policy"
    session_duration = 3600
  }
}
```

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

### Create a TencentCloud Security Group

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Defines a TencentCloud security group with a name and description. This resource is used to manage network access rules for TencentCloud instances.

```terraform
resource "tencentcloud_security_group" "default" {
  name        = "web accessibility"
  description = "make it accessible for both production and stage ports"
}
```

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

### Configure Provider for CDC COS Usage

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Set up the provider for CDC COS usage by specifying the region, secret ID, secret key, and a custom 'cos_domain' for CDC scenarios. The 'cos_domain' can also be set via an environment variable.

```terraform
locals {
  region = "ap-guangzhou"
  cdc_id = "cluster_xxx"
}

provider "tencentcloud" {
  region     = local.region
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  cos_domain = "https://${local.cdc_id}.cos-cdc.${local.region}.myqcloud.com/"
}
```

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

### Set CDC COS Domain via Environment Variable

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configure CDC COS usage by setting environment variables for secret ID, secret key, region, and the COS domain before running 'terraform plan'.

```bash
$ export TENCENTCLOUD_SECRET_ID="my-secret-id"
$ export TENCENTCLOUD_SECRET_KEY="my-secret-key"
$ export TENCENTCLOUD_REGION="ap-guangzhou"
$ export TENCENTCLOUD_COS_DOMAIN="https://cluster-xxxxxx.cos-cdc.ap-guangzhou.myqcloud.com/"
$ terraform plan
```

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

### Configure TencentCloud Provider with Forbidden Account IDs

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configures the TencentCloud provider with static credentials and specifies a list of forbidden account IDs. This prevents the provider from accessing the specified accounts.

```terraform
provider "tencentcloud" {
  secret_id  = "my-secret-id"
  secret_key = "my-secret-key"
  region     = "ap-guangzhou"

  forbidden_account_ids = ["100023201223"]
}
```

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

### Configure TencentCloud Security Group Rules

Source: https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs

Configures ingress and egress rules for a TencentCloud security group. Allows TCP traffic on ports 80 and 8080 for web access, and allows SSH traffic on port 22.

```terraform
resource "tencentcloud_security_group_rule_set" "base" {
  security_group_id = tencentcloud_security_group.default.id

  ingress {
    action      = "ACCEPT"
    cidr_block  = "0.0.0.0/0"
    protocol    = "TCP"
    port        = "80,8080"
    description = "Create security group rule allow web request"
  }

  egress {
    action      = "ACCEPT"
    cidr_block  = "0.0.0.0/0"
    protocol    = "TCP"
    port        = "22"
    description = "Create security group rule allow ssh request"
  }
}
```
Tokens:
Raw