volcenginecc.Provider
The provider type for the volcenginecc 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_headers: Optional[str] = None,
disable_ssl: Optional[bool] = None,
endpoints: Optional[ProviderEndpointsArgs] = None,
proxy_url: Optional[str] = None,
region: Optional[str] = None,
secret_key: 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:volcenginecc
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name 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 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 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 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 String
- The unique name of the resource.
- args 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:
- Access
Key string - The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_ACCESS_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_ACCESS_KEY
- Assume
Role Volcengine.Provider Assume Role - An
assume_role
block (documented below). Only oneassume_role
block may be in the configuration. - Customer
Headers 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.
It can also be sourced from the following environment variable:
VOLCENGINE_CUSTOMER_HEADERS
- Disable
Ssl bool - Disable SSL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_DISABLE_SSL
- Endpoints
Volcengine.
Provider Endpoints - An
endpoints
block (documented below). Only oneendpoints
block may be in the configuration. - Proxy
Url string - PROXY URL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_PROXY_URL
- Region string
- The Region for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_REGION
environment variable It can also be sourced from the following environment variable:VOLCENGINE_REGION
- Secret
Key string - he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_SECRET_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_SECRET_KEY
- Access
Key string - The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_ACCESS_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_ACCESS_KEY
- Assume
Role ProviderAssume Role Args - An
assume_role
block (documented below). Only oneassume_role
block may be in the configuration. - Customer
Headers 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.
It can also be sourced from the following environment variable:
VOLCENGINE_CUSTOMER_HEADERS
- Disable
Ssl bool - Disable SSL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_DISABLE_SSL
- Endpoints
Provider
Endpoints Args - An
endpoints
block (documented below). Only oneendpoints
block may be in the configuration. - Proxy
Url string - PROXY URL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_PROXY_URL
- Region string
- The Region for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_REGION
environment variable It can also be sourced from the following environment variable:VOLCENGINE_REGION
- Secret
Key string - he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_SECRET_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_SECRET_KEY
- access
Key String - The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_ACCESS_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_ACCESS_KEY
- assume
Role ProviderAssume Role - An
assume_role
block (documented below). Only oneassume_role
block may be in the configuration. - customer
Headers 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.
It can also be sourced from the following environment variable:
VOLCENGINE_CUSTOMER_HEADERS
- disable
Ssl Boolean - Disable SSL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_DISABLE_SSL
- endpoints
Provider
Endpoints - An
endpoints
block (documented below). Only oneendpoints
block may be in the configuration. - proxy
Url String - PROXY URL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_PROXY_URL
- region String
- The Region for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_REGION
environment variable It can also be sourced from the following environment variable:VOLCENGINE_REGION
- secret
Key String - he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_SECRET_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_SECRET_KEY
- access
Key string - The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_ACCESS_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_ACCESS_KEY
- assume
Role ProviderAssume Role - An
assume_role
block (documented below). Only oneassume_role
block may be in the configuration. - customer
Headers 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.
It can also be sourced from the following environment variable:
VOLCENGINE_CUSTOMER_HEADERS
- disable
Ssl boolean - Disable SSL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_DISABLE_SSL
- endpoints
Provider
Endpoints - An
endpoints
block (documented below). Only oneendpoints
block may be in the configuration. - proxy
Url string - PROXY URL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_PROXY_URL
- region string
- The Region for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_REGION
environment variable It can also be sourced from the following environment variable:VOLCENGINE_REGION
- secret
Key string - he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_SECRET_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_SECRET_KEY
- access_
key str - The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_ACCESS_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_ACCESS_KEY
- assume_
role ProviderAssume Role Args - An
assume_role
block (documented below). Only oneassume_role
block may be in the configuration. - customer_
headers str - 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.
It can also be sourced from the following environment variable:
VOLCENGINE_CUSTOMER_HEADERS
- disable_
ssl bool - Disable SSL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_DISABLE_SSL
- endpoints
Provider
Endpoints Args - An
endpoints
block (documented below). Only oneendpoints
block may be in the configuration. - proxy_
url str - PROXY URL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_PROXY_URL
- region str
- The Region for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_REGION
environment variable It can also be sourced from the following environment variable:VOLCENGINE_REGION
- secret_
key str - he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_SECRET_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_SECRET_KEY
- access
Key String - The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_ACCESS_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_ACCESS_KEY
- assume
Role Property Map - An
assume_role
block (documented below). Only oneassume_role
block may be in the configuration. - customer
Headers 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.
It can also be sourced from the following environment variable:
VOLCENGINE_CUSTOMER_HEADERS
- disable
Ssl Boolean - Disable SSL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_DISABLE_SSL
- endpoints Property Map
- An
endpoints
block (documented below). Only oneendpoints
block may be in the configuration. - proxy
Url String - PROXY URL for Volcengine Provider
It can also be sourced from the following environment variable:
VOLCENGINE_PROXY_URL
- region String
- The Region for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_REGION
environment variable It can also be sourced from the following environment variable:VOLCENGINE_REGION
- secret
Key String - he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the
VOLCENGINE_SECRET_KEY
environment variable It can also be sourced from the following environment variable:VOLCENGINE_SECRET_KEY
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.
Provider Resource Methods
TerraformConfig Method
This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.
Using TerraformConfig
terraformConfig(): Output<Provider.TerraformConfigResult>
def terraform_config() -> Output[Provider.Terraform_configResult]
func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)
public Output<Provider.TerraformConfigResult> TerraformConfig()
TerraformConfig Result
- Result Dictionary<string, object>
- Result map[string]interface{}
- result Map<String,Object>
- result {[key: string]: any}
- result Mapping[str, Any]
- result Map<Any>
Supporting Types
ProviderAssumeRole, ProviderAssumeRoleArgs
- Assume
Role stringTrn - he TRN of the role to assume.
- Duration
Seconds 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
- Assume
Role stringTrn - he TRN of the role to assume.
- Duration
Seconds 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
- assume
Role StringTrn - he TRN of the role to assume.
- duration
Seconds 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
- assume
Role stringTrn - he TRN of the role to assume.
- duration
Seconds 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_ strtrn - he TRN of the role to assume.
- duration_
seconds 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
- assume
Role StringTrn - he TRN of the role to assume.
- duration
Seconds 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
ProviderEndpoints, ProviderEndpointsArgs
- 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
- 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
- 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
- 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
- cloudcontrolapi str
- Use this to override the default Cloud Control API service endpoint URL
- sts str
- Use this to override the default STS service endpoint URL
- 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
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcenginecc
Terraform Provider.