Docs Home
Rancher 2 v7.1.1 published on Monday, Oct 7, 2024 by Pulumi
rancher2.Provider
Explore with Pulumi AI
The provider type for the rancher2 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: ProviderArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Provider(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_key: Optional[str] = None,
api_url: Optional[str] = None,
bootstrap: Optional[bool] = None,
ca_certs: Optional[str] = None,
insecure: Optional[bool] = None,
retries: Optional[int] = None,
secret_key: Optional[str] = None,
timeout: Optional[str] = None,
token_key: Optional[str] = None)func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:rancher2
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:
- Api
Url string - The URL to the rancher API
- Access
Key string - API Key used to authenticate with the rancher server
- Bootstrap bool
- Bootstrap rancher server
It can also be sourced from the following environment variable:
RANCHER_BOOTSTRAP - Ca
Certs string - CA certificates used to sign rancher server tls certificates. Mandatory if self signed tls and insecure option false
- Insecure bool
- Allow insecure connections to Rancher. Mandatory if self signed tls and not ca_certs provided
It can also be sourced from the following environment variable:
RANCHER_INSECURE - Retries int
- Rancher connection retries
- Secret
Key string - API secret used to authenticate with the rancher server
- Timeout string
- Rancher connection timeout (retry every 5s). Golang duration format, ex: "60s"
- Token
Key string - API token used to authenticate with the rancher server
- Api
Url string - The URL to the rancher API
- Access
Key string - API Key used to authenticate with the rancher server
- Bootstrap bool
- Bootstrap rancher server
It can also be sourced from the following environment variable:
RANCHER_BOOTSTRAP - Ca
Certs string - CA certificates used to sign rancher server tls certificates. Mandatory if self signed tls and insecure option false
- Insecure bool
- Allow insecure connections to Rancher. Mandatory if self signed tls and not ca_certs provided
It can also be sourced from the following environment variable:
RANCHER_INSECURE - Retries int
- Rancher connection retries
- Secret
Key string - API secret used to authenticate with the rancher server
- Timeout string
- Rancher connection timeout (retry every 5s). Golang duration format, ex: "60s"
- Token
Key string - API token used to authenticate with the rancher server
- api
Url String - The URL to the rancher API
- access
Key String - API Key used to authenticate with the rancher server
- bootstrap Boolean
- Bootstrap rancher server
It can also be sourced from the following environment variable:
RANCHER_BOOTSTRAP - ca
Certs String - CA certificates used to sign rancher server tls certificates. Mandatory if self signed tls and insecure option false
- insecure Boolean
- Allow insecure connections to Rancher. Mandatory if self signed tls and not ca_certs provided
It can also be sourced from the following environment variable:
RANCHER_INSECURE - retries Integer
- Rancher connection retries
- secret
Key String - API secret used to authenticate with the rancher server
- timeout String
- Rancher connection timeout (retry every 5s). Golang duration format, ex: "60s"
- token
Key String - API token used to authenticate with the rancher server
- api
Url string - The URL to the rancher API
- access
Key string - API Key used to authenticate with the rancher server
- bootstrap boolean
- Bootstrap rancher server
It can also be sourced from the following environment variable:
RANCHER_BOOTSTRAP - ca
Certs string - CA certificates used to sign rancher server tls certificates. Mandatory if self signed tls and insecure option false
- insecure boolean
- Allow insecure connections to Rancher. Mandatory if self signed tls and not ca_certs provided
It can also be sourced from the following environment variable:
RANCHER_INSECURE - retries number
- Rancher connection retries
- secret
Key string - API secret used to authenticate with the rancher server
- timeout string
- Rancher connection timeout (retry every 5s). Golang duration format, ex: "60s"
- token
Key string - API token used to authenticate with the rancher server
- api_
url str - The URL to the rancher API
- access_
key str - API Key used to authenticate with the rancher server
- bootstrap bool
- Bootstrap rancher server
It can also be sourced from the following environment variable:
RANCHER_BOOTSTRAP - ca_
certs str - CA certificates used to sign rancher server tls certificates. Mandatory if self signed tls and insecure option false
- insecure bool
- Allow insecure connections to Rancher. Mandatory if self signed tls and not ca_certs provided
It can also be sourced from the following environment variable:
RANCHER_INSECURE - retries int
- Rancher connection retries
- secret_
key str - API secret used to authenticate with the rancher server
- timeout str
- Rancher connection timeout (retry every 5s). Golang duration format, ex: "60s"
- token_
key str - API token used to authenticate with the rancher server
- api
Url String - The URL to the rancher API
- access
Key String - API Key used to authenticate with the rancher server
- bootstrap Boolean
- Bootstrap rancher server
It can also be sourced from the following environment variable:
RANCHER_BOOTSTRAP - ca
Certs String - CA certificates used to sign rancher server tls certificates. Mandatory if self signed tls and insecure option false
- insecure Boolean
- Allow insecure connections to Rancher. Mandatory if self signed tls and not ca_certs provided
It can also be sourced from the following environment variable:
RANCHER_INSECURE - retries Number
- Rancher connection retries
- secret
Key String - API secret used to authenticate with the rancher server
- timeout String
- Rancher connection timeout (retry every 5s). Golang duration format, ex: "60s"
- token
Key String - API token used to authenticate with the rancher server
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.
Package Details
- Repository
- Rancher2 pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
rancher2Terraform Provider.