Provider

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 a Provider Resource

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);

@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,
             token_key: Optional[str] = None)
@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)

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.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Provider resource accepts the following input properties:

ApiUrl string: The URL to the rancher API
AccessKey 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
CaCerts 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
SecretKey string: API secret used to authenticate with the rancher server
TokenKey string: API token used to authenticate with the rancher server

ApiUrl string: The URL to the rancher API
AccessKey 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
CaCerts 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
SecretKey string: API secret used to authenticate with the rancher server
TokenKey string: API token used to authenticate with the rancher server

apiUrl string: The URL to the rancher API
accessKey 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
caCerts 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
secretKey string: API secret used to authenticate with the rancher server
tokenKey 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
token_key str: 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 str: The provider-assigned unique ID for this managed resource.

Package Details

Repository: https://github.com/pulumi/pulumi-rancher2
License: Apache-2.0
Notes: This Pulumi package is based on the rancher2 Terraform Provider.