Volcenginecc Provider
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 Volcengine Cloud Control Provider enables interaction with various Volcengine-supported resources through the Cloud Control API. Prior to usage, you must configure the provider with appropriate credentials.
volcengine && volcenginecc
Both volcenginecc and volcengine are Infrastructure-as-Code providers for Volcengine.
- The volcengine provider was the first-generation IaC provider offered by Volcengine.
- The volcenginecc provider is automatically generated based on Volcengine’s Cloud Control API. It will be the long-term supported version going forward. Compared to the original provider, volcenginecc offers a more standardized resource definition model and will serve as the primary provider for future enhancements and feature evolution.
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";
// ⚠️ Sensitive information should not be hardcoded in the source code.
// This example is for demonstration purposes only.
// It’s recommended to manage such data using environment variables,
// secure configuration files, or a secret management service.
const provider = new ve.Provider("volcengine-provider", {
region: "cn-beijing", // REGION
accessKey: "", // ACCESSKEY
secretKey: "", // SECRET_ACCESS_KEY
endpoints: {
cloudcontrolapi: "cloudcontrol.cn-beijing.volcengineapi.com"
},
});
const user = new ve.iam.User("pulumi-node-user", {
userName: "pulumi-nodejs-user-1", // Required
description: "pulumi user description update", // Optional
displayName: "pulumi-nodejs-display", // Optional
groups: ["ccapi-test"], // Optional
policies: [ // Optional
{ policyName: "ReadOnlyAccess", policyType: "System" },
{ policyName: "TOSReadOnlyAccess", policyType: "System" },
{ policyName: "VPCFullAccess", policyType: "System" },
{ policyName: "IAMFullAccess", policyType: "System" },
],
tags: [ // Optional
{ 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
# ⚠️ Sensitive information should not be hardcoded in the source code.
# This example is for demonstration purposes only.
# It’s recommended to manage such data using environment variables,
# secure configuration files, or a secret management service.
provider = ve.Provider("volcengine",
access_key="",
secret_key="",
region="cn-beijing",
endpoints={
"cloudcontrol": "cloudcontrol.cn-beijing.volcengineapi.com"
})
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(() =>
{
// ⚠️ Sensitive information should not be hardcoded in the source code.
// This example is for demonstration purposes only.
// It’s recommended to manage such data using environment variables,
// secure configuration files, or a secret management service.
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 {
// ⚠️ Sensitive information should not be hardcoded in the source code.
// This example is for demonstration purposes only.
// It’s recommended to manage such data using environment variables,
// secure configuration files, or a secret management service.
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 -> {
// ⚠️ Sensitive information should not be hardcoded in the source code.
// This example is for demonstration purposes only.
// It’s recommended to manage such data using environment variables,
// secure configuration files, or a secret management service.
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
volcengine 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 VOLCENGINE_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 theVOLCENGINE_ACCESS_KEY
environment variablesecretKey
(String) he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from theVOLCENGINE_SECRET_KEY
environment variableassumeRole
(Attributes) Anassume_role
block (documented below). Only oneassume_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 Providerendpoints
(Attributes) Anendpoints
block (documented below). Only oneendpoints
block may be in the configuration. (see below for nested schema)proxyUrl
(String) PROXY URL for Volcengine Providerregion
(String) The Region for Volcengine Provider. It must be provided, but it can also be sourced from theVOLCENGINE_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 URLsts
(String) Use this to override the default STS service endpoint URL