Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. Provider
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.Provider

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

The provider type for the volcengine package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             access_key: Optional[str] = None,
             assume_role: Optional[ProviderAssumeRoleArgs] = None,
             customer_endpoints: Optional[str] = None,
             customer_headers: Optional[str] = None,
             disable_ssl: Optional[bool] = None,
             endpoint: Optional[str] = None,
             proxy_url: Optional[str] = None,
             region: Optional[str] = None,
             secret_key: Optional[str] = None,
             session_token: Optional[str] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:volcengine
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 ProviderArgs
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 ProviderArgs
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 ProviderArgs
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 ProviderArgs
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. ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AccessKey string
The Access Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ACCESS_KEY
AssumeRole ProviderAssumeRole
The ASSUME ROLE block for Volcengine Provider. If provided, terraform will attempt to assume this role using the supplied credentials.
CustomerEndpoints string
CUSTOMER ENDPOINTS for Volcengine Provider
CustomerHeaders string
CUSTOMER HEADERS for Volcengine Provider
DisableSsl bool
Disable SSL for Volcengine Provider
Endpoint string
The Customer Endpoint for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ENDPOINT
ProxyUrl string
PROXY URL for Volcengine Provider
Region string
The Region for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_REGION
SecretKey string
The Secret Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_SECRET_KEY
SessionToken string
The Session Token for Volcengine Provider
AccessKey string
The Access Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ACCESS_KEY
AssumeRole ProviderAssumeRoleArgs
The ASSUME ROLE block for Volcengine Provider. If provided, terraform will attempt to assume this role using the supplied credentials.
CustomerEndpoints string
CUSTOMER ENDPOINTS for Volcengine Provider
CustomerHeaders string
CUSTOMER HEADERS for Volcengine Provider
DisableSsl bool
Disable SSL for Volcengine Provider
Endpoint string
The Customer Endpoint for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ENDPOINT
ProxyUrl string
PROXY URL for Volcengine Provider
Region string
The Region for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_REGION
SecretKey string
The Secret Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_SECRET_KEY
SessionToken string
The Session Token for Volcengine Provider
accessKey String
The Access Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ACCESS_KEY
assumeRole ProviderAssumeRole
The ASSUME ROLE block for Volcengine Provider. If provided, terraform will attempt to assume this role using the supplied credentials.
customerEndpoints String
CUSTOMER ENDPOINTS for Volcengine Provider
customerHeaders String
CUSTOMER HEADERS for Volcengine Provider
disableSsl Boolean
Disable SSL for Volcengine Provider
endpoint String
The Customer Endpoint for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ENDPOINT
proxyUrl String
PROXY URL for Volcengine Provider
region String
The Region for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_REGION
secretKey String
The Secret Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_SECRET_KEY
sessionToken String
The Session Token for Volcengine Provider
accessKey string
The Access Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ACCESS_KEY
assumeRole ProviderAssumeRole
The ASSUME ROLE block for Volcengine Provider. If provided, terraform will attempt to assume this role using the supplied credentials.
customerEndpoints string
CUSTOMER ENDPOINTS for Volcengine Provider
customerHeaders string
CUSTOMER HEADERS for Volcengine Provider
disableSsl boolean
Disable SSL for Volcengine Provider
endpoint string
The Customer Endpoint for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ENDPOINT
proxyUrl string
PROXY URL for Volcengine Provider
region string
The Region for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_REGION
secretKey string
The Secret Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_SECRET_KEY
sessionToken string
The Session Token for Volcengine Provider
access_key str
The Access Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ACCESS_KEY
assume_role ProviderAssumeRoleArgs
The ASSUME ROLE block for Volcengine Provider. If provided, terraform will attempt to assume this role using the supplied credentials.
customer_endpoints str
CUSTOMER ENDPOINTS for Volcengine Provider
customer_headers str
CUSTOMER HEADERS for Volcengine Provider
disable_ssl bool
Disable SSL for Volcengine Provider
endpoint str
The Customer Endpoint for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ENDPOINT
proxy_url str
PROXY URL for Volcengine Provider
region str
The Region for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_REGION
secret_key str
The Secret Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_SECRET_KEY
session_token str
The Session Token for Volcengine Provider
accessKey String
The Access Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ACCESS_KEY
assumeRole Property Map
The ASSUME ROLE block for Volcengine Provider. If provided, terraform will attempt to assume this role using the supplied credentials.
customerEndpoints String
CUSTOMER ENDPOINTS for Volcengine Provider
customerHeaders String
CUSTOMER HEADERS for Volcengine Provider
disableSsl Boolean
Disable SSL for Volcengine Provider
endpoint String
The Customer Endpoint for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_ENDPOINT
proxyUrl String
PROXY URL for Volcengine Provider
region String
The Region for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_REGION
secretKey String
The Secret Key for Volcengine Provider It can also be sourced from the following environment variable: VOLCENGINE_SECRET_KEY
sessionToken String
The Session Token for Volcengine Provider

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ProviderAssumeRole
, ProviderAssumeRoleArgs

AssumeRoleSessionName This property is required. string
The session name to use when making the AssumeRole call.
AssumeRoleTrn This property is required. string
The TRN of the role to assume.
DurationSeconds This property is required. int
The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.
Policy string
A more restrictive policy when making the AssumeRole call.
AssumeRoleSessionName This property is required. string
The session name to use when making the AssumeRole call.
AssumeRoleTrn This property is required. string
The TRN of the role to assume.
DurationSeconds This property is required. int
The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.
Policy string
A more restrictive policy when making the AssumeRole call.
assumeRoleSessionName This property is required. String
The session name to use when making the AssumeRole call.
assumeRoleTrn This property is required. String
The TRN of the role to assume.
durationSeconds This property is required. Integer
The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.
policy String
A more restrictive policy when making the AssumeRole call.
assumeRoleSessionName This property is required. string
The session name to use when making the AssumeRole call.
assumeRoleTrn This property is required. string
The TRN of the role to assume.
durationSeconds This property is required. number
The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.
policy string
A more restrictive policy when making the AssumeRole call.
assume_role_session_name This property is required. str
The session name to use when making the AssumeRole call.
assume_role_trn This property is required. str
The TRN of the role to assume.
duration_seconds This property is required. int
The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.
policy str
A more restrictive policy when making the AssumeRole call.
assumeRoleSessionName This property is required. String
The session name to use when making the AssumeRole call.
assumeRoleTrn This property is required. String
The TRN of the role to assume.
durationSeconds This property is required. Number
The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.
policy String
A more restrictive policy when making the AssumeRole call.

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine