The provider type for the vkcs 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_token: Optional[str] = None,
auth_url: Optional[str] = None,
cloud_containers_api_version: Optional[str] = None,
endpoint_overrides: Optional[ProviderEndpointOverridesArgs] = None,
password: Optional[str] = None,
project_id: Optional[str] = None,
region: Optional[str] = None,
skip_client_auth: Optional[bool] = None,
user_domain_id: Optional[str] = None,
user_domain_name: Optional[str] = None,
username: 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:vkcs
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
Token string - A temporary token to use for authentication. You alternatively can use
OS_AUTH_TOKENenvironment variable. If both are specified, this attribute takes precedence. note The token will not be renewed and will eventually expire, usually after 1 hour. If access is needed for longer than a token's lifetime, use credentials-based authentication. - Auth
Url string - The Identity authentication URL.
- Cloud
Containers stringApi Version - Cloud Containers API version to use. note Only for custom VKCS deployments.
- Endpoint
Overrides ProviderEndpoint Overrides - Custom endpoints for corresponding APIs. If not specified, endpoints provided by the catalog will be used.
- Password string
- Password to login with.
- Project
Id string - The ID of Project to login with.
- Region string
- A region to use.
- Skip
Client boolAuth - Skip authentication on client initialization. Only applicablie if
access_tokenis provided. note If set to true, the endpoint catalog will not be used for discovery and all required endpoints must be provided viaendpoint_overrides. - User
Domain stringId - The id of the domain where the user resides.
- User
Domain stringName - The name of the domain where the user resides.
- Username string
- User name to login with.
- Access
Token string - A temporary token to use for authentication. You alternatively can use
OS_AUTH_TOKENenvironment variable. If both are specified, this attribute takes precedence. note The token will not be renewed and will eventually expire, usually after 1 hour. If access is needed for longer than a token's lifetime, use credentials-based authentication. - Auth
Url string - The Identity authentication URL.
- Cloud
Containers stringApi Version - Cloud Containers API version to use. note Only for custom VKCS deployments.
- Endpoint
Overrides ProviderEndpoint Overrides Args - Custom endpoints for corresponding APIs. If not specified, endpoints provided by the catalog will be used.
- Password string
- Password to login with.
- Project
Id string - The ID of Project to login with.
- Region string
- A region to use.
- Skip
Client boolAuth - Skip authentication on client initialization. Only applicablie if
access_tokenis provided. note If set to true, the endpoint catalog will not be used for discovery and all required endpoints must be provided viaendpoint_overrides. - User
Domain stringId - The id of the domain where the user resides.
- User
Domain stringName - The name of the domain where the user resides.
- Username string
- User name to login with.
- access
Token String - A temporary token to use for authentication. You alternatively can use
OS_AUTH_TOKENenvironment variable. If both are specified, this attribute takes precedence. note The token will not be renewed and will eventually expire, usually after 1 hour. If access is needed for longer than a token's lifetime, use credentials-based authentication. - auth
Url String - The Identity authentication URL.
- cloud
Containers StringApi Version - Cloud Containers API version to use. note Only for custom VKCS deployments.
- endpoint
Overrides ProviderEndpoint Overrides - Custom endpoints for corresponding APIs. If not specified, endpoints provided by the catalog will be used.
- password String
- Password to login with.
- project
Id String - The ID of Project to login with.
- region String
- A region to use.
- skip
Client BooleanAuth - Skip authentication on client initialization. Only applicablie if
access_tokenis provided. note If set to true, the endpoint catalog will not be used for discovery and all required endpoints must be provided viaendpoint_overrides. - user
Domain StringId - The id of the domain where the user resides.
- user
Domain StringName - The name of the domain where the user resides.
- username String
- User name to login with.
- access
Token string - A temporary token to use for authentication. You alternatively can use
OS_AUTH_TOKENenvironment variable. If both are specified, this attribute takes precedence. note The token will not be renewed and will eventually expire, usually after 1 hour. If access is needed for longer than a token's lifetime, use credentials-based authentication. - auth
Url string - The Identity authentication URL.
- cloud
Containers stringApi Version - Cloud Containers API version to use. note Only for custom VKCS deployments.
- endpoint
Overrides ProviderEndpoint Overrides - Custom endpoints for corresponding APIs. If not specified, endpoints provided by the catalog will be used.
- password string
- Password to login with.
- project
Id string - The ID of Project to login with.
- region string
- A region to use.
- skip
Client booleanAuth - Skip authentication on client initialization. Only applicablie if
access_tokenis provided. note If set to true, the endpoint catalog will not be used for discovery and all required endpoints must be provided viaendpoint_overrides. - user
Domain stringId - The id of the domain where the user resides.
- user
Domain stringName - The name of the domain where the user resides.
- username string
- User name to login with.
- access_
token str - A temporary token to use for authentication. You alternatively can use
OS_AUTH_TOKENenvironment variable. If both are specified, this attribute takes precedence. note The token will not be renewed and will eventually expire, usually after 1 hour. If access is needed for longer than a token's lifetime, use credentials-based authentication. - auth_
url str - The Identity authentication URL.
- cloud_
containers_ strapi_ version - Cloud Containers API version to use. note Only for custom VKCS deployments.
- endpoint_
overrides ProviderEndpoint Overrides Args - Custom endpoints for corresponding APIs. If not specified, endpoints provided by the catalog will be used.
- password str
- Password to login with.
- project_
id str - The ID of Project to login with.
- region str
- A region to use.
- skip_
client_ boolauth - Skip authentication on client initialization. Only applicablie if
access_tokenis provided. note If set to true, the endpoint catalog will not be used for discovery and all required endpoints must be provided viaendpoint_overrides. - user_
domain_ strid - The id of the domain where the user resides.
- user_
domain_ strname - The name of the domain where the user resides.
- username str
- User name to login with.
- access
Token String - A temporary token to use for authentication. You alternatively can use
OS_AUTH_TOKENenvironment variable. If both are specified, this attribute takes precedence. note The token will not be renewed and will eventually expire, usually after 1 hour. If access is needed for longer than a token's lifetime, use credentials-based authentication. - auth
Url String - The Identity authentication URL.
- cloud
Containers StringApi Version - Cloud Containers API version to use. note Only for custom VKCS deployments.
- endpoint
Overrides Property Map - Custom endpoints for corresponding APIs. If not specified, endpoints provided by the catalog will be used.
- password String
- Password to login with.
- project
Id String - The ID of Project to login with.
- region String
- A region to use.
- skip
Client BooleanAuth - Skip authentication on client initialization. Only applicablie if
access_tokenis provided. note If set to true, the endpoint catalog will not be used for discovery and all required endpoints must be provided viaendpoint_overrides. - user
Domain StringId - The id of the domain where the user resides.
- user
Domain StringName - The name of the domain where the user resides.
- username String
- User name to login with.
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<{[key: string]: any}>def terraform_config() -> Output[Provider.Terraform_configResult]func (r *Provider) TerraformConfig() (pulumi.MapOutput, error)public Output<ImmutableDictionary<string, object>> 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
ProviderEndpointOverrides, ProviderEndpointOverridesArgs
- Backup string
- Backup API custom endpoint.
- Block
Storage string - Block Storage API custom endpoint.
- Cdn string
- CDN API custom endpoint.
- Compute string
- Compute API custom endpoint.
- Container
Infra string - Cloud Containers API custom endpoint.
- Container
Infra stringAddons - Cloud Containers Addons API custom endpoint.
- Data
Platform string - Data Platform API custom endpoint.
- Database string
- Database API custom endpoint.
- Iam
Service stringUsers - IAM Service Users API custom endpoint.
- Ics string
- ICS API custom endpoint.
- Image string
- Image API custom endpoint.
- Key
Manager string - Key Manager API custom endpoint.
- Load
Balancer string - Load Balancer API custom endpoint.
- Ml
Platform string - ML Platform API custom endpoint.
- Networking string
- Networking API custom endpoint.
- Public
Dns string - Public DNS API custom endpoint.
- string
- Shared Filesystem API custom endpoint.
- Templater string
- Templater API custom endpoint.
- Backup string
- Backup API custom endpoint.
- Block
Storage string - Block Storage API custom endpoint.
- Cdn string
- CDN API custom endpoint.
- Compute string
- Compute API custom endpoint.
- Container
Infra string - Cloud Containers API custom endpoint.
- Container
Infra stringAddons - Cloud Containers Addons API custom endpoint.
- Data
Platform string - Data Platform API custom endpoint.
- Database string
- Database API custom endpoint.
- Iam
Service stringUsers - IAM Service Users API custom endpoint.
- Ics string
- ICS API custom endpoint.
- Image string
- Image API custom endpoint.
- Key
Manager string - Key Manager API custom endpoint.
- Load
Balancer string - Load Balancer API custom endpoint.
- Ml
Platform string - ML Platform API custom endpoint.
- Networking string
- Networking API custom endpoint.
- Public
Dns string - Public DNS API custom endpoint.
- string
- Shared Filesystem API custom endpoint.
- Templater string
- Templater API custom endpoint.
- backup String
- Backup API custom endpoint.
- block
Storage String - Block Storage API custom endpoint.
- cdn String
- CDN API custom endpoint.
- compute String
- Compute API custom endpoint.
- container
Infra String - Cloud Containers API custom endpoint.
- container
Infra StringAddons - Cloud Containers Addons API custom endpoint.
- data
Platform String - Data Platform API custom endpoint.
- database String
- Database API custom endpoint.
- iam
Service StringUsers - IAM Service Users API custom endpoint.
- ics String
- ICS API custom endpoint.
- image String
- Image API custom endpoint.
- key
Manager String - Key Manager API custom endpoint.
- load
Balancer String - Load Balancer API custom endpoint.
- ml
Platform String - ML Platform API custom endpoint.
- networking String
- Networking API custom endpoint.
- public
Dns String - Public DNS API custom endpoint.
- String
- Shared Filesystem API custom endpoint.
- templater String
- Templater API custom endpoint.
- backup string
- Backup API custom endpoint.
- block
Storage string - Block Storage API custom endpoint.
- cdn string
- CDN API custom endpoint.
- compute string
- Compute API custom endpoint.
- container
Infra string - Cloud Containers API custom endpoint.
- container
Infra stringAddons - Cloud Containers Addons API custom endpoint.
- data
Platform string - Data Platform API custom endpoint.
- database string
- Database API custom endpoint.
- iam
Service stringUsers - IAM Service Users API custom endpoint.
- ics string
- ICS API custom endpoint.
- image string
- Image API custom endpoint.
- key
Manager string - Key Manager API custom endpoint.
- load
Balancer string - Load Balancer API custom endpoint.
- ml
Platform string - ML Platform API custom endpoint.
- networking string
- Networking API custom endpoint.
- public
Dns string - Public DNS API custom endpoint.
- string
- Shared Filesystem API custom endpoint.
- templater string
- Templater API custom endpoint.
- backup str
- Backup API custom endpoint.
- block_
storage str - Block Storage API custom endpoint.
- cdn str
- CDN API custom endpoint.
- compute str
- Compute API custom endpoint.
- container_
infra str - Cloud Containers API custom endpoint.
- container_
infra_ straddons - Cloud Containers Addons API custom endpoint.
- data_
platform str - Data Platform API custom endpoint.
- database str
- Database API custom endpoint.
- iam_
service_ strusers - IAM Service Users API custom endpoint.
- ics str
- ICS API custom endpoint.
- image str
- Image API custom endpoint.
- key_
manager str - Key Manager API custom endpoint.
- load_
balancer str - Load Balancer API custom endpoint.
- ml_
platform str - ML Platform API custom endpoint.
- networking str
- Networking API custom endpoint.
- public_
dns str - Public DNS API custom endpoint.
- str
- Shared Filesystem API custom endpoint.
- templater str
- Templater API custom endpoint.
- backup String
- Backup API custom endpoint.
- block
Storage String - Block Storage API custom endpoint.
- cdn String
- CDN API custom endpoint.
- compute String
- Compute API custom endpoint.
- container
Infra String - Cloud Containers API custom endpoint.
- container
Infra StringAddons - Cloud Containers Addons API custom endpoint.
- data
Platform String - Data Platform API custom endpoint.
- database String
- Database API custom endpoint.
- iam
Service StringUsers - IAM Service Users API custom endpoint.
- ics String
- ICS API custom endpoint.
- image String
- Image API custom endpoint.
- key
Manager String - Key Manager API custom endpoint.
- load
Balancer String - Load Balancer API custom endpoint.
- ml
Platform String - ML Platform API custom endpoint.
- networking String
- Networking API custom endpoint.
- public
Dns String - Public DNS API custom endpoint.
- String
- Shared Filesystem API custom endpoint.
- templater String
- Templater API custom endpoint.
Package Details
- Repository
- vkcs vk-cs/terraform-provider-vkcs
- License
- Notes
- This Pulumi package is based on the
vkcsTerraform Provider.
