volcenginecc v0.0.1, Sep 25 25

volcenginecc v0.0.1 published on Thursday, Sep 25, 2025 by Volcengine

Volcenginecc Provider

volcenginecc v0.0.1 published on Thursday, Sep 25, 2025 by Volcengine

volcengine/pulumi-volcenginecc

Installation

The Volcenginecc provider is available as a package in all Pulumi languages:

JavaScript/TypeScript: @volcengine/pulumi-volcenginecc
Python: pulumi-volcenginecc
Go: github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc
.NET: Volcengine.Pulumi.Volcenginecc
Java: com.volcengine/volcenginecc

Overview

The Volcenginecc provider is used to interact with the many resources supported by Volcengine. The provider needs to be configured with the proper credentials before it can be used.

Use the navigation on the left to read about the available resources.

Example Usage

# Pulumi.yaml provider configuration file
name: pulumi-typescript-example
description: A minimal TypeScript Pulumi program
runtime:
  name: nodejs
  options:
    packagemanager: npm
config:
  pulumi:tags:
    value:
      pulumi:template: typescript

import * as pulumi from "@pulumi/pulumi";
import * as ve from "@volcengine/pulumi-volcenginecc"
import {ProviderEndpoints} from "../pulumi-volcenginecc/sdk/nodejs/types/input";


// 初始化 AWS Provider
// ⚠️ 敏感信息请勿在代码中明文指定，本示例仅为演示用途。
//   建议通过环境变量、安全配置文件或密钥管理服务进行管理。
const provider = new ve.Provider("volcengine-provider", {
    region: "cn-beijing",   // REGION
    accessKey: "",   // ACCESSKEY
    secretKey: "", // SECRET_ACCESS_KEY
    endpoints: {
        cloudcontrolapi: "cloudcontrol.cn-beijing.volcengineapi.com"
    },
});

// 初始化一个 IAM User
const user = new ve.iam.User("pulumi-node-user", {
    userName: "pulumi-nodejs-user-1",           // 必填
    description: "pulumi user description update",     // 可选
    displayName: "pulumi-nodejs-display",       // 可选
    groups: ["ccapi-test"],                     // 可选
    policies: [                                 // 可选：绑定策略
        { policyName: "ReadOnlyAccess", policyType: "System" },
        { policyName: "TOSReadOnlyAccess", policyType: "System" },
        { policyName: "VPCFullAccess", policyType: "System" },
        { policyName: "IAMFullAccess", policyType: "System" },

    ],
    tags: [                                     // 可选：打标签
        { key: "env", value: "dev" },
        { key: "team", value: "backend" },
    ],
}, { provider });

name: pulumi-python-demo
description: pulumi python demo
runtime:
  name: python
  options:
    toolchain: pip
    virtualenv: venv
config:
  pulumi:tags:
    value:
      pulumi:template: python

"""A Python Pulumi program"""

import pulumi
import pulumi_volcenginecc as ve
# ⚠️ 敏感信息请勿在代码中明文指定，本示例仅为演示用途。
# 建议通过环境变量、安全配置文件或密钥管理服务进行管理。
provider = ve.Provider("volcengine",
                       access_key="",
                       secret_key="",
                       region="cn-beijing",
                       endpoints={
                           "cloudcontrol": "cloudcontrol.cn-beijing.volcengineapi.com"
                       })
# 构造一个 UserArgs
args = ve.iam.UserArgs(
    user_name="pulumi-python-user-1",
    description="pulumi user description update",
    display_name="pulumi-python-user-diplay",
    groups=["ccapi-test"],
    policies=[
        ve.iam.UserPolicyArgs(policy_name="ReadOnlyAccess", policy_type="System"),
        ve.iam.UserPolicyArgs(policy_name="TOSReadOnlyAccess", policy_type="System"),
        ve.iam.UserPolicyArgs(policy_name="ECSFullAccess", policy_type="System"),
        ve.iam.UserPolicyArgs(policy_name="VPCFullAccess", policy_type="System"),
    ],
    tags=[
        ve.iam.UserTagArgs(key="env", value="dev"),
        ve.iam.UserTagArgs(key="team", value="backend")
    ]
)

user = ve.iam.User("pulumi-python-user-1",
                   args, opts=pulumi.ResourceOptions(provider=provider))

# Pulumi.yaml provider configuration file
name: pulumi-dotnet-example
runtime: dotnet

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Pulumi.Volcenginecc;
using Pulumi.Volcenginecc.Inputs;

return await Deployment.RunAsync(() => 
{
    // ⚠️ 敏感信息请勿在代码中明文指定，本示例仅为演示用途。
    // 建议通过环境变量、安全配置文件或密钥管理服务进行管理。
    var provider = new Provider("volcengine", new ProviderArgs
    {
        AccessKey = "",
        SecretKey = "",
        Region = "cn-beijing",
        Endpoints =new ProviderEndpointsArgs
        {
            Cloudcontrolapi = "cloudcontrol.cn-beijing.volcengineapi.com",
        }
        
    });
     var user = new Pulumi.Volcenginecc.Iam.User("pulumi-csharp-user-1", new Pulumi.Volcenginecc.Iam.UserArgs
        {
            UserName = "pulumi-dotnet-user-1",
            Description = "pulumi user description ",
            DisplayName = "pulumi-java-user-diplay",
            Groups = { "ccapi-test" },

            Policies =
            {
                new Pulumi.Volcenginecc.Iam.Inputs.UserPolicyArgs { PolicyName = "TOSReadOnlyAccess", PolicyType = "System" },
                new Pulumi.Volcenginecc.Iam.Inputs.UserPolicyArgs { PolicyName = "ReadOnlyAccess",    PolicyType = "System" },
                new Pulumi.Volcenginecc.Iam.Inputs.UserPolicyArgs { PolicyName = "IAMFullAccess",     PolicyType = "System" },
                new Pulumi.Volcenginecc.Iam.Inputs.UserPolicyArgs { PolicyName = "ECSFullAccess",     PolicyType = "System" },

            },

            Tags =
            {
                new Pulumi.Volcenginecc.Iam.Inputs.UserTagArgs { Key = "key1",    Value = "Value1" },
                new Pulumi.Volcenginecc.Iam.Inputs.UserTagArgs { Key = "TagXXX",  Value = "ValueXXX" },
            },
        }, new CustomResourceOptions
        {
            Provider = provider
        });
});

# Pulumi.yaml provider configuration file
name: pulumi-iam-user
description: pulumi-iam-user
runtime: go
config:
  pulumi:tags:
    value:
      pulumi:template: go

package main

import (
	"fmt"

	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	myprovider "github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/iam"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// ⚠️ 敏感信息请勿在代码中明文指定，本示例仅为演示用途。
		// 建议通过环境变量、安全配置文件或密钥管理服务进行管理。
		prov, err := myprovider.NewProvider(ctx, "pulumi", &myprovider.ProviderArgs{
			AccessKey: pulumi.String(""),
			SecretKey: pulumi.String("=="),
			Region:    pulumi.String("cn-beijing"),
			Endpoints: &myprovider.ProviderEndpointsArgs{
				Cloudcontrolapi: pulumi.String("cloudcontrol.cn-beijing.volcengineapi.com"),
			},
		})
		if err != nil {
			return err
		}

		// 使用资源
		user, err := iam.NewUser(ctx, "pulumi-test-user", &iam.UserArgs{
			UserName:    pulumi.String("pulumi-user-2"),
			DisplayName: pulumi.StringPtr("pulumi-user-display"),
			Description: pulumi.StringPtr("pulumi user description update"),
			Groups:      pulumi.ToStringArray([]string{"ccapi-test"}),
			Policies: iam.UserPolicyArray{
				iam.UserPolicyArgs{
					PolicyName: pulumi.StringPtr("TOSReadOnlyAccess"),
					PolicyType: pulumi.StringPtr("System"),
				},
				iam.UserPolicyArgs{
					PolicyName: pulumi.StringPtr("ReadOnlyAccess"),
					PolicyType: pulumi.StringPtr("System"),
				},
				iam.UserPolicyArgs{
					PolicyName: pulumi.StringPtr("ECSFullAccess"),
					PolicyType: pulumi.StringPtr("System"),
				},
				iam.UserPolicyArgs{
					PolicyName: pulumi.StringPtr("IAMFullAccess"),
					PolicyType: pulumi.StringPtr("System"),
				},
			},
			Tags: iam.UserTagArray{
				iam.UserTagArgs{
					Key:   pulumi.StringPtr("key1"),
					Value: pulumi.StringPtr("Value1"),
				},
				iam.UserTagArgs{
					Key:   pulumi.StringPtr("TagKey1"),
					Value: pulumi.StringPtr("TagValue1"),
				},
				iam.UserTagArgs{
					Key:   pulumi.StringPtr("TagXXX"),
					Value: pulumi.StringPtr("ValueXXX"),
				},
			},
		}, pulumi.Provider(prov))
		return err
	})
}

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml

Example currently unavailable in this language

# Pulumi.yaml provider configuration file
name: pulumi-java-iam-user
description: pulumi java iam user
runtime: java
config:
  pulumi:tags:
    value:
      pulumi:template: java

package myproject;

import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.resources.CustomResourceOptions;
import com.volcengine.volcenginecc.Provider;
import com.volcengine.volcenginecc.ProviderArgs;
import com.volcengine.volcenginecc.iam.User;
import com.volcengine.volcenginecc.iam.UserArgs;
import com.volcengine.volcenginecc.iam.inputs.UserPolicyArgs;
import com.volcengine.volcenginecc.iam.inputs.UserTagArgs;
import com.volcengine.volcenginecc.inputs.ProviderEndpointsArgs;

public class App {
    public static void main(String[] args) {
        Pulumi.run(ctx -> {
            // ⚠️ 敏感信息请勿在代码中明文指定，本示例仅为演示用途。
            // 建议通过环境变量、安全配置文件或密钥管理服务进行管理。
            Provider volcenginecc = new Provider("volcenginecc", ProviderArgs.builder()
                    .accessKey("")
                    .secretKey("")
                    .region("cn-beijing")
                    .endpoints(ProviderEndpointsArgs.builder()
                            .cloudcontrolapi("cloudcontrol.cn-beijing.volcengineapi.com")
                            .build())
                    .build());
         
            User user = new User("pulumi-java-user-1", UserArgs.builder()
                    .userName("pulumi-java-user-1")
                    .description("pulumi user description update")
                    .displayName("pulumi-java-user-diplay")
                    .groups("ccapi-test")
                    .policies(
                            UserPolicyArgs.builder().policyName("TOSReadOnlyAccess").policyType("System").build(),
                            UserPolicyArgs.builder().policyName("ReadOnlyAccess").policyType("System").build(),
                            UserPolicyArgs.builder().policyName("IAMFullAccess").policyType("System").build(),
                            UserPolicyArgs.builder().policyName("VPCFullAccess").policyType("System").build()
                    )
                    .tags(
                            UserTagArgs.builder().key("key1").value("Value1").build(),
                            UserTagArgs.builder().key("TagKey1").value("TagValue1").build(),
                            UserTagArgs.builder().key("TagXXX").value("ValueXXX").build()
                    )
                    .build(),
                    CustomResourceOptions.builder().provider(volcenginecc).build());
        });
    }
}

Authentication

The volcenginecc provider accepts several ways to enter credentials for authentication. The following methods are supported, in this order, and explained below:

Static credentials
Environment variables

Static credentials

Static credentials can be provided by adding accessKey, secretKey and region in-line in the alicloud provider configuration:

Usage:

# Pulumi.yaml provider configuration file
name: configuration-example
runtime:
config:
    volcengine:accessKey:
        value: 'TODO: var.access_key'
    volcengine:region:
        value: 'TODO: var.region'
    volcengine:secretKey:
        value: 'TODO: var.secret_key'

Environment variables

You can provide your credentials via VOLCENGINE_ACCESS_KEY, VOLCENGINE_SECRET_KEY environment variables. The Region can be set using the VOLCENGINE_REGION environment variables.

Usage:

# Pulumi.yaml provider configuration file
name: configuration-example
runtime:

$ export VOLCENGINE_ACCESS_KEY="<Your-Access-Key-ID>"
$ export VOLCENGINE_SECRET_KEY="<Your-Access-Key-Secret>"
$ export ALIBABA_CLOUD_REGION="cn-beijing"
$ pulumi preview

Configuration Reference

In addition to generic provider arguments (e.g. alias and version), the following arguments are supported in the Volcenginecc provider configuration:

Optional

accessKey (String) The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the VOLCENGINE_ACCESS_KEY environment variable
secretKey (String) he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the VOLCENGINE_SECRET_KEY environment variable
assumeRole (Attributes) An assume_role block (documented below). Only one assume_role block may be in the configuration. (see below for nested schema)
customerHeaders (String) CUSTOMER HEADERS for Volcengine Provider. The customer_headers field uses commas (,) to separate multiple headers, and colons (:) to separate each header key from its corresponding value.
disableSsl (Boolean) Disable SSL for Volcengine Provider
endpoints (Attributes) An endpoints block (documented below). Only one endpoints block may be in the configuration. (see below for nested schema)
proxyUrl (String) PROXY URL for Volcengine Provider
region (String) The Region for Volcengine Provider. It must be provided, but it can also be sourced from the VOLCENGINE_REGION environment variable

Nested Schema for `assume_role`

Required:

assumeRoleTrn (String) he TRN of the role to assume.
durationSeconds (Number) The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds. Optional:
policy (String) A more restrictive policy when making the AssumeRole call

Nested Schema for `endpoints`

Optional:

cloudcontrolapi (String) Use this to override the default Cloud Control API service endpoint URL
sts (String) Use this to override the default STS service endpoint URL

volcenginecc v0.0.1 published on Thursday, Sep 25, 2025 by Volcengine

volcengine/pulumi-volcenginecc

Volcenginecc Provider

On this page

On this page

Installation

Overview

Overview

Example Usage

Authentication

Static credentials

Environment variables

Configuration Reference

Optional

Nested Schema for `assume_role`

Nested Schema for `endpoints`

On this page

On this page

Volcenginecc Provider

On this page

On this page

Installation

Overview

Overview

Example Usage

Authentication

Static credentials

Environment variables

Configuration Reference

Optional

Nested Schema for assume_role

Nested Schema for endpoints

On this page

On this page

Nested Schema for `assume_role`

Nested Schema for `endpoints`