Package @pulumi/rancher2

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-rancher2 repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-rancher2 repo.

var rancher2 = require("@pulumi/rancher2");

import * as rancher2 from "@pulumi/rancher2";

Modules

Resources

Functions

Others

ActiveDirectoryArgs
ActiveDirectoryState
AppArgs
AppState
AuthConfigAdfsArgs
AuthConfigAdfsState
AuthConfigAzureAdArgs
AuthConfigAzureAdState
AuthConfigFreeIpaArgs
AuthConfigFreeIpaState
AuthConfigGithubArgs
AuthConfigGithubState
AuthConfigKeycloakArgs
AuthConfigKeycloakState
AuthConfigOktaArgs
AuthConfigOktaState
AuthConfigOpenLdapArgs
AuthConfigOpenLdapState
AuthConfigPingArgs
AuthConfigPingState
BootstrapArgs
BootstrapState
CatalogArgs
CatalogState
CertificateArgs
CertificateState
CloudCredentialArgs
CloudCredentialState
ClusterAlterGroupArgs
ClusterAlterGroupState
ClusterAlterRuleArgs
ClusterAlterRuleState
ClusterArgs
ClusterDriverArgs
ClusterDriverState
ClusterLoggingArgs
ClusterLoggingState
ClusterRoleTemplateBindingArgs
ClusterRoleTemplateBindingState
ClusterState
ClusterSyncArgs
ClusterSyncState
ClusterTemplateArgs
ClusterTemplateState
EtcdBackupArgs
EtcdBackupState
GetAppArgs
GetAppResult
GetCatalogArgs
GetCatalogResult
GetCertificateArgs
GetCertificateResult
GetCloudCredentialArgs
GetCloudCredentialResult
GetClusterAlertGroupArgs
GetClusterAlertGroupResult
GetClusterAlterRuleArgs
GetClusterAlterRuleResult
GetClusterArgs
GetClusterDriverArgs
GetClusterDriverResult
GetClusterLoggingArgs
GetClusterLoggingResult
GetClusterResult
GetClusterRoleTemplateBindingArgs
GetClusterRoleTemplateBindingResult
GetClusterScanArgs
GetClusterScanResult
GetClusterTemplateArgs
GetClusterTemplateResult
getEnv
getEnvBoolean
getEnvNumber
GetEtcdBackupArgs
GetEtcdBackupResult
GetGlobalRoleBindingArgs
GetGlobalRoleBindingResult
GetMultiClusterAppArgs
GetMultiClusterAppResult
GetNamespaceArgs
GetNamespaceResult
GetNodeDriverArgs
GetNodeDriverResult
GetNodePoolArgs
GetNodePoolResult
GetNodeTemplateArgs
GetNodeTemplateResult
GetNotifierArgs
GetNotifierResult
GetPodSecurityPolicyTemplateArgs
GetPodSecurityPolicyTemplateResult
GetProjectAlertGroupArgs
GetProjectAlertGroupResult
GetProjectAlertRuleArgs
GetProjectAlertRuleResult
GetProjectArgs
GetProjectLoggingArgs
GetProjectLoggingResult
GetProjectResult
GetProjectRoleTemplateBindingArgs
GetProjectRoleTemplateBindingResult
GetRegistryArgs
GetRegistryResult
GetRoleTempalteArgs
GetRoleTempalteResult
GetRoleTemplateArgs
GetRoleTemplateResult
GetSecretArgs
GetSecretResult
GetSettingArgs
GetSettingResult
GetUserArgs
GetUserResult
getVersion
GlobalRoleBindingArgs
GlobalRoleBindingState
MultiClusterAppArgs
MultiClusterAppState
NamespaceArgs
NamespaceState
NodeDriverArgs
NodeDriverState
NodePoolArgs
NodePoolState
NodeTemplateArgs
NodeTemplateState
NotifierArgs
NotifierState
PodSecurityPolicyTemplateArgs
PodSecurityPolicyTemplateState
ProjectAlertGroupArgs
ProjectAlertGroupState
ProjectAlertRuleArgs
ProjectAlertRuleState
ProjectArgs
ProjectLoggingArgs
ProjectLoggingState
ProjectRoleTemplateBindingArgs
ProjectRoleTemplateBindingState
ProjectState
ProviderArgs
RegistryArgs
RegistryState
RoleTempalteArgs
RoleTempalteState
SecretArgs
SecretState
SettingArgs
SettingState
TokenArgs
TokenState
UserArgs
UserState

Resources

Resource App

class App extends CustomResource

constructor

new App(name: string, args: AppArgs, opts?: pulumi.CustomResourceOptions)

Create a App resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppState, opts?: pulumi.CustomResourceOptions): App

Get an existing App resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is App

Returns true if the given object is an instance of App. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property answers

public answers: pulumi.Output<{[key: string]: any} | undefined>;

Answers for the app template. If modified, app will be upgraded (map)

property catalogName

public catalogName: pulumi.Output<string>;

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs: * add cluster ID before name, c-XXXXX:<name> * add project ID before name, p-XXXXX:<name>

property externalId

public externalId: pulumi.Output<string>;

(Computed) The url of the app template on a catalog (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

The project id where the app will be installed (string)

property revisionId

public revisionId: pulumi.Output<string>;

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revisionId (string)

property targetNamespace

public targetNamespace: pulumi.Output<string>;

The namespace name where the app will be installed (string)

property templateName

public templateName: pulumi.Output<string>;

Template name of the app. If modified, app will be upgraded (string)

property templateVersion

public templateVersion: pulumi.Output<string>;

Template version of the app. If modified, app will be upgraded. Default: latest (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valuesYaml

public valuesYaml: pulumi.Output<string | undefined>;

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

Resource AuthConfigAzureAd

class AuthConfigAzureAd extends CustomResource

Provides a Rancher v2 Auth Config AzureAD resource. This can be used to configure and enable Auth Config AzureAD for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Auth Config AzureAD
const azuread = new rancher2.AuthConfigAzureAd("azuread", {
    applicationId: "<AZUREAD_APP_ID>",
    applicationSecret: "<AZUREAD_APP_SECRET>",
    authEndpoint: "<AZUREAD_AUTH_ENDPOINT>",
    graphEndpoint: "<AZUREAD_GRAPH_ENDPOINT>",
    rancherUrl: "<RANCHER_URL>",
    tenantId: "<AZUREAD_TENANT_ID>",
    tokenEndpoint: "<AZUREAD_TOKEN_ENDPOINT>",
});

constructor

new AuthConfigAzureAd(name: string, args: AuthConfigAzureAdArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigAzureAd resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigAzureAdState, opts?: pulumi.CustomResourceOptions): AuthConfigAzureAd

Get an existing AuthConfigAzureAd resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigAzureAd

Returns true if the given object is an instance of AuthConfigAzureAd. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property endpoint

public endpoint: pulumi.Output<string | undefined>;

AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property rancherUrl

public rancherUrl: pulumi.Output<string>;

Rancher URL (string). “/verify-auth-azure”

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AuthConfigGithub

class AuthConfigGithub extends CustomResource

Provides a Rancher v2 Auth Config Github resource. This can be used to configure and enable Auth Config Github for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Auth Config Github
const github = new rancher2.AuthConfigGithub("github", {
    clientId: "<GITHUB_CLIENT_ID>",
    clientSecret: "<GITHUB_CLIENT_SECRET>",
});

constructor

new AuthConfigGithub(name: string, args: AuthConfigGithubArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigGithub resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigGithubState, opts?: pulumi.CustomResourceOptions): AuthConfigGithub

Get an existing AuthConfigGithub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigGithub

Returns true if the given object is an instance of AuthConfigGithub. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property hostname

public hostname: pulumi.Output<string | undefined>;

Github hostname to connect. Default github.com (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property tls

public tls: pulumi.Output<boolean | undefined>;

Enable TLS connection. Default true (bool)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Catalog

class Catalog extends CustomResource

Provides a Rancher v2 Catalog resource. This can be used to create cluster, global and/or project catalogs for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new Rancher2 Global Catalog
const fooGlobal = new rancher2.Catalog("foo-global", {
    url: "https://<CATALOG_URL>",
});
// Create a new Rancher2 Cluster Catalog
const fooCluster = new rancher2.Catalog("foo-cluster", {
    scope: "cluster",
    url: "https://<CATALOG_URL>",
});
// Create a new Rancher2 Project Catalog
const fooProject = new rancher2.Catalog("foo-project", {
    scope: "project",
    url: "https://<CATALOG_URL>",
});

constructor

new Catalog(name: string, args: CatalogArgs, opts?: pulumi.CustomResourceOptions)

Create a Catalog resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CatalogState, opts?: pulumi.CustomResourceOptions): Catalog

Get an existing Catalog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Catalog

Returns true if the given object is an instance of Catalog. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property branch

public branch: pulumi.Output<string | undefined>;

The branch of the catalog repo to use. Default master (string)

property clusterId

public clusterId: pulumi.Output<string | undefined>;

The cluster id of the catalog. Mandatory if scope = cluster (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<string | undefined>;

The kind of the catalog. Just helm by the moment (string)

property password

public password: pulumi.Output<string | undefined>;

The password to access the catalog if needed (string)

property projectId

public projectId: pulumi.Output<string | undefined>;

The project id of the catalog. Mandatory if scope = project (string)

property refresh

public refresh: pulumi.Output<boolean | undefined>;

Catalog will wait for refresh after tf creation and on every tf read. Default false (bool)

property scope

public scope: pulumi.Output<string | undefined>;

The scope of the catalog. cluster, global, and project are supported. Default global (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string | undefined>;

The username to access the catalog if needed (string)

property version

public version: pulumi.Output<string>;

Helm version for the catalog. Available options: helmV2 and helmV3 (string)

Resource Certificate

class Certificate extends CustomResource

Provides a Rancher v2 certificate resource. This can be used to create certificates for Rancher v2 environments and retrieve their information.

There are 2 types of Rancher v2 certificates: - Project certificate: Available to all namespaces in the projectId - Namespaced certificate: Available to just namespaceId in the projectId

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a Certificate resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate

Get an existing Certificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Certificate

Returns true if the given object is an instance of Certificate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id where the namespaced certificate should be created (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where the certificate should be created (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CloudCredential

class CloudCredential extends CustomResource

Provides a Rancher v2 Cloud Credential resource. This can be used to create Cloud Credential for Rancher v2.2.x and retrieve their information.

amazonec2, azure, digitalocean, linode, openstack and vsphere credentials config are supported for Cloud Credential.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Cloud Credential
const foo = new rancher2.CloudCredential("foo", {
    amazonec2CredentialConfig: {
        accessKey: "<AWS_ACCESS_KEY>",
        secretKey: "<AWS_SECRET_KEY>",
    },
    description: "foo test",
});

constructor

new CloudCredential(name: string, args?: CloudCredentialArgs, opts?: pulumi.CustomResourceOptions)

Create a CloudCredential resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CloudCredentialState, opts?: pulumi.CustomResourceOptions): CloudCredential

Get an existing CloudCredential resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CloudCredential

Returns true if the given object is an instance of CloudCredential. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property amazonec2CredentialConfig

public amazonec2CredentialConfig: pulumi.Output<CloudCredentialAmazonec2CredentialConfig | undefined>;

AWS config for the Cloud Credential (list maxitems:1)

property annotations

public annotations: pulumi.Output<{[key: string]: any} | undefined>;

Annotations for Cloud Credential object (map)

property azureCredentialConfig

public azureCredentialConfig: pulumi.Output<CloudCredentialAzureCredentialConfig | undefined>;

Azure config for the Cloud Credential (list maxitems:1)

property description

public description: pulumi.Output<string | undefined>;

Description for the Cloud Credential (string)

property digitaloceanCredentialConfig

public digitaloceanCredentialConfig: pulumi.Output<CloudCredentialDigitaloceanCredentialConfig | undefined>;

DigitalOcean config for the Cloud Credential (list maxitems:1)

property driver

public driver: pulumi.Output<string>;

(Computed) The driver of the Cloud Credential (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property linodeCredentialConfig

public linodeCredentialConfig: pulumi.Output<CloudCredentialLinodeCredentialConfig | undefined>;

Linode config for the Cloud Credential (list maxitems:1)

property name

public name: pulumi.Output<string>;

The name of the Cloud Credential (string)

property openstackCredentialConfig

public openstackCredentialConfig: pulumi.Output<CloudCredentialOpenstackCredentialConfig | undefined>;

OpenStack config for the Cloud Credential (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vsphereCredentialConfig

public vsphereCredentialConfig: pulumi.Output<CloudCredentialVsphereCredentialConfig | undefined>;

vSphere config for the Cloud Credential (list maxitems:1)

Resource Cluster

class Cluster extends CustomResource

Provides a Rancher v2 Cluster resource. This can be used to create Clusters for Rancher v2 environments and retrieve their information.

constructor

new Cluster(name: string, args?: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cluster

Returns true if the given object is an instance of Cluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property aksConfig

public aksConfig: pulumi.Output<ClusterAksConfig | undefined>;

The Azure AKS configuration for aks Clusters. Conflicts with eksConfig, gkeConfig, k3sConfig and rkeConfig (list maxitems:1)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for cluster registration token object (map)

property clusterAuthEndpoint

public clusterAuthEndpoint: pulumi.Output<ClusterClusterAuthEndpoint>;

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

property clusterMonitoringInput

public clusterMonitoringInput: pulumi.Output<ClusterClusterMonitoringInput>;

Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property clusterRegistrationToken

public clusterRegistrationToken: pulumi.Output<ClusterClusterRegistrationToken>;

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

property clusterTemplateAnswers

public clusterTemplateAnswers: pulumi.Output<ClusterClusterTemplateAnswers>;

Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)

property clusterTemplateId

public clusterTemplateId: pulumi.Output<string | undefined>;

Cluster template ID. Just for Rancher v2.3.x and above (string)

property clusterTemplateQuestions

public clusterTemplateQuestions: pulumi.Output<ClusterClusterTemplateQuestion[] | undefined>;

Cluster template questions. Just for Rancher v2.3.x and above (list)

property clusterTemplateRevisionId

public clusterTemplateRevisionId: pulumi.Output<string | undefined>;

Cluster template revision ID. Just for Rancher v2.3.x and above (string)

property defaultPodSecurityPolicyTemplateId

public defaultPodSecurityPolicyTemplateId: pulumi.Output<string>;

Default pod security policy template id (string)

property defaultProjectId

public defaultProjectId: pulumi.Output<string>;

(Computed) Default project ID for the cluster (string)

property description

public description: pulumi.Output<string | undefined>;

An optional description of this cluster (string)

property desiredAgentImage

public desiredAgentImage: pulumi.Output<string>;

Desired agent image. Just for Rancher v2.3.x and above (string)

property desiredAuthImage

public desiredAuthImage: pulumi.Output<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property dockerRootDir

public dockerRootDir: pulumi.Output<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property driver

public driver: pulumi.Output<string>;

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

property eksConfig

public eksConfig: pulumi.Output<ClusterEksConfig | undefined>;

The Amazon EKS configuration for eks Clusters. Conflicts with aksConfig, gkeConfig, k3sConfig and rkeConfig (list maxitems:1)

property enableClusterAlerting

public enableClusterAlerting: pulumi.Output<boolean | undefined>;

Enable built-in cluster alerting. Default false (bool)

property enableClusterIstio

public enableClusterIstio: pulumi.Output<boolean | undefined>;

Enable built-in cluster istio. Default false. Just for Rancher v2.3.x and above (bool)

property enableClusterMonitoring

public enableClusterMonitoring: pulumi.Output<boolean | undefined>;

Enable built-in cluster monitoring. Default false (bool)

property enableNetworkPolicy

public enableNetworkPolicy: pulumi.Output<boolean | undefined>;

Enable project network isolation. Default false (bool)

property gkeConfig

public gkeConfig: pulumi.Output<ClusterGkeConfig | undefined>;

The Google GKE configuration for gke Clusters. Conflicts with aksConfig, eksConfig, k3sConfig and rkeConfig (list maxitems:1)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property k3sConfig

public k3sConfig: pulumi.Output<ClusterK3sConfig>;

The K3S configuration for k3s imported Clusters. Conflicts with aksConfig, eksConfig, gkeConfig and rkeConfig (list maxitems:1)

property kubeConfig

public kubeConfig: pulumi.Output<string>;

(Computed/Sensitive) Kube Config generated for the cluster (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for cluster registration token object (map)

property name

public name: pulumi.Output<string>;

Name of cluster registration token (string)

property rkeConfig

public rkeConfig: pulumi.Output<ClusterRkeConfig>;

The RKE configuration for rke Clusters. Conflicts with aksConfig, eksConfig, gkeConfig and k3sConfig (list maxitems:1)

property scheduledClusterScan

public scheduledClusterScan: pulumi.Output<ClusterScheduledClusterScan | undefined>;

Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)

property systemProjectId

public systemProjectId: pulumi.Output<string>;

(Computed) System project ID for the cluster (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property windowsPreferedCluster

public windowsPreferedCluster: pulumi.Output<boolean | undefined>;

Windows preferred cluster. Default: false (bool)

Resource ClusterAlterGroup

class ClusterAlterGroup extends CustomResource

constructor

new ClusterAlterGroup(name: string, args: ClusterAlterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterAlterGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterAlterGroupState, opts?: pulumi.CustomResourceOptions): ClusterAlterGroup

Get an existing ClusterAlterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterAlterGroup

Returns true if the given object is an instance of ClusterAlterGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

The cluster alert group annotations (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create cluster alert group (string)

property description

public description: pulumi.Output<string | undefined>;

The cluster alert group description (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The cluster alert group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property recipients

public recipients: pulumi.Output<ClusterAlterGroupRecipient[] | undefined>;

The cluster alert group recipients (list)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert group wait seconds. Default: 3600 (int)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterAlterRule

class ClusterAlterRule extends CustomResource

constructor

new ClusterAlterRule(name: string, args: ClusterAlterRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterAlterRule resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterAlterRuleState, opts?: pulumi.CustomResourceOptions): ClusterAlterRule

Get an existing ClusterAlterRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterAlterRule

Returns true if the given object is an instance of ClusterAlterRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create cluster alert rule (string)

property eventRule

public eventRule: pulumi.Output<ClusterAlterRuleEventRule | undefined>;

The cluster alert rule event rule. ConflictsWith: "metricRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property groupId

public groupId: pulumi.Output<string>;

The cluster alert rule alert group ID (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The cluster alert rule group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inherited

public inherited: pulumi.Output<boolean | undefined>;

The cluster alert rule inherited. Default: true (bool)

property metricRule

public metricRule: pulumi.Output<ClusterAlterRuleMetricRule | undefined>;

The cluster alert rule metric rule. ConflictsWith: "eventRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property nodeRule

public nodeRule: pulumi.Output<ClusterAlterRuleNodeRule | undefined>;

The cluster alert rule node rule. ConflictsWith: "eventRule", "metricRule", "systemServiceRule"` (list Maxitems:1)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert rule wait seconds. Default: 3600 (int)

property severity

public severity: pulumi.Output<string | undefined>;

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property systemServiceRule

public systemServiceRule: pulumi.Output<ClusterAlterRuleSystemServiceRule | undefined>;

The cluster alert rule system service rule. ConflictsWith: "eventRule", "metricRule", "nodeRule"` (list Maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterLogging

class ClusterLogging extends CustomResource

Provides a Rancher v2 Cluster Logging resource. This can be used to configure Cluster Logging for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new Rancher2 Cluster Logging
const foo = new rancher2.ClusterLogging("foo", {
    clusterId: "<cluster_id>",
    kind: "syslog",
    syslogConfig: {
        endpoint: "<syslog_endpoint>",
        protocol: "udp",
        severity: "notice",
        sslVerify: false,
    },
});

constructor

new ClusterLogging(name: string, args: ClusterLoggingArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterLogging resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterLoggingState, opts?: pulumi.CustomResourceOptions): ClusterLogging

Get an existing ClusterLogging resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterLogging

Returns true if the given object is an instance of ClusterLogging. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Cluster Logging object (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id to configure logging (string)

property customTargetConfig

public customTargetConfig: pulumi.Output<ClusterLoggingCustomTargetConfig | undefined>;

The custom target config for Cluster Logging. For kind = custom. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property elasticsearchConfig

public elasticsearchConfig: pulumi.Output<ClusterLoggingElasticsearchConfig | undefined>;

The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with customTargetConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property enableJsonParsing

public enableJsonParsing: pulumi.Output<boolean | undefined>;

Enable json log parsing. Default: false (bool)

property fluentdConfig

public fluentdConfig: pulumi.Output<ClusterLoggingFluentdConfig | undefined>;

The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with customTargetConfig, elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kafkaConfig

public kafkaConfig: pulumi.Output<ClusterLoggingKafkaConfig | undefined>;

The kafka config for Cluster Logging. For kind = kafka. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

public kind: pulumi.Output<string>;

The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property name

public name: pulumi.Output<string>;

The name of the cluster logging config (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id from cluster logging (string)

property outputFlushInterval

public outputFlushInterval: pulumi.Output<number | undefined>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

public outputTags: pulumi.Output<{[key: string]: any}>;

The output tags for Cluster Logging (map)

property splunkConfig

public splunkConfig: pulumi.Output<ClusterLoggingSplunkConfig | undefined>;

The splunk config for Cluster Logging. For kind = splunk. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

public syslogConfig: pulumi.Output<ClusterLoggingSyslogConfig | undefined>;

The syslog config for Cluster Logging. For kind = syslog. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterRoleTemplateBinding

class ClusterRoleTemplateBinding extends CustomResource

Provides a Rancher v2 Cluster Role Template Binding resource. This can be used to create Cluster Role Template Bindings for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new Rancher2 Cluster Role Template Binding
const foo = new rancher2.ClusterRoleTemplateBinding("foo", {
    clusterId: "<cluster_id>",
    roleTemplateId: "<role_template_id>",
    userId: "<user_id>",
});

constructor

new ClusterRoleTemplateBinding(name: string, args: ClusterRoleTemplateBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterRoleTemplateBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterRoleTemplateBindingState, opts?: pulumi.CustomResourceOptions): ClusterRoleTemplateBinding

Get an existing ClusterRoleTemplateBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterRoleTemplateBinding

Returns true if the given object is an instance of ClusterRoleTemplateBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for cluster role template binding (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where bind cluster role template binding (string)

property groupId

public groupId: pulumi.Output<string | undefined>;

The group ID to assign cluster role template binding (string)

property groupPrincipalId

public groupPrincipalId: pulumi.Output<string>;

The groupPrincipal ID to assign cluster role template binding (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for cluster role template binding (map)

property name

public name: pulumi.Output<string>;

The name of the cluster role template binding (string)

property roleTemplateId

public roleTemplateId: pulumi.Output<string>;

The role template id from create cluster role template binding (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string | undefined>;

The user ID to assign cluster role template binding (string)

property userPrincipalId

public userPrincipalId: pulumi.Output<string>;

The userPrincipal ID to assign cluster role template binding (string)

Resource ClusterSync

class ClusterSync extends CustomResource

constructor

new ClusterSync(name: string, args: ClusterSyncArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterSync resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterSyncState, opts?: pulumi.CustomResourceOptions): ClusterSync

Get an existing ClusterSync resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterSync

Returns true if the given object is an instance of ClusterSync. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property defaultProjectId

public defaultProjectId: pulumi.Output<string>;

(Computed) Default project ID for the cluster sync (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kubeConfig

public kubeConfig: pulumi.Output<string>;

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

property nodePoolIds

public nodePoolIds: pulumi.Output<string[] | undefined>;

The node pool IDs used by the cluster id (list)

property synced

public synced: pulumi.Output<boolean | undefined>;

property systemProjectId

public systemProjectId: pulumi.Output<string>;

(Computed) System project ID for the cluster sync (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property waitMonitoring

public waitMonitoring: pulumi.Output<boolean | undefined>;

Wait until monitoring is up and running. Default: false (bool)

Resource ClusterTemplate

class ClusterTemplate extends CustomResource

constructor

new ClusterTemplate(name: string, args?: ClusterTemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterTemplate resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterTemplateState, opts?: pulumi.CustomResourceOptions): ClusterTemplate

Get an existing ClusterTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterTemplate

Returns true if the given object is an instance of ClusterTemplate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for the cluster template revision (map)

property defaultRevisionId

public defaultRevisionId: pulumi.Output<string>;

(Computed) Default cluster template revision ID (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for the cluster template revision (map)

property name

public name: pulumi.Output<string>;

The cluster template revision name (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EtcdBackup

class EtcdBackup extends CustomResource

constructor

new EtcdBackup(name: string, args: EtcdBackupArgs, opts?: pulumi.CustomResourceOptions)

Create a EtcdBackup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EtcdBackupState, opts?: pulumi.CustomResourceOptions): EtcdBackup

Get an existing EtcdBackup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EtcdBackup

Returns true if the given object is an instance of EtcdBackup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backupConfig

public backupConfig: pulumi.Output<EtcdBackupBackupConfig>;

Backup config for etcd backup (list maxitems:1)

property clusterId

public clusterId: pulumi.Output<string>;

Cluster ID to config Etcd Backup (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property manual

public manual: pulumi.Output<boolean | undefined>;

Manual execution of the Etcd Backup. Default false (bool)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GlobalRoleBinding

class GlobalRoleBinding extends CustomResource

Provides a Rancher v2 Global Role Binding resource. This can be used to create Global Role Bindings for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Global Role Binding using userId
const foo = new rancher2.GlobalRoleBinding("foo", {
    globalRoleId: "admin",
    userId: "user-XXXXX",
});
// Create a new rancher2 Global Role Binding using groupPrincipalId
const foo2 = new rancher2.GlobalRoleBinding("foo2", {
    globalRoleId: "admin",
    groupPrincipalId: "local://g-XXXXX",
});

constructor

new GlobalRoleBinding(name: string, args: GlobalRoleBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a GlobalRoleBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GlobalRoleBindingState, opts?: pulumi.CustomResourceOptions): GlobalRoleBinding

Get an existing GlobalRoleBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GlobalRoleBinding

Returns true if the given object is an instance of GlobalRoleBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for global role binding (map)

property globalRoleId

public globalRoleId: pulumi.Output<string>;

The role id from create global role binding (string)

property groupPrincipalId

public groupPrincipalId: pulumi.Output<string>;

The group principal ID to assign global role binding (only works with external auth providers that support groups). Rancher v2.4.0 or higher is required (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the global role binding (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

The user ID to assign global role binding (string)

Resource MultiClusterApp

class MultiClusterApp extends CustomResource

constructor

new MultiClusterApp(name: string, args: MultiClusterAppArgs, opts?: pulumi.CustomResourceOptions)

Create a MultiClusterApp resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MultiClusterAppState, opts?: pulumi.CustomResourceOptions): MultiClusterApp

Get an existing MultiClusterApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MultiClusterApp

Returns true if the given object is an instance of MultiClusterApp. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for multi cluster app object (map)

property catalogName

public catalogName: pulumi.Output<string>;

The multi cluster app catalog name (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for multi cluster app object (map)

property revisionHistoryLimit

public revisionHistoryLimit: pulumi.Output<number | undefined>;

The multi cluster app revision history limit. Default 10 (int)

property revisionId

public revisionId: pulumi.Output<string>;

Current revision id for the multi cluster app (string)

property targets

public targets: pulumi.Output<MultiClusterAppTarget[]>;

The multi cluster app target projects (list)

property templateName

public templateName: pulumi.Output<string>;

The multi cluster app template name (string)

property templateVersion

public templateVersion: pulumi.Output<string>;

The multi cluster app template version. Default: latest (string)

property templateVersionId

public templateVersionId: pulumi.Output<string>;

(Computed) The multi cluster app template version ID (string)

property upgradeStrategy

public upgradeStrategy: pulumi.Output<MultiClusterAppUpgradeStrategy>;

The multi cluster app upgrade strategy (list MaxItems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property wait

public wait: pulumi.Output<boolean | undefined>;

Wait until the multi cluster app is active. Default true (bool)

Resource Namespace

class Namespace extends CustomResource

Provides a Rancher v2 Namespace resource. This can be used to create namespaces for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Namespace
const foo = new rancher2.Namespace("foo", {
    containerResourceLimit: {
        limitsCpu: "20m",
        limitsMemory: "20Mi",
        requestsCpu: "1m",
        requestsMemory: "1Mi",
    },
    description: "foo namespace",
    projectId: "<PROJECT_ID>",
    resourceQuota: {
        limit: {
            limitsCpu: "100m",
            limitsMemory: "100Mi",
            requestsStorage: "1Gi",
        },
    },
});

constructor

new Namespace(name: string, args: NamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a Namespace resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NamespaceState, opts?: pulumi.CustomResourceOptions): Namespace

Get an existing Namespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Namespace

Returns true if the given object is an instance of Namespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property containerResourceLimit

public containerResourceLimit: pulumi.Output<NamespaceContainerResourceLimit | undefined>;

Default containers resource limits on namespace (List maxitem:1)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

The project id where assign namespace. It’s on the form project_id=<cluster_id>:<id>. Updating <id> part on same <cluster_id> namespace will be moved between projects (string)

property resourceQuota

public resourceQuota: pulumi.Output<NamespaceResourceQuota | undefined>;

Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property waitForCluster

public waitForCluster: pulumi.Output<boolean | undefined>;

Wait for cluster becomes active. Default false (bool)

Resource NodeTemplate

class NodeTemplate extends CustomResource

Provides a Rancher v2 Node Template resource. This can be used to create Node Template for Rancher v2 and retrieve their information.

amazonec2, azure, digitalocean, linode, opennebula, openstack, and vsphere drivers are supported for node templates.

Note If you are upgrading to Rancher v2.3.3, please take a look to final section

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Node Template up to Rancher 2.1.x
const foo = new rancher2.NodeTemplate("foo", {
    amazonec2Config: {
        accessKey: "AWS_ACCESS_KEY",
        ami: "<AMI_ID>",
        region: "<REGION>",
        secretKey: "<AWS_SECRET_KEY>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
    description: "foo test",
});

constructor

new NodeTemplate(name: string, args?: NodeTemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a NodeTemplate resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NodeTemplateState, opts?: pulumi.CustomResourceOptions): NodeTemplate

Get an existing NodeTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NodeTemplate

Returns true if the given object is an instance of NodeTemplate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property amazonec2Config

public amazonec2Config: pulumi.Output<NodeTemplateAmazonec2Config | undefined>;

AWS config for the Node Template (list maxitems:1)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Node Template object (map)

property authCertificateAuthority

public authCertificateAuthority: pulumi.Output<string | undefined>;

Auth certificate authority for the Node Template (string)

property azureConfig

public azureConfig: pulumi.Output<NodeTemplateAzureConfig | undefined>;

Azure config for the Node Template (list maxitems:1)

property cloudCredentialId

public cloudCredentialId: pulumi.Output<string | undefined>;

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

property description

public description: pulumi.Output<string | undefined>;

Description for the Node Template (string)

property digitaloceanConfig

public digitaloceanConfig: pulumi.Output<NodeTemplateDigitaloceanConfig | undefined>;

Digitalocean config for the Node Template (list maxitems:1)

property driver

public driver: pulumi.Output<string>;

(Computed) The driver of the node template (string)

property driverId

public driverId: pulumi.Output<string>;

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

property engineEnv

public engineEnv: pulumi.Output<{[key: string]: any} | undefined>;

Engine environment for the node template (string)

property engineInsecureRegistries

public engineInsecureRegistries: pulumi.Output<string[] | undefined>;

Insecure registry for the node template (list)

property engineInstallUrl

public engineInstallUrl: pulumi.Output<string | undefined>;

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

property engineLabel

public engineLabel: pulumi.Output<{[key: string]: any} | undefined>;

Engine label for the node template (string)

property engineOpt

public engineOpt: pulumi.Output<{[key: string]: any} | undefined>;

Engine options for the node template (map)

property engineRegistryMirrors

public engineRegistryMirrors: pulumi.Output<string[] | undefined>;

Engine registry mirror for the node template (list)

property engineStorageDriver

public engineStorageDriver: pulumi.Output<string | undefined>;

Engine storage driver for the node template (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Node Template object (map)

property linodeConfig

public linodeConfig: pulumi.Output<NodeTemplateLinodeConfig | undefined>;

Linode config for the Node Template (list maxitems:1)

property name

public name: pulumi.Output<string>;

The name of the Node Template (string)

property opennebulaConfig

public opennebulaConfig: pulumi.Output<NodeTemplateOpennebulaConfig | undefined>;

Opennebula config for the Node Template (list maxitems:1)

property openstackConfig

public openstackConfig: pulumi.Output<NodeTemplateOpenstackConfig | undefined>;

Openstack config for the Node Template (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property useInternalIpAddress

public useInternalIpAddress: pulumi.Output<boolean | undefined>;

Engine storage driver for the node template (bool)

property vsphereConfig

public vsphereConfig: pulumi.Output<NodeTemplateVsphereConfig | undefined>;

vSphere config for the Node Template (list maxitems:1)

Resource Notifier

class Notifier extends CustomResource

constructor

new Notifier(name: string, args: NotifierArgs, opts?: pulumi.CustomResourceOptions)

Create a Notifier resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotifierState, opts?: pulumi.CustomResourceOptions): Notifier

Get an existing Notifier resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Notifier

Returns true if the given object is an instance of Notifier. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for notifier object (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create notifier (string)

property description

public description: pulumi.Output<string | undefined>;

The notifier description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for notifier object (map)

property name

public name: pulumi.Output<string>;

The name of the notifier (string)

property pagerdutyConfig

public pagerdutyConfig: pulumi.Output<NotifierPagerdutyConfig | undefined>;

Pagerduty config for notifier (list maxitems:1)

property sendResolved

public sendResolved: pulumi.Output<boolean | undefined>;

= (Optional) Enable the notifier to send resolved notifications. Default false (bool)

property slackConfig

public slackConfig: pulumi.Output<NotifierSlackConfig | undefined>;

Slack config for notifier (list maxitems:1)

property smtpConfig

public smtpConfig: pulumi.Output<NotifierSmtpConfig | undefined>;

SMTP config for notifier (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property webhookConfig

public webhookConfig: pulumi.Output<NotifierWebhookConfig | undefined>;

Webhook config for notifier (list maxitems:1)

property wechatConfig

public wechatConfig: pulumi.Output<NotifierWechatConfig | undefined>;

Wechat config for notifier (list maxitems:1)

Resource PodSecurityPolicyTemplate

class PodSecurityPolicyTemplate extends CustomResource

constructor

new PodSecurityPolicyTemplate(name: string, args?: PodSecurityPolicyTemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a PodSecurityPolicyTemplate resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PodSecurityPolicyTemplateState, opts?: pulumi.CustomResourceOptions): PodSecurityPolicyTemplate

Get an existing PodSecurityPolicyTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PodSecurityPolicyTemplate

Returns true if the given object is an instance of PodSecurityPolicyTemplate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowPrivilegeEscalation

public allowPrivilegeEscalation: pulumi.Output<boolean>;

= (Optional)

property allowedCapabilities

public allowedCapabilities: pulumi.Output<string[] | undefined>;

(list)

property allowedCsiDrivers

public allowedCsiDrivers: pulumi.Output<PodSecurityPolicyTemplateAllowedCsiDriver[] | undefined>;

(list)

property allowedFlexVolumes

public allowedFlexVolumes: pulumi.Output<PodSecurityPolicyTemplateAllowedFlexVolume[] | undefined>;

(list)

property allowedHostPaths

public allowedHostPaths: pulumi.Output<PodSecurityPolicyTemplateAllowedHostPath[] | undefined>;

(list)

property allowedProcMountTypes

public allowedProcMountTypes: pulumi.Output<string[] | undefined>;

(list)

property allowedUnsafeSysctls

public allowedUnsafeSysctls: pulumi.Output<string[] | undefined>;

(list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for PodSecurityPolicyTemplate object (map)

property defaultAddCapabilities

public defaultAddCapabilities: pulumi.Output<string[] | undefined>;

(list)

property defaultAllowPrivilegeEscalation

public defaultAllowPrivilegeEscalation: pulumi.Output<boolean | undefined>;

(list)

property description

public description: pulumi.Output<string>;

The PodSecurityPolicyTemplate description (string)

property forbiddenSysctls

public forbiddenSysctls: pulumi.Output<string[] | undefined>;

(list)

property fsGroup

public fsGroup: pulumi.Output<PodSecurityPolicyTemplateFsGroup>;

(list maxitems:1)

property hostIpc

public hostIpc: pulumi.Output<boolean>;

(bool)

property hostNetwork

public hostNetwork: pulumi.Output<boolean>;

hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.

property hostPid

public hostPid: pulumi.Output<boolean>;

(bool)

property hostPorts

public hostPorts: pulumi.Output<PodSecurityPolicyTemplateHostPort[]>;

(list)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for PodSecurityPolicyTemplate object (map)

property name

public name: pulumi.Output<string>;

The name of the PodSecurityPolicyTemplate (string)

property privileged

public privileged: pulumi.Output<boolean>;

(bool)

property readOnlyRootFilesystem

public readOnlyRootFilesystem: pulumi.Output<boolean>;

(bool)

property requiredDropCapabilities

public requiredDropCapabilities: pulumi.Output<string[] | undefined>;

(list)

property runAsGroup

public runAsGroup: pulumi.Output<PodSecurityPolicyTemplateRunAsGroup | undefined>;

(list maxitems:1)

property runAsUser

public runAsUser: pulumi.Output<PodSecurityPolicyTemplateRunAsUser>;

(list maxitems:1)

property runtimeClass

public runtimeClass: pulumi.Output<PodSecurityPolicyTemplateRuntimeClass | undefined>;

(list maxitems:1)

property seLinux

public seLinux: pulumi.Output<PodSecurityPolicyTemplateSeLinux>;

(list maxitems:1)

property supplementalGroup

public supplementalGroup: pulumi.Output<PodSecurityPolicyTemplateSupplementalGroup>;

(list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumes

public volumes: pulumi.Output<string[]>;

(list)

Resource Project

class Project extends CustomResource

Provides a Rancher v2 Project resource. This can be used to create projects for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Project
const foo = new rancher2.Project("foo", {
    clusterId: "<CLUSTER_ID>",
    containerResourceLimit: {
        limitsCpu: "20m",
        limitsMemory: "20Mi",
        requestsCpu: "1m",
        requestsMemory: "1Mi",
    },
    resourceQuota: {
        namespaceDefaultLimit: {
            limitsCpu: "2000m",
            limitsMemory: "500Mi",
            requestsStorage: "1Gi",
        },
        projectLimit: {
            limitsCpu: "2000m",
            limitsMemory: "2000Mi",
            requestsStorage: "2Gi",
        },
    },
});

constructor

new Project(name: string, args: ProjectArgs, opts?: pulumi.CustomResourceOptions)

Create a Project resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): Project

Get an existing Project resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Project

Returns true if the given object is an instance of Project. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Node Pool object (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create project (string)

property containerResourceLimit

public containerResourceLimit: pulumi.Output<ProjectContainerResourceLimit | undefined>;

Default containers resource limits on project (List maxitem:1)

property description

public description: pulumi.Output<string | undefined>;

A project description (string)

property enableProjectMonitoring

public enableProjectMonitoring: pulumi.Output<boolean | undefined>;

Enable built-in project monitoring. Default false (bool)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

public name: pulumi.Output<string>;

The name of the project (string)

property podSecurityPolicyTemplateId

public podSecurityPolicyTemplateId: pulumi.Output<string | undefined>;

Default Pod Security Policy ID for the project (string)

property projectMonitoringInput

public projectMonitoringInput: pulumi.Output<ProjectProjectMonitoringInput>;

Project monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property resourceQuota

public resourceQuota: pulumi.Output<ProjectResourceQuota | undefined>;

Resource quota for project. Rancher v2.1.x or higher (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property waitForCluster

public waitForCluster: pulumi.Output<boolean | undefined>;

Wait for cluster becomes active. Default false (bool)

Resource ProjectAlertGroup

class ProjectAlertGroup extends CustomResource

constructor

new ProjectAlertGroup(name: string, args: ProjectAlertGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectAlertGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectAlertGroupState, opts?: pulumi.CustomResourceOptions): ProjectAlertGroup

Get an existing ProjectAlertGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectAlertGroup

Returns true if the given object is an instance of ProjectAlertGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

The project alert group annotations (map)

property description

public description: pulumi.Output<string | undefined>;

The project alert group description (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The project alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The project alert group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

The project alert group labels (map)

property name

public name: pulumi.Output<string>;

The project alert group name (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where create project alert group (string)

property recipients

public recipients: pulumi.Output<ProjectAlertGroupRecipient[] | undefined>;

The project alert group recipients (list)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The project alert group wait seconds. Default: 3600 (int)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectAlertRule

class ProjectAlertRule extends CustomResource

constructor

new ProjectAlertRule(name: string, args: ProjectAlertRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectAlertRule resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectAlertRuleState, opts?: pulumi.CustomResourceOptions): ProjectAlertRule

Get an existing ProjectAlertRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectAlertRule

Returns true if the given object is an instance of ProjectAlertRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

The project alert rule annotations (map)

property groupId

public groupId: pulumi.Output<string>;

The project alert rule alert group ID (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The project alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The project alert rule group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inherited

public inherited: pulumi.Output<boolean | undefined>;

The project alert rule inherited. Default: true (bool)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

The project alert rule labels (map)

property metricRule

public metricRule: pulumi.Output<ProjectAlertRuleMetricRule | undefined>;

The project alert rule metric rule. ConflictsWith: "podRule", "workloadRule"` (list Maxitems:1)

property name

public name: pulumi.Output<string>;

The project alert rule name (string)

property podRule

public podRule: pulumi.Output<ProjectAlertRulePodRule | undefined>;

The project alert rule pod rule. ConflictsWith: "metricRule", "workloadRule"` (list Maxitems:1)

property projectId

public projectId: pulumi.Output<string>;

The project id where create project alert rule (string)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The project alert rule wait seconds. Default: 3600 (int)

property severity

public severity: pulumi.Output<string | undefined>;

The project alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workloadRule

public workloadRule: pulumi.Output<ProjectAlertRuleWorkloadRule | undefined>;

The project alert rule workload rule. ConflictsWith: "metricRule", "podRule"` (list Maxitems:1)

Resource ProjectLogging

class ProjectLogging extends CustomResource

Provides a Rancher v2 Project Logging resource. This can be used to create Project Logging for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Project Logging
const foo = new rancher2.ProjectLogging("foo", {
    kind: "syslog",
    projectId: "<project_id>",
    syslogConfig: {
        endpoint: "<syslog_endpoint>",
        protocol: "udp",
        severity: "notice",
        sslVerify: false,
    },
});

constructor

new ProjectLogging(name: string, args: ProjectLoggingArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectLogging resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectLoggingState, opts?: pulumi.CustomResourceOptions): ProjectLogging

Get an existing ProjectLogging resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectLogging

Returns true if the given object is an instance of ProjectLogging. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Project Logging object (map)

property customTargetConfig

public customTargetConfig: pulumi.Output<ProjectLoggingCustomTargetConfig | undefined>;

The custom target config for Cluster Logging. For kind = custom. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property elasticsearchConfig

public elasticsearchConfig: pulumi.Output<ProjectLoggingElasticsearchConfig | undefined>;

The elasticsearch config for Project Logging. For kind = elasticsearch. Conflicts with customTargetConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property enableJsonParsing

public enableJsonParsing: pulumi.Output<boolean | undefined>;

Enable json log parsing. Default: false (bool)

property fluentdConfig

public fluentdConfig: pulumi.Output<ProjectLoggingFluentdConfig | undefined>;

The fluentd config for Project Logging. For kind = fluentd. Conflicts with customTargetConfig, elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kafkaConfig

public kafkaConfig: pulumi.Output<ProjectLoggingKafkaConfig | undefined>;

The kafka config for Project Logging. For kind = kafka. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

public kind: pulumi.Output<string>;

The kind of the Project Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Project Logging object (map)

property name

public name: pulumi.Output<string>;

The name of the Project Logging config (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id from Project logging (string)

property outputFlushInterval

public outputFlushInterval: pulumi.Output<number | undefined>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

public outputTags: pulumi.Output<{[key: string]: any}>;

The output tags for Project Logging (map)

property projectId

public projectId: pulumi.Output<string>;

The project id to configure logging (string)

property splunkConfig

public splunkConfig: pulumi.Output<ProjectLoggingSplunkConfig | undefined>;

The splunk config for Project Logging. For kind = splunk. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

public syslogConfig: pulumi.Output<ProjectLoggingSyslogConfig | undefined>;

The syslog config for Project Logging. For kind = syslog. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectRoleTemplateBinding

class ProjectRoleTemplateBinding extends CustomResource

Provides a Rancher v2 Project Role Template Binding resource. This can be used to create Project Role Template Bindings for Rancher v2 environments and retrieve their information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Project Role Template Binding
const foo = new rancher2.ProjectRoleTemplateBinding("foo", {
    projectId: "<project_id>",
    roleTemplateId: "<role_template_id>",
    userId: "<user_id>",
});

constructor

new ProjectRoleTemplateBinding(name: string, args: ProjectRoleTemplateBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectRoleTemplateBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectRoleTemplateBindingState, opts?: pulumi.CustomResourceOptions): ProjectRoleTemplateBinding

Get an existing ProjectRoleTemplateBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectRoleTemplateBinding

Returns true if the given object is an instance of ProjectRoleTemplateBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property groupId

public groupId: pulumi.Output<string | undefined>;

The group ID to assign project role template binding (string)

property groupPrincipalId

public groupPrincipalId: pulumi.Output<string>;

The groupPrincipal ID to assign project role template binding (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

The name of the project role template binding (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where bind project role template (string)

property roleTemplateId

public roleTemplateId: pulumi.Output<string>;

The role template id from create project role template binding (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string | undefined>;

The user ID to assign project role template binding (string)

property userPrincipalId

public userPrincipalId: pulumi.Output<string>;

The userPrincipal ID to assign project role template binding (string)

Resource Provider

class Provider extends ProviderResource

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.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Registry

class Registry extends CustomResource

constructor

new Registry(name: string, args: RegistryArgs, opts?: pulumi.CustomResourceOptions)

Create a Registry resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RegistryState, opts?: pulumi.CustomResourceOptions): Registry

Get an existing Registry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Registry

Returns true if the given object is an instance of Registry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Registry object (map)

property description

public description: pulumi.Output<string | undefined>;

A registry description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Registry object (map)

property name

public name: pulumi.Output<string>;

The name of the registry (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id where to assign the namespaced registry (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where to assign the registry (string)

property registries

public registries: pulumi.Output<RegistryRegistry[]>;

Registries data for registry (list)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RoleTempalte

class RoleTempalte extends CustomResource

constructor

new RoleTempalte(name: string, args?: RoleTempalteArgs, opts?: pulumi.CustomResourceOptions)

Create a RoleTempalte resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RoleTempalteState, opts?: pulumi.CustomResourceOptions): RoleTempalte

Get an existing RoleTempalte resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RoleTempalte

Returns true if the given object is an instance of RoleTempalte. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property administrative

public administrative: pulumi.Output<boolean | undefined>;

Administrative role template. Default false (bool)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for role template object (map)

property builtin

public builtin: pulumi.Output<boolean>;

(Computed) Builtin role template (string)

property context

public context: pulumi.Output<string | undefined>;

Role template context. cluster and project values are supported. Default: cluster (string)

property defaultRole

public defaultRole: pulumi.Output<boolean | undefined>;

Default role template for new created cluster or project. Default false (bool)

property description

public description: pulumi.Output<string>;

Role template description (string)

property external

public external: pulumi.Output<boolean | undefined>;

External role template. Default false (bool)

property hidden

public hidden: pulumi.Output<boolean | undefined>;

Hidden role template. Default false (bool)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for role template object (map)

property locked

public locked: pulumi.Output<boolean | undefined>;

Locked role template. Default false (bool)

property name

public name: pulumi.Output<string>;

Role template name (string)

property roleTemplateIds

public roleTemplateIds: pulumi.Output<string[]>;

Inherit role template IDs (list)

property rules

public rules: pulumi.Output<RoleTempalteRule[]>;

Role template policy rules (list)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Secret

class Secret extends CustomResource

Provides a Rancher v2 Secret resource. This can be used to create secrets for Rancher v2 environments and retrieve their information.

Depending of the availability, there are 2 types of Rancher v2 secrets: - Project secret: Available to all namespaces in the projectId - Namespaced secret: Available to just namespaceId in the projectId

constructor

new Secret(name: string, args: SecretArgs, opts?: pulumi.CustomResourceOptions)

Create a Secret resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecretState, opts?: pulumi.CustomResourceOptions): Secret

Get an existing Secret resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Secret

Returns true if the given object is an instance of Secret. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for secret object (map)

property data

public data: pulumi.Output<{[key: string]: any}>;

Secret key/value data. Base64 encoding required for values (map)

property description

public description: pulumi.Output<string | undefined>;

A secret description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for secret object (map)

property name

public name: pulumi.Output<string>;

The name of the secret (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id where to assign the namespaced secret (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where to assign the secret (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Setting

class Setting extends CustomResource

Provides a Rancher v2 Setting resource. This can be used to create settings for Rancher v2 environments and retrieve their information.

On create, if setting already exists, provider will import it and update its value.

On destroy, if setting is a system setting like server-url, provider’ll not delete it from Rancher, it’ll just update setting value to default and remove it from tfstate.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Setting
const foo = new rancher2.Setting("foo", {
    value: "<VALUE>",
});

constructor

new Setting(name: string, args: SettingArgs, opts?: pulumi.CustomResourceOptions)

Create a Setting resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SettingState, opts?: pulumi.CustomResourceOptions): Setting

Get an existing Setting resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Setting

Returns true if the given object is an instance of Setting. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for setting object (map)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for setting object (map)

property name

public name: pulumi.Output<string>;

The name of the setting (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of the setting (string)

Resource Token

class Token extends CustomResource

Provides a Rancher v2 Token resource. This can be used to create Tokens for Rancher v2 provider user and retrieve their information.

There are 2 kind of tokens: - no scoped: valid for global system. - scoped: valid for just a specific cluster (clusterId should be provided).

Tokens can’t be updated once created. Any diff in token data will recreate the token. If any token expire, Rancher2 provider will generate a diff to regenerate it.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Token scoped
const foo = new rancher2.Token("foo", {
    clusterId: "<cluster-id>",
    description: "foo token",
    ttl: 1200,
});

constructor

new Token(name: string, args?: TokenArgs, opts?: pulumi.CustomResourceOptions)

Create a Token resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TokenState, opts?: pulumi.CustomResourceOptions): Token

Get an existing Token resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Token

Returns true if the given object is an instance of Token. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessKey

public accessKey: pulumi.Output<string>;

(Computed) Token access key part (string)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the token (map)

property clusterId

public clusterId: pulumi.Output<string | undefined>;

Cluster ID for scoped token (string)

property description

public description: pulumi.Output<string | undefined>;

Token description (string)

property enabled

public enabled: pulumi.Output<boolean>;

(Computed) Token is enabled (bool)

property expired

public expired: pulumi.Output<boolean>;

(Computed) Token is expired (bool)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the token (map)

property name

public name: pulumi.Output<string>;

(Computed) Token name (string)

property renew

public renew: pulumi.Output<boolean | undefined>;

Renew expired or disabled token

property secretKey

public secretKey: pulumi.Output<string>;

(Computed/Sensitive) Token secret key part (string)

property token

public token: pulumi.Output<string>;

(Computed/Sensitive) Token value (string)

property ttl

public ttl: pulumi.Output<number | undefined>;

Token time to live in seconds. Default 0 (int)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

(Computed) Token user ID (string)

Resource User

class User extends CustomResource

Provides a Rancher v2 User resource. This can be used to create Users for Rancher v2 environments and retrieve their information.

When a Rancher User is created, it doesn’t have a global role binding. At least, user-base global role binding in needed in order to enable user login.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 User
const fooUser = new rancher2.User("foo", {
    enabled: true,
    password: "changeme",
    username: "foo",
});
// Create a new rancher2 globalRoleBinding for User
const fooGlobalRoleBinding = new rancher2.GlobalRoleBinding("foo", {
    globalRoleId: "user-base",
    userId: fooUser.id,
});

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for global role binding (map)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for global role binding (map)

property name

public name: pulumi.Output<string>;

The user full name (string)

property password

public password: pulumi.Output<string>;

The user password (string)

property principalIds

public principalIds: pulumi.Output<string[]>;

(Computed) The user principal IDs (list)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

The user username (string)

Functions

Function getApp

getApp(args: GetAppArgs, opts?: pulumi.InvokeOptions): Promise<GetAppResult>

Use this data source to retrieve information about a Rancher v2 app.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const rancher2App = pulumi.output(rancher2.getApp({
    name: "foo",
    projectId: "<project_id>",
    targetNamespace: "<namespace_name>",
}, { async: true }));

Function getCatalog

getCatalog(args: GetCatalogArgs, opts?: pulumi.InvokeOptions): Promise<GetCatalogResult>

Use this data source to retrieve information about a Rancher v2 catalog.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const library = pulumi.output(rancher2.getCatalog({
    name: "catalog",
}, { async: true }));

Function getCertificate

getCertificate(args: GetCertificateArgs, opts?: pulumi.InvokeOptions): Promise<GetCertificateResult>

Use this data source to retrieve information about a Rancher v2 certificate.

Depending of the availability, there are 2 types of Rancher v2 certificates: - Project certificate: Available to all namespaces in the projectId - Namespaced certificate: Available to just namespaceId in the projectId

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Retrieve a rancher2 Project Certificate
const foo = pulumi.output(rancher2.getCertificate({
    name: "<name>",
    projectId: "<project_id>",
}, { async: true }));

Function getCloudCredential

getCloudCredential(args: GetCloudCredentialArgs, opts?: pulumi.InvokeOptions): Promise<GetCloudCredentialResult>

Use this data source to retrieve information about a Rancher v2 Cloud Credential.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const test = pulumi.output(rancher2.getCloudCredential({
    name: "test",
}, { async: true }));

Function getCluster

getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>

Use this data source to retrieve information about a Rancher v2 cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const fooCustom = pulumi.output(rancher2.getCluster({
    name: "foo-custom",
}, { async: true }));

Function getClusterAlertGroup

getClusterAlertGroup(args: GetClusterAlertGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterAlertGroupResult>

Use this data source to retrieve information about a Rancher v2 cluster alert group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getClusterAlertGroup({
    clusterId: "<cluster_id>",
    name: "<cluster_alert_group_name>",
}, { async: true }));

Function getClusterAlterRule

getClusterAlterRule(args: GetClusterAlterRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterAlterRuleResult>

Use this data source to retrieve information about a Rancher v2 cluster alert rule.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getClusterAlterRule({
    clusterId: "<cluster_id>",
    name: "<cluster_alert_rule_name>",
}, { async: true }));

Function getClusterDriver

getClusterDriver(args: GetClusterDriverArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterDriverResult>

Use this data source to retrieve information about a Rancher v2 Cluster Driver resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getClusterDriver({
    name: "foo",
}, { async: true }));

Function getClusterLogging

getClusterLogging(args: GetClusterLoggingArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterLoggingResult>

Use this data source to retrieve information about a Rancher v2 Cluster Logging.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getClusterLogging({
    clusterId: "<cluster_id>",
}, { async: true }));

Function getClusterRoleTemplateBinding

getClusterRoleTemplateBinding(args: GetClusterRoleTemplateBindingArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterRoleTemplateBindingResult>

Use this data source to retrieve information about a Rancher v2 cluster role template binding.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getClusterRoleTemplateBinding({
    clusterId: "fooId",
    name: "foo",
}, { async: true }));

Function getClusterScan

getClusterScan(args: GetClusterScanArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterScanResult>

Function getClusterTemplate

getClusterTemplate(args: GetClusterTemplateArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterTemplateResult>

Use this data source to retrieve information about a Rancher v2 cluster template.

Cluster Templates are available from Rancher v2.3.x and above.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getClusterTemplate({
    name: "foo",
}, { async: true }));

Function getEtcdBackup

getEtcdBackup(args: GetEtcdBackupArgs, opts?: pulumi.InvokeOptions): Promise<GetEtcdBackupResult>

Use this data source to retrieve information about a Rancher v2 etcd backup.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getEtcdBackup({
    clusterId: "<CLUSTER_ID>",
    name: "foo",
}, { async: true }));

Function getGlobalRoleBinding

getGlobalRoleBinding(args: GetGlobalRoleBindingArgs, opts?: pulumi.InvokeOptions): Promise<GetGlobalRoleBindingResult>

Use this data source to retrieve information about a Rancher v2 global role binding.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getGlobalRoleBinding({
    globalRoleId: "fooId",
    name: "foo",
}, { async: true }));

Function getMultiClusterApp

getMultiClusterApp(args: GetMultiClusterAppArgs, opts?: pulumi.InvokeOptions): Promise<GetMultiClusterAppResult>

Use this data source to retrieve information about a Rancher v2 multi cluster app.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getMultiClusterApp({
    name: "foo",
}, { async: true }));

Function getNamespace

getNamespace(args: GetNamespaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNamespaceResult>

Use this data source to retrieve information about a Rancher v2 namespace.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = rancher2_cluster_foo_custom.defaultProjectId.apply(defaultProjectId => rancher2.getNamespace({
    name: "foo",
    projectId: defaultProjectId,
}, { async: true }));

Function getNodeDriver

getNodeDriver(args: GetNodeDriverArgs, opts?: pulumi.InvokeOptions): Promise<GetNodeDriverResult>

Use this data source to retrieve information about a Rancher v2 Node Driver resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getNodeDriver({
    name: "foo",
}, { async: true }));

Function getNodePool

getNodePool(args: GetNodePoolArgs, opts?: pulumi.InvokeOptions): Promise<GetNodePoolResult>

Use this data source to retrieve information about a Rancher v2 Node Pool resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = rancher2_cluster_foo_custom.id.apply(id => rancher2.getNodePool({
    clusterId: id,
    name: "foo",
}, { async: true }));

Function getNodeTemplate

getNodeTemplate(args: GetNodeTemplateArgs, opts?: pulumi.InvokeOptions): Promise<GetNodeTemplateResult>

Use this data source to retrieve information about a Rancher v2 Node Template resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getNodeTemplate({
    name: "foo",
}, { async: true }));

Function getNotifier

getNotifier(args: GetNotifierArgs, opts?: pulumi.InvokeOptions): Promise<GetNotifierResult>

Use this data source to retrieve information about a Rancher v2 notifier.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getNotifier({
    clusterId: "<cluster_id>",
    name: "foo",
}, { async: true }));

Function getPodSecurityPolicyTemplate

getPodSecurityPolicyTemplate(args: GetPodSecurityPolicyTemplateArgs, opts?: pulumi.InvokeOptions): Promise<GetPodSecurityPolicyTemplateResult>

Use this data source to retrieve information about a Rancher v2 PodSecurityPolicyTemplate.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getPodSecurityPolicyTemplate({
    name: "foo",
}, { async: true }));

Function getProject

getProject(args: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult>

Function getProjectAlertGroup

getProjectAlertGroup(args: GetProjectAlertGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectAlertGroupResult>

Use this data source to retrieve information about a Rancher v2 project alert group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getProjectAlertGroup({
    name: "<project_alert_group_name>",
    projectId: "<project_id>",
}, { async: true }));

Function getProjectAlertRule

getProjectAlertRule(args: GetProjectAlertRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectAlertRuleResult>

Use this data source to retrieve information about a Rancher v2 project alert rule.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getProjectAlertRule({
    name: "<project_alert_rule_name>",
    projectId: "<project_id>",
}, { async: true }));

Function getProjectLogging

getProjectLogging(args: GetProjectLoggingArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectLoggingResult>

Use this data source to retrieve information about a Rancher v2 Project Logging.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getProjectLogging({
    projectId: "<project_id>",
}, { async: true }));

Function getProjectRoleTemplateBinding

getProjectRoleTemplateBinding(args: GetProjectRoleTemplateBindingArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectRoleTemplateBindingResult>

Use this data source to retrieve information about a Rancher v2 project role template binding.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getProjectRoleTemplateBinding({
    name: "foo",
    projectId: "fooId",
}, { async: true }));

Function getRegistry

getRegistry(args: GetRegistryArgs, opts?: pulumi.InvokeOptions): Promise<GetRegistryResult>

Use this data source to retrieve information about a Rancher v2 docker registry.

Depending of the availability, there are 2 types of Rancher v2 docker registries: - Project registry: Available to all namespaces in the projectId - Namespaced registry: Available to just namespaceId in the projectId

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Retrieve a rancher2 Project Registry
const foo = pulumi.output(rancher2.getRegistry({
    name: "<name>",
    projectId: "<project_id>",
}, { async: true }));

Function getRoleTempalte

DEPRECATED rancher2.getRoleTempalte has been deprecated in favor of rancher2.getRoleTemplate

getRoleTempalte(args: GetRoleTempalteArgs, opts?: pulumi.InvokeOptions): Promise<GetRoleTempalteResult>

Function getRoleTemplate

getRoleTemplate(args: GetRoleTemplateArgs, opts?: pulumi.InvokeOptions): Promise<GetRoleTemplateResult>

Use this data source to retrieve information about a Rancher v2 role template resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getRoleTemplate({
    name: "foo",
}, { async: true }));

Function getSecret

getSecret(args: GetSecretArgs, opts?: pulumi.InvokeOptions): Promise<GetSecretResult>

Use this data source to retrieve information about a Rancher v2 secret.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Retrieve a rancher2 Project Secret
const foo = pulumi.output(rancher2.getSecret({
    name: "<name>",
    projectId: "<project_id>",
}, { async: true }));

Function getSetting

getSetting(args: GetSettingArgs, opts?: pulumi.InvokeOptions): Promise<GetSettingResult>

Use this data source to retrieve information about a Rancher v2 setting.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const serverImage = pulumi.output(rancher2.getSetting({
    name: "server-image",
}, { async: true }));

Function getUser

getUser(args?: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>

Use this data source to retrieve information about a Rancher v2 user

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getUser({
    username: "foo",
}, { async: true }));

Others

interface ActiveDirectoryArgs

interface ActiveDirectoryArgs

The set of arguments for constructing a ActiveDirectory resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

CA certificate for TLS if selfsigned (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

ActiveDirectory connection timeout. Default 5000 (int)

property defaultLoginDomain

defaultLoginDomain?: pulumi.Input<string>;

ActiveDirectory defult lgoin domain (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default distinguishedName (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default distinguishedName (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default name (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default group (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default sAMAccountName (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property groupSearchFilter

groupSearchFilter?: pulumi.Input<string>;

Group search filter (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

ActiveDirectory port. Default 389 (int)

property servers

servers: pulumi.Input<pulumi.Input<string>[]>;

ActiveDirectory servers list (list)

property serviceAccountPassword

serviceAccountPassword: pulumi.Input<string>;

Service account password for access ActiveDirectory service (string)

property serviceAccountUsername

serviceAccountUsername: pulumi.Input<string>;

Service account DN for access ActiveDirectory service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask. Default 2 (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default sAMAccountName (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default name (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default person (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default sAMAccountName|sn|givenName (string)

property userSearchBase

userSearchBase: pulumi.Input<string>;

User search base DN (string)

property userSearchFilter

userSearchFilter?: pulumi.Input<string>;

User search filter (string)

interface ActiveDirectoryState

interface ActiveDirectoryState

Input properties used for looking up and filtering ActiveDirectory resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

CA certificate for TLS if selfsigned (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

ActiveDirectory connection timeout. Default 5000 (int)

property defaultLoginDomain

defaultLoginDomain?: pulumi.Input<string>;

ActiveDirectory defult lgoin domain (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default distinguishedName (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default distinguishedName (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default name (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default group (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default sAMAccountName (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property groupSearchFilter

groupSearchFilter?: pulumi.Input<string>;

Group search filter (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

ActiveDirectory port. Default 389 (int)

property servers

servers?: pulumi.Input<pulumi.Input<string>[]>;

ActiveDirectory servers list (list)

property serviceAccountPassword

serviceAccountPassword?: pulumi.Input<string>;

Service account password for access ActiveDirectory service (string)

property serviceAccountUsername

serviceAccountUsername?: pulumi.Input<string>;

Service account DN for access ActiveDirectory service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask. Default 2 (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default sAMAccountName (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default name (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default person (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default sAMAccountName|sn|givenName (string)

property userSearchBase

userSearchBase?: pulumi.Input<string>;

User search base DN (string)

property userSearchFilter

userSearchFilter?: pulumi.Input<string>;

User search filter (string)

interface AppArgs

interface AppArgs

The set of arguments for constructing a App resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for App object (map)

property answers

answers?: pulumi.Input<{[key: string]: any}>;

Answers for the app template. If modified, app will be upgraded (map)

property catalogName

catalogName: pulumi.Input<string>;

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs: * add cluster ID before name, c-XXXXX:<name> * add project ID before name, p-XXXXX:<name>

property description

description?: pulumi.Input<string>;

Description for the app (string)

property forceUpgrade

forceUpgrade?: pulumi.Input<boolean>;

Force app upgrade (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for App object (map)

property name

name?: pulumi.Input<string>;

The name of the app (string)

property projectId

projectId: pulumi.Input<string>;

The project id where the app will be installed (string)

property revisionId

revisionId?: pulumi.Input<string>;

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revisionId (string)

property targetNamespace

targetNamespace: pulumi.Input<string>;

The namespace name where the app will be installed (string)

property templateName

templateName: pulumi.Input<string>;

Template name of the app. If modified, app will be upgraded (string)

property templateVersion

templateVersion?: pulumi.Input<string>;

Template version of the app. If modified, app will be upgraded. Default: latest (string)

property valuesYaml

valuesYaml?: pulumi.Input<string>;

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

interface AppState

interface AppState

Input properties used for looking up and filtering App resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for App object (map)

property answers

answers?: pulumi.Input<{[key: string]: any}>;

Answers for the app template. If modified, app will be upgraded (map)

property catalogName

catalogName?: pulumi.Input<string>;

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs: * add cluster ID before name, c-XXXXX:<name> * add project ID before name, p-XXXXX:<name>

property description

description?: pulumi.Input<string>;

Description for the app (string)

property externalId

externalId?: pulumi.Input<string>;

(Computed) The url of the app template on a catalog (string)

property forceUpgrade

forceUpgrade?: pulumi.Input<boolean>;

Force app upgrade (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for App object (map)

property name

name?: pulumi.Input<string>;

The name of the app (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where the app will be installed (string)

property revisionId

revisionId?: pulumi.Input<string>;

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revisionId (string)

property targetNamespace

targetNamespace?: pulumi.Input<string>;

The namespace name where the app will be installed (string)

property templateName

templateName?: pulumi.Input<string>;

Template name of the app. If modified, app will be upgraded (string)

property templateVersion

templateVersion?: pulumi.Input<string>;

Template version of the app. If modified, app will be upgraded. Default: latest (string)

property valuesYaml

valuesYaml?: pulumi.Input<string>;

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

interface AuthConfigAdfsArgs

interface AuthConfigAdfsArgs

The set of arguments for constructing a AuthConfigAdfs resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

ADFS display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

ADFS group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

ADFS IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

ADFS SP cert (string)

property spKey

spKey: pulumi.Input<string>;

ADFS SP key (string)

property uidField

uidField: pulumi.Input<string>;

ADFS UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

ADFS user name field (string)

interface AuthConfigAdfsState

interface AuthConfigAdfsState

Input properties used for looking up and filtering AuthConfigAdfs resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

ADFS display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

ADFS group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

ADFS IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

ADFS SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

ADFS SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

ADFS UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

ADFS user name field (string)

interface AuthConfigAzureAdArgs

interface AuthConfigAzureAdArgs

The set of arguments for constructing a AuthConfigAzureAd resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property applicationId

applicationId: pulumi.Input<string>;

AzureAD auth application ID (string)

property applicationSecret

applicationSecret: pulumi.Input<string>;

AzureAD auth application secret (string)

property authEndpoint

authEndpoint: pulumi.Input<string>;

AzureAD auth endpoint (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property endpoint

endpoint?: pulumi.Input<string>;

AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

property graphEndpoint

graphEndpoint: pulumi.Input<string>;

AzureAD graph endpoint (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherUrl

rancherUrl: pulumi.Input<string>;

Rancher URL (string). “/verify-auth-azure”

property tenantId

tenantId: pulumi.Input<string>;

AzureAD tenant ID (string)

property tokenEndpoint

tokenEndpoint: pulumi.Input<string>;

AzureAD token endpoint (string)

interface AuthConfigAzureAdState

interface AuthConfigAzureAdState

Input properties used for looking up and filtering AuthConfigAzureAd resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property applicationId

applicationId?: pulumi.Input<string>;

AzureAD auth application ID (string)

property applicationSecret

applicationSecret?: pulumi.Input<string>;

AzureAD auth application secret (string)

property authEndpoint

authEndpoint?: pulumi.Input<string>;

AzureAD auth endpoint (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property endpoint

endpoint?: pulumi.Input<string>;

AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

property graphEndpoint

graphEndpoint?: pulumi.Input<string>;

AzureAD graph endpoint (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherUrl

rancherUrl?: pulumi.Input<string>;

Rancher URL (string). “/verify-auth-azure”

property tenantId

tenantId?: pulumi.Input<string>;

AzureAD tenant ID (string)

property tokenEndpoint

tokenEndpoint?: pulumi.Input<string>;

AzureAD token endpoint (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

interface AuthConfigFreeIpaArgs

interface AuthConfigFreeIpaArgs

The set of arguments for constructing a AuthConfigFreeIpa resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: freeipa_user://<DN> freeipa_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

FreeIpa connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

FreeIpa port. Default 389 (int)

property servers

servers: pulumi.Input<pulumi.Input<string>[]>;

FreeIpa servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName: pulumi.Input<string>;

Service account DN for access FreeIpa service (string)

property serviceAccountPassword

serviceAccountPassword: pulumi.Input<string>;

Service account password for access FreeIpa service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigFreeIpaState

interface AuthConfigFreeIpaState

Input properties used for looking up and filtering AuthConfigFreeIpa resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: freeipa_user://<DN> freeipa_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

FreeIpa connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

FreeIpa port. Default 389 (int)

property servers

servers?: pulumi.Input<pulumi.Input<string>[]>;

FreeIpa servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName?: pulumi.Input<string>;

Service account DN for access FreeIpa service (string)

property serviceAccountPassword

serviceAccountPassword?: pulumi.Input<string>;

Service account password for access FreeIpa service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase?: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigGithubArgs

interface AuthConfigGithubArgs

The set of arguments for constructing a AuthConfigGithub resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property clientId

clientId: pulumi.Input<string>;

Github auth Client ID (string)

property clientSecret

clientSecret: pulumi.Input<string>;

Github auth Client secret (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property hostname

hostname?: pulumi.Input<string>;

Github hostname to connect. Default github.com (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection. Default true (bool)

interface AuthConfigGithubState

interface AuthConfigGithubState

Input properties used for looking up and filtering AuthConfigGithub resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property clientId

clientId?: pulumi.Input<string>;

Github auth Client ID (string)

property clientSecret

clientSecret?: pulumi.Input<string>;

Github auth Client secret (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property hostname

hostname?: pulumi.Input<string>;

Github hostname to connect. Default github.com (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection. Default true (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

interface AuthConfigKeycloakArgs

interface AuthConfigKeycloakArgs

The set of arguments for constructing a AuthConfigKeycloak resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

KeyCloak display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

KeyCloak group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

KeyCloak IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

KeyCloak SP cert (string)

property spKey

spKey: pulumi.Input<string>;

KeyCloak SP key (string)

property uidField

uidField: pulumi.Input<string>;

KeyCloak UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

KeyCloak user name field (string)

interface AuthConfigKeycloakState

interface AuthConfigKeycloakState

Input properties used for looking up and filtering AuthConfigKeycloak resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

KeyCloak display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

KeyCloak group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

KeyCloak IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

KeyCloak SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

KeyCloak SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

KeyCloak UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

KeyCloak user name field (string)

interface AuthConfigOktaArgs

interface AuthConfigOktaArgs

The set of arguments for constructing a AuthConfigOkta resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: okta_user://<USER_ID> okta_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

OKTA display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

OKTA group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

OKTA IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

OKTA SP cert (string)

property spKey

spKey: pulumi.Input<string>;

OKTA SP key (string)

property uidField

uidField: pulumi.Input<string>;

OKTA UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

OKTA user name field (string)

interface AuthConfigOktaState

interface AuthConfigOktaState

Input properties used for looking up and filtering AuthConfigOkta resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: okta_user://<USER_ID> okta_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

OKTA display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

OKTA group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

OKTA IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

OKTA SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

OKTA SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

OKTA UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

OKTA user name field (string)

interface AuthConfigOpenLdapArgs

interface AuthConfigOpenLdapArgs

The set of arguments for constructing a AuthConfigOpenLdap resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

OpenLdap connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

OpenLdap port. Default 389 (int)

property servers

servers: pulumi.Input<pulumi.Input<string>[]>;

OpenLdap servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName: pulumi.Input<string>;

Service account DN for access OpenLdap service (string)

property serviceAccountPassword

serviceAccountPassword: pulumi.Input<string>;

Service account password for access OpenLdap service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigOpenLdapState

interface AuthConfigOpenLdapState

Input properties used for looking up and filtering AuthConfigOpenLdap resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

OpenLdap connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

OpenLdap port. Default 389 (int)

property servers

servers?: pulumi.Input<pulumi.Input<string>[]>;

OpenLdap servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName?: pulumi.Input<string>;

Service account DN for access OpenLdap service (string)

property serviceAccountPassword

serviceAccountPassword?: pulumi.Input<string>;

Service account password for access OpenLdap service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase?: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigPingArgs

interface AuthConfigPingArgs

The set of arguments for constructing a AuthConfigPing resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

Ping display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

Ping group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

Ping IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

Ping SP cert (string)

property spKey

spKey: pulumi.Input<string>;

Ping SP key (string)

property uidField

uidField: pulumi.Input<string>;

Ping UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

Ping user name field (string)

interface AuthConfigPingState

interface AuthConfigPingState

Input properties used for looking up and filtering AuthConfigPing resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

Ping display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

Ping group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

Ping IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

Ping SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

Ping SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

Ping UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

Ping user name field (string)

interface BootstrapArgs

interface BootstrapArgs

The set of arguments for constructing a Bootstrap resource.

property currentPassword

currentPassword?: pulumi.Input<string>;

Current password for Admin user. Just needed for recover if admin password has been changed from other resources and token is expired (string)

property password

password?: pulumi.Input<string>;

Password for Admin user or random generated if empty (string)

property telemetry

telemetry?: pulumi.Input<boolean>;

Send telemetry anonymous data. Default: false (bool)

property tokenTtl

tokenTtl?: pulumi.Input<number>;

TTL in seconds for generated admin token. Default: 0 (int)

property tokenUpdate

tokenUpdate?: pulumi.Input<boolean>;

Regenerate admin token. Default: false (bool)

interface BootstrapState

interface BootstrapState

Input properties used for looking up and filtering Bootstrap resources.

property currentPassword

currentPassword?: pulumi.Input<string>;

Current password for Admin user. Just needed for recover if admin password has been changed from other resources and token is expired (string)

property password

password?: pulumi.Input<string>;

Password for Admin user or random generated if empty (string)

property telemetry

telemetry?: pulumi.Input<boolean>;

Send telemetry anonymous data. Default: false (bool)

property tempToken

tempToken?: pulumi.Input<string>;

(Computed) Generated API temporary token as helper. Should be empty (string)

property tempTokenId

tempTokenId?: pulumi.Input<string>;

(Computed) Generated API temporary token id as helper. Should be empty (string)

property token

token?: pulumi.Input<string>;

(Computed) Generated API token for Admin User (string)

property tokenId

tokenId?: pulumi.Input<string>;

(Computed) Generated API token id for Admin User (string)

property tokenTtl

tokenTtl?: pulumi.Input<number>;

TTL in seconds for generated admin token. Default: 0 (int)

property tokenUpdate

tokenUpdate?: pulumi.Input<boolean>;

Regenerate admin token. Default: false (bool)

property url

url?: pulumi.Input<string>;

(Computed) URL set as server-url (string)

property user

user?: pulumi.Input<string>;

(Computed) Admin username (string)

interface CatalogArgs

interface CatalogArgs

The set of arguments for constructing a Catalog resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for the catalog (map)

property branch

branch?: pulumi.Input<string>;

The branch of the catalog repo to use. Default master (string)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id of the catalog. Mandatory if scope = cluster (string)

property description

description?: pulumi.Input<string>;

A catalog description (string)

property kind

kind?: pulumi.Input<string>;

The kind of the catalog. Just helm by the moment (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for the catalog (map)

property name

name?: pulumi.Input<string>;

The name of the catalog (string)

property password

password?: pulumi.Input<string>;

The password to access the catalog if needed (string)

property projectId

projectId?: pulumi.Input<string>;

The project id of the catalog. Mandatory if scope = project (string)

property refresh

refresh?: pulumi.Input<boolean>;

Catalog will wait for refresh after tf creation and on every tf read. Default false (bool)

property scope

scope?: pulumi.Input<string>;

The scope of the catalog. cluster, global, and project are supported. Default global (string)

property url

url: pulumi.Input<string>;

The url of the catalog repo (string)

property username

username?: pulumi.Input<string>;

The username to access the catalog if needed (string)

property version

version?: pulumi.Input<string>;

Helm version for the catalog. Available options: helmV2 and helmV3 (string)

interface CatalogState

interface CatalogState

Input properties used for looking up and filtering Catalog resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for the catalog (map)

property branch

branch?: pulumi.Input<string>;

The branch of the catalog repo to use. Default master (string)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id of the catalog. Mandatory if scope = cluster (string)

property description

description?: pulumi.Input<string>;

A catalog description (string)

property kind

kind?: pulumi.Input<string>;

The kind of the catalog. Just helm by the moment (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for the catalog (map)

property name

name?: pulumi.Input<string>;

The name of the catalog (string)

property password

password?: pulumi.Input<string>;

The password to access the catalog if needed (string)

property projectId

projectId?: pulumi.Input<string>;

The project id of the catalog. Mandatory if scope = project (string)

property refresh

refresh?: pulumi.Input<boolean>;

Catalog will wait for refresh after tf creation and on every tf read. Default false (bool)

property scope

scope?: pulumi.Input<string>;

The scope of the catalog. cluster, global, and project are supported. Default global (string)

property url

url?: pulumi.Input<string>;

The url of the catalog repo (string)

property username

username?: pulumi.Input<string>;

The username to access the catalog if needed (string)

property version

version?: pulumi.Input<string>;

Helm version for the catalog. Available options: helmV2 and helmV3 (string)

interface CertificateArgs

interface CertificateArgs

The set of arguments for constructing a Certificate resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for certificate object (map)

property certs

certs: pulumi.Input<string>;

Base64 encoded public certs (string)

property description

description?: pulumi.Input<string>;

A certificate description (string)

property key

key: pulumi.Input<string>;

Base64 encoded private key (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for certificate object (map)

property name

name?: pulumi.Input<string>;

The name of the certificate (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id where the namespaced certificate should be created (string)

property projectId

projectId: pulumi.Input<string>;

The project id where the certificate should be created (string)

interface CertificateState

interface CertificateState

Input properties used for looking up and filtering Certificate resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for certificate object (map)

property certs

certs?: pulumi.Input<string>;

Base64 encoded public certs (string)

property description

description?: pulumi.Input<string>;

A certificate description (string)

property key

key?: pulumi.Input<string>;

Base64 encoded private key (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for certificate object (map)

property name

name?: pulumi.Input<string>;

The name of the certificate (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id where the namespaced certificate should be created (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where the certificate should be created (string)

interface CloudCredentialArgs

interface CloudCredentialArgs

The set of arguments for constructing a CloudCredential resource.

property amazonec2CredentialConfig

amazonec2CredentialConfig?: pulumi.Input<CloudCredentialAmazonec2CredentialConfig>;

AWS config for the Cloud Credential (list maxitems:1)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Cloud Credential object (map)

property azureCredentialConfig

azureCredentialConfig?: pulumi.Input<CloudCredentialAzureCredentialConfig>;

Azure config for the Cloud Credential (list maxitems:1)

property description

description?: pulumi.Input<string>;

Description for the Cloud Credential (string)

property digitaloceanCredentialConfig

digitaloceanCredentialConfig?: pulumi.Input<CloudCredentialDigitaloceanCredentialConfig>;

DigitalOcean config for the Cloud Credential (list maxitems:1)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Cloud Credential object (map)

property linodeCredentialConfig

linodeCredentialConfig?: pulumi.Input<CloudCredentialLinodeCredentialConfig>;

Linode config for the Cloud Credential (list maxitems:1)

property name

name?: pulumi.Input<string>;

The name of the Cloud Credential (string)

property openstackCredentialConfig

openstackCredentialConfig?: pulumi.Input<CloudCredentialOpenstackCredentialConfig>;

OpenStack config for the Cloud Credential (list maxitems:1)

property vsphereCredentialConfig

vsphereCredentialConfig?: pulumi.Input<CloudCredentialVsphereCredentialConfig>;

vSphere config for the Cloud Credential (list maxitems:1)

interface CloudCredentialState

interface CloudCredentialState

Input properties used for looking up and filtering CloudCredential resources.

property amazonec2CredentialConfig

amazonec2CredentialConfig?: pulumi.Input<CloudCredentialAmazonec2CredentialConfig>;

AWS config for the Cloud Credential (list maxitems:1)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Cloud Credential object (map)

property azureCredentialConfig

azureCredentialConfig?: pulumi.Input<CloudCredentialAzureCredentialConfig>;

Azure config for the Cloud Credential (list maxitems:1)

property description

description?: pulumi.Input<string>;

Description for the Cloud Credential (string)

property digitaloceanCredentialConfig

digitaloceanCredentialConfig?: pulumi.Input<CloudCredentialDigitaloceanCredentialConfig>;

DigitalOcean config for the Cloud Credential (list maxitems:1)

property driver

driver?: pulumi.Input<string>;

(Computed) The driver of the Cloud Credential (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Cloud Credential object (map)

property linodeCredentialConfig

linodeCredentialConfig?: pulumi.Input<CloudCredentialLinodeCredentialConfig>;

Linode config for the Cloud Credential (list maxitems:1)

property name

name?: pulumi.Input<string>;

The name of the Cloud Credential (string)

property openstackCredentialConfig

openstackCredentialConfig?: pulumi.Input<CloudCredentialOpenstackCredentialConfig>;

OpenStack config for the Cloud Credential (list maxitems:1)

property vsphereCredentialConfig

vsphereCredentialConfig?: pulumi.Input<CloudCredentialVsphereCredentialConfig>;

vSphere config for the Cloud Credential (list maxitems:1)

interface ClusterAlterGroupArgs

interface ClusterAlterGroupArgs

The set of arguments for constructing a ClusterAlterGroup resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The cluster alert group annotations (map)

property clusterId

clusterId: pulumi.Input<string>;

The cluster id where create cluster alert group (string)

property description

description?: pulumi.Input<string>;

The cluster alert group description (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The cluster alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The cluster alert group wait seconds. Default: 180 (int)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The cluster alert group labels (map)

property name

name?: pulumi.Input<string>;

The cluster alert group name (string)

property recipients

recipients?: pulumi.Input<pulumi.Input<ClusterAlterGroupRecipient>[]>;

The cluster alert group recipients (list)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The cluster alert group wait seconds. Default: 3600 (int)

interface ClusterAlterGroupState

interface ClusterAlterGroupState

Input properties used for looking up and filtering ClusterAlterGroup resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The cluster alert group annotations (map)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id where create cluster alert group (string)

property description

description?: pulumi.Input<string>;

The cluster alert group description (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The cluster alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The cluster alert group wait seconds. Default: 180 (int)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The cluster alert group labels (map)

property name

name?: pulumi.Input<string>;

The cluster alert group name (string)

property recipients

recipients?: pulumi.Input<pulumi.Input<ClusterAlterGroupRecipient>[]>;

The cluster alert group recipients (list)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The cluster alert group wait seconds. Default: 3600 (int)

interface ClusterAlterRuleArgs

interface ClusterAlterRuleArgs

The set of arguments for constructing a ClusterAlterRule resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The cluster alert rule annotations (map)

property clusterId

clusterId: pulumi.Input<string>;

The cluster id where create cluster alert rule (string)

property eventRule

eventRule?: pulumi.Input<ClusterAlterRuleEventRule>;

The cluster alert rule event rule. ConflictsWith: "metricRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property groupId

groupId: pulumi.Input<string>;

The cluster alert rule alert group ID (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The cluster alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The cluster alert rule group wait seconds. Default: 180 (int)

property inherited

inherited?: pulumi.Input<boolean>;

The cluster alert rule inherited. Default: true (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The cluster alert rule labels (map)

property metricRule

metricRule?: pulumi.Input<ClusterAlterRuleMetricRule>;

The cluster alert rule metric rule. ConflictsWith: "eventRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property name

name?: pulumi.Input<string>;

The cluster alert rule name (string)

property nodeRule

nodeRule?: pulumi.Input<ClusterAlterRuleNodeRule>;

The cluster alert rule node rule. ConflictsWith: "eventRule", "metricRule", "systemServiceRule"` (list Maxitems:1)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The cluster alert rule wait seconds. Default: 3600 (int)

property severity

severity?: pulumi.Input<string>;

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property systemServiceRule

systemServiceRule?: pulumi.Input<ClusterAlterRuleSystemServiceRule>;

The cluster alert rule system service rule. ConflictsWith: "eventRule", "metricRule", "nodeRule"` (list Maxitems:1)

interface ClusterAlterRuleState

interface ClusterAlterRuleState

Input properties used for looking up and filtering ClusterAlterRule resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The cluster alert rule annotations (map)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id where create cluster alert rule (string)

property eventRule

eventRule?: pulumi.Input<ClusterAlterRuleEventRule>;

The cluster alert rule event rule. ConflictsWith: "metricRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property groupId

groupId?: pulumi.Input<string>;

The cluster alert rule alert group ID (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The cluster alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The cluster alert rule group wait seconds. Default: 180 (int)

property inherited

inherited?: pulumi.Input<boolean>;

The cluster alert rule inherited. Default: true (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The cluster alert rule labels (map)

property metricRule

metricRule?: pulumi.Input<ClusterAlterRuleMetricRule>;

The cluster alert rule metric rule. ConflictsWith: "eventRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property name

name?: pulumi.Input<string>;

The cluster alert rule name (string)

property nodeRule

nodeRule?: pulumi.Input<ClusterAlterRuleNodeRule>;

The cluster alert rule node rule. ConflictsWith: "eventRule", "metricRule", "systemServiceRule"` (list Maxitems:1)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The cluster alert rule wait seconds. Default: 3600 (int)

property severity

severity?: pulumi.Input<string>;

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property systemServiceRule

systemServiceRule?: pulumi.Input<ClusterAlterRuleSystemServiceRule>;

The cluster alert rule system service rule. ConflictsWith: "eventRule", "metricRule", "nodeRule"` (list Maxitems:1)

interface ClusterArgs

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property aksConfig

aksConfig?: pulumi.Input<ClusterAksConfig>;

The Azure AKS configuration for aks Clusters. Conflicts with eksConfig, gkeConfig, k3sConfig and rkeConfig (list maxitems:1)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for cluster registration token object (map)

property clusterAuthEndpoint

clusterAuthEndpoint?: pulumi.Input<ClusterClusterAuthEndpoint>;

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

property clusterMonitoringInput

clusterMonitoringInput?: pulumi.Input<ClusterClusterMonitoringInput>;

Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property clusterTemplateAnswers

clusterTemplateAnswers?: pulumi.Input<ClusterClusterTemplateAnswers>;

Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)

property clusterTemplateId

clusterTemplateId?: pulumi.Input<string>;

Cluster template ID. Just for Rancher v2.3.x and above (string)

property clusterTemplateQuestions

clusterTemplateQuestions?: pulumi.Input<pulumi.Input<ClusterClusterTemplateQuestion>[]>;

Cluster template questions. Just for Rancher v2.3.x and above (list)

property clusterTemplateRevisionId

clusterTemplateRevisionId?: pulumi.Input<string>;

Cluster template revision ID. Just for Rancher v2.3.x and above (string)

property defaultPodSecurityPolicyTemplateId

defaultPodSecurityPolicyTemplateId?: pulumi.Input<string>;

Default pod security policy template id (string)

property description

description?: pulumi.Input<string>;

An optional description of this cluster (string)

property desiredAgentImage

desiredAgentImage?: pulumi.Input<string>;

Desired agent image. Just for Rancher v2.3.x and above (string)

property desiredAuthImage

desiredAuthImage?: pulumi.Input<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property dockerRootDir

dockerRootDir?: pulumi.Input<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property driver

driver?: pulumi.Input<string>;

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

property eksConfig

eksConfig?: pulumi.Input<ClusterEksConfig>;

The Amazon EKS configuration for eks Clusters. Conflicts with aksConfig, gkeConfig, k3sConfig and rkeConfig (list maxitems:1)

property enableClusterAlerting

enableClusterAlerting?: pulumi.Input<boolean>;

Enable built-in cluster alerting. Default false (bool)

property enableClusterIstio

enableClusterIstio?: pulumi.Input<boolean>;

Enable built-in cluster istio. Default false. Just for Rancher v2.3.x and above (bool)

property enableClusterMonitoring

enableClusterMonitoring?: pulumi.Input<boolean>;

Enable built-in cluster monitoring. Default false (bool)

property enableNetworkPolicy

enableNetworkPolicy?: pulumi.Input<boolean>;

Enable project network isolation. Default false (bool)

property gkeConfig

gkeConfig?: pulumi.Input<ClusterGkeConfig>;

The Google GKE configuration for gke Clusters. Conflicts with aksConfig, eksConfig, k3sConfig and rkeConfig (list maxitems:1)

property k3sConfig

k3sConfig?: pulumi.Input<ClusterK3sConfig>;

The K3S configuration for k3s imported Clusters. Conflicts with aksConfig, eksConfig, gkeConfig and rkeConfig (list maxitems:1)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for cluster registration token object (map)

property name

name?: pulumi.Input<string>;

Name of cluster registration token (string)

property rkeConfig

rkeConfig?: pulumi.Input<ClusterRkeConfig>;

The RKE configuration for rke Clusters. Conflicts with aksConfig, eksConfig, gkeConfig and k3sConfig (list maxitems:1)

property scheduledClusterScan

scheduledClusterScan?: pulumi.Input<ClusterScheduledClusterScan>;

Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)

property windowsPreferedCluster

windowsPreferedCluster?: pulumi.Input<boolean>;

Windows preferred cluster. Default: false (bool)

interface ClusterDriverArgs

interface ClusterDriverArgs

The set of arguments for constructing a ClusterDriver resource.

property active

active: pulumi.Input<boolean>;

Specify the cluster driver state (bool)

property actualUrl

actualUrl?: pulumi.Input<string>;

Actual url of the cluster driver (string)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property builtin

builtin: pulumi.Input<boolean>;

Specify whether the cluster driver is an internal cluster driver or not (bool)

property checksum

checksum?: pulumi.Input<string>;

Verify that the downloaded driver matches the expected checksum (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

Name of the cluster driver (string)

property uiUrl

uiUrl?: pulumi.Input<string>;

The URL to load for customized Add Clusters screen for this driver (string)

property url

url: pulumi.Input<string>;

The URL to download the machine driver binary for 64-bit Linux (string)

property whitelistDomains

whitelistDomains?: pulumi.Input<pulumi.Input<string>[]>;

Domains to whitelist for the ui (list)

interface ClusterDriverState

interface ClusterDriverState

Input properties used for looking up and filtering ClusterDriver resources.

property active

active?: pulumi.Input<boolean>;

Specify the cluster driver state (bool)

property actualUrl

actualUrl?: pulumi.Input<string>;

Actual url of the cluster driver (string)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property builtin

builtin?: pulumi.Input<boolean>;

Specify whether the cluster driver is an internal cluster driver or not (bool)

property checksum

checksum?: pulumi.Input<string>;

Verify that the downloaded driver matches the expected checksum (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

Name of the cluster driver (string)

property uiUrl

uiUrl?: pulumi.Input<string>;

The URL to load for customized Add Clusters screen for this driver (string)

property url

url?: pulumi.Input<string>;

The URL to download the machine driver binary for 64-bit Linux (string)

property whitelistDomains

whitelistDomains?: pulumi.Input<pulumi.Input<string>[]>;

Domains to whitelist for the ui (list)

interface ClusterLoggingArgs

interface ClusterLoggingArgs

The set of arguments for constructing a ClusterLogging resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Cluster Logging object (map)

property clusterId

clusterId: pulumi.Input<string>;

The cluster id to configure logging (string)

property customTargetConfig

customTargetConfig?: pulumi.Input<ClusterLoggingCustomTargetConfig>;

The custom target config for Cluster Logging. For kind = custom. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property elasticsearchConfig

elasticsearchConfig?: pulumi.Input<ClusterLoggingElasticsearchConfig>;

The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with customTargetConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property enableJsonParsing

enableJsonParsing?: pulumi.Input<boolean>;

Enable json log parsing. Default: false (bool)

property fluentdConfig

fluentdConfig?: pulumi.Input<ClusterLoggingFluentdConfig>;

The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with customTargetConfig, elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property kafkaConfig

kafkaConfig?: pulumi.Input<ClusterLoggingKafkaConfig>;

The kafka config for Cluster Logging. For kind = kafka. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

kind: pulumi.Input<string>;

The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Cluster Logging object (map)

property name

name?: pulumi.Input<string>;

The name of the cluster logging config (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id from cluster logging (string)

property outputFlushInterval

outputFlushInterval?: pulumi.Input<number>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

outputTags?: pulumi.Input<{[key: string]: any}>;

The output tags for Cluster Logging (map)

property splunkConfig

splunkConfig?: pulumi.Input<ClusterLoggingSplunkConfig>;

The splunk config for Cluster Logging. For kind = splunk. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

syslogConfig?: pulumi.Input<ClusterLoggingSyslogConfig>;

The syslog config for Cluster Logging. For kind = syslog. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

interface ClusterLoggingState

interface ClusterLoggingState

Input properties used for looking up and filtering ClusterLogging resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Cluster Logging object (map)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id to configure logging (string)

property customTargetConfig

customTargetConfig?: pulumi.Input<ClusterLoggingCustomTargetConfig>;

The custom target config for Cluster Logging. For kind = custom. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property elasticsearchConfig

elasticsearchConfig?: pulumi.Input<ClusterLoggingElasticsearchConfig>;

The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with customTargetConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property enableJsonParsing

enableJsonParsing?: pulumi.Input<boolean>;

Enable json log parsing. Default: false (bool)

property fluentdConfig

fluentdConfig?: pulumi.Input<ClusterLoggingFluentdConfig>;

The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with customTargetConfig, elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property kafkaConfig

kafkaConfig?: pulumi.Input<ClusterLoggingKafkaConfig>;

The kafka config for Cluster Logging. For kind = kafka. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

kind?: pulumi.Input<string>;

The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Cluster Logging object (map)

property name

name?: pulumi.Input<string>;

The name of the cluster logging config (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id from cluster logging (string)

property outputFlushInterval

outputFlushInterval?: pulumi.Input<number>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

outputTags?: pulumi.Input<{[key: string]: any}>;

The output tags for Cluster Logging (map)

property splunkConfig

splunkConfig?: pulumi.Input<ClusterLoggingSplunkConfig>;

The splunk config for Cluster Logging. For kind = splunk. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

syslogConfig?: pulumi.Input<ClusterLoggingSyslogConfig>;

The syslog config for Cluster Logging. For kind = syslog. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

interface ClusterRoleTemplateBindingArgs

interface ClusterRoleTemplateBindingArgs

The set of arguments for constructing a ClusterRoleTemplateBinding resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for cluster role template binding (map)

property clusterId

clusterId: pulumi.Input<string>;

The cluster id where bind cluster role template binding (string)

property groupId

groupId?: pulumi.Input<string>;

The group ID to assign cluster role template binding (string)

property groupPrincipalId

groupPrincipalId?: pulumi.Input<string>;

The groupPrincipal ID to assign cluster role template binding (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for cluster role template binding (map)

property name

name?: pulumi.Input<string>;

The name of the cluster role template binding (string)

property roleTemplateId

roleTemplateId: pulumi.Input<string>;

The role template id from create cluster role template binding (string)

property userId

userId?: pulumi.Input<string>;

The user ID to assign cluster role template binding (string)

property userPrincipalId

userPrincipalId?: pulumi.Input<string>;

The userPrincipal ID to assign cluster role template binding (string)

interface ClusterRoleTemplateBindingState

interface ClusterRoleTemplateBindingState

Input properties used for looking up and filtering ClusterRoleTemplateBinding resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for cluster role template binding (map)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id where bind cluster role template binding (string)

property groupId

groupId?: pulumi.Input<string>;

The group ID to assign cluster role template binding (string)

property groupPrincipalId

groupPrincipalId?: pulumi.Input<string>;

The groupPrincipal ID to assign cluster role template binding (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for cluster role template binding (map)

property name

name?: pulumi.Input<string>;

The name of the cluster role template binding (string)

property roleTemplateId

roleTemplateId?: pulumi.Input<string>;

The role template id from create cluster role template binding (string)

property userId

userId?: pulumi.Input<string>;

The user ID to assign cluster role template binding (string)

property userPrincipalId

userPrincipalId?: pulumi.Input<string>;

The userPrincipal ID to assign cluster role template binding (string)

interface ClusterState

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property aksConfig

aksConfig?: pulumi.Input<ClusterAksConfig>;

The Azure AKS configuration for aks Clusters. Conflicts with eksConfig, gkeConfig, k3sConfig and rkeConfig (list maxitems:1)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for cluster registration token object (map)

property clusterAuthEndpoint

clusterAuthEndpoint?: pulumi.Input<ClusterClusterAuthEndpoint>;

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

property clusterMonitoringInput

clusterMonitoringInput?: pulumi.Input<ClusterClusterMonitoringInput>;

Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property clusterRegistrationToken

clusterRegistrationToken?: pulumi.Input<ClusterClusterRegistrationToken>;

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

property clusterTemplateAnswers

clusterTemplateAnswers?: pulumi.Input<ClusterClusterTemplateAnswers>;

Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)

property clusterTemplateId

clusterTemplateId?: pulumi.Input<string>;

Cluster template ID. Just for Rancher v2.3.x and above (string)

property clusterTemplateQuestions

clusterTemplateQuestions?: pulumi.Input<pulumi.Input<ClusterClusterTemplateQuestion>[]>;

Cluster template questions. Just for Rancher v2.3.x and above (list)

property clusterTemplateRevisionId

clusterTemplateRevisionId?: pulumi.Input<string>;

Cluster template revision ID. Just for Rancher v2.3.x and above (string)

property defaultPodSecurityPolicyTemplateId

defaultPodSecurityPolicyTemplateId?: pulumi.Input<string>;

Default pod security policy template id (string)

property defaultProjectId

defaultProjectId?: pulumi.Input<string>;

(Computed) Default project ID for the cluster (string)

property description

description?: pulumi.Input<string>;

An optional description of this cluster (string)

property desiredAgentImage

desiredAgentImage?: pulumi.Input<string>;

Desired agent image. Just for Rancher v2.3.x and above (string)

property desiredAuthImage

desiredAuthImage?: pulumi.Input<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property dockerRootDir

dockerRootDir?: pulumi.Input<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property driver

driver?: pulumi.Input<string>;

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

property eksConfig

eksConfig?: pulumi.Input<ClusterEksConfig>;

The Amazon EKS configuration for eks Clusters. Conflicts with aksConfig, gkeConfig, k3sConfig and rkeConfig (list maxitems:1)

property enableClusterAlerting

enableClusterAlerting?: pulumi.Input<boolean>;

Enable built-in cluster alerting. Default false (bool)

property enableClusterIstio

enableClusterIstio?: pulumi.Input<boolean>;

Enable built-in cluster istio. Default false. Just for Rancher v2.3.x and above (bool)

property enableClusterMonitoring

enableClusterMonitoring?: pulumi.Input<boolean>;

Enable built-in cluster monitoring. Default false (bool)

property enableNetworkPolicy

enableNetworkPolicy?: pulumi.Input<boolean>;

Enable project network isolation. Default false (bool)

property gkeConfig

gkeConfig?: pulumi.Input<ClusterGkeConfig>;

The Google GKE configuration for gke Clusters. Conflicts with aksConfig, eksConfig, k3sConfig and rkeConfig (list maxitems:1)

property k3sConfig

k3sConfig?: pulumi.Input<ClusterK3sConfig>;

The K3S configuration for k3s imported Clusters. Conflicts with aksConfig, eksConfig, gkeConfig and rkeConfig (list maxitems:1)

property kubeConfig

kubeConfig?: pulumi.Input<string>;

(Computed/Sensitive) Kube Config generated for the cluster (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for cluster registration token object (map)

property name

name?: pulumi.Input<string>;

Name of cluster registration token (string)

property rkeConfig

rkeConfig?: pulumi.Input<ClusterRkeConfig>;

The RKE configuration for rke Clusters. Conflicts with aksConfig, eksConfig, gkeConfig and k3sConfig (list maxitems:1)

property scheduledClusterScan

scheduledClusterScan?: pulumi.Input<ClusterScheduledClusterScan>;

Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)

property systemProjectId

systemProjectId?: pulumi.Input<string>;

(Computed) System project ID for the cluster (string)

property windowsPreferedCluster

windowsPreferedCluster?: pulumi.Input<boolean>;

Windows preferred cluster. Default: false (bool)

interface ClusterSyncArgs

interface ClusterSyncArgs

The set of arguments for constructing a ClusterSync resource.

property clusterId

clusterId: pulumi.Input<string>;

The cluster ID that is syncing (string)

property nodePoolIds

nodePoolIds?: pulumi.Input<pulumi.Input<string>[]>;

The node pool IDs used by the cluster id (list)

property synced

synced?: pulumi.Input<boolean>;

property waitMonitoring

waitMonitoring?: pulumi.Input<boolean>;

Wait until monitoring is up and running. Default: false (bool)

interface ClusterSyncState

interface ClusterSyncState

Input properties used for looking up and filtering ClusterSync resources.

property clusterId

clusterId?: pulumi.Input<string>;

The cluster ID that is syncing (string)

property defaultProjectId

defaultProjectId?: pulumi.Input<string>;

(Computed) Default project ID for the cluster sync (string)

property kubeConfig

kubeConfig?: pulumi.Input<string>;

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

property nodePoolIds

nodePoolIds?: pulumi.Input<pulumi.Input<string>[]>;

The node pool IDs used by the cluster id (list)

property synced

synced?: pulumi.Input<boolean>;

property systemProjectId

systemProjectId?: pulumi.Input<string>;

(Computed) System project ID for the cluster sync (string)

property waitMonitoring

waitMonitoring?: pulumi.Input<boolean>;

Wait until monitoring is up and running. Default: false (bool)

interface ClusterTemplateArgs

interface ClusterTemplateArgs

The set of arguments for constructing a ClusterTemplate resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for the cluster template revision (map)

property description

description?: pulumi.Input<string>;

Cluster template description

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for the cluster template revision (map)

property members

members?: pulumi.Input<pulumi.Input<ClusterTemplateMember>[]>;

Cluster template members (list)

property name

name?: pulumi.Input<string>;

The cluster template revision name (string)

property templateRevisions

templateRevisions?: pulumi.Input<pulumi.Input<ClusterTemplateTemplateRevision>[]>;

Cluster template revisions (list)

interface ClusterTemplateState

interface ClusterTemplateState

Input properties used for looking up and filtering ClusterTemplate resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for the cluster template revision (map)

property defaultRevisionId

defaultRevisionId?: pulumi.Input<string>;

(Computed) Default cluster template revision ID (string)

property description

description?: pulumi.Input<string>;

Cluster template description

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for the cluster template revision (map)

property members

members?: pulumi.Input<pulumi.Input<ClusterTemplateMember>[]>;

Cluster template members (list)

property name

name?: pulumi.Input<string>;

The cluster template revision name (string)

property templateRevisions

templateRevisions?: pulumi.Input<pulumi.Input<ClusterTemplateTemplateRevision>[]>;

Cluster template revisions (list)

interface EtcdBackupArgs

interface EtcdBackupArgs

The set of arguments for constructing a EtcdBackup resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Etcd Backup object (map)

property backupConfig

backupConfig?: pulumi.Input<EtcdBackupBackupConfig>;

Backup config for etcd backup (list maxitems:1)

property clusterId

clusterId: pulumi.Input<string>;

Cluster ID to config Etcd Backup (string)

property filename

filename?: pulumi.Input<string>;

Filename of the Etcd Backup (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Etcd Backup object (map)

property manual

manual?: pulumi.Input<boolean>;

Manual execution of the Etcd Backup. Default false (bool)

property name

name?: pulumi.Input<string>;

The name of the Etcd Backup (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

Description for the Etcd Backup (string)

interface EtcdBackupState

interface EtcdBackupState

Input properties used for looking up and filtering EtcdBackup resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Etcd Backup object (map)

property backupConfig

backupConfig?: pulumi.Input<EtcdBackupBackupConfig>;

Backup config for etcd backup (list maxitems:1)

property clusterId

clusterId?: pulumi.Input<string>;

Cluster ID to config Etcd Backup (string)

property filename

filename?: pulumi.Input<string>;

Filename of the Etcd Backup (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Etcd Backup object (map)

property manual

manual?: pulumi.Input<boolean>;

Manual execution of the Etcd Backup. Default false (bool)

property name

name?: pulumi.Input<string>;

The name of the Etcd Backup (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

Description for the Etcd Backup (string)

interface GetAppArgs

interface GetAppArgs

A collection of arguments for invoking getApp.

property annotations

annotations?: undefined | {[key: string]: any};

(Computed) Annotations for the catalog (map)

property name

name: string;

The app name (string)

property projectId

projectId: string;

The id of the project where the app is deployed (string)

property targetNamespace

targetNamespace?: undefined | string;

The namespace name where the app is deployed (string)

interface GetAppResult

interface GetAppResult

A collection of values returned by getApp.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for the catalog (map)

property answers

answers: {[key: string]: any};

(Computed) Answers for the app (map)

property catalogName

catalogName: string;

(Computed) Catalog name of the app (string)

property description

description: string;

(Computed) Description for the app (string)

property externalId

externalId: string;

(Computed) The URL of the helm catalog app (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for the catalog (map)

property name

name: string;

property projectId

projectId: string;

property revisionId

revisionId: string;

(Computed) Current revision id for the app (string)

property targetNamespace

targetNamespace: string;

property templateName

templateName: string;

(Computed) Template name of the app (string)

property templateVersion

templateVersion: string;

(Computed) Template version of the app (string)

property valuesYaml

valuesYaml: string;

(Computed) values.yaml base64 encoded file content for the app (string)

interface GetCatalogArgs

interface GetCatalogArgs

A collection of arguments for invoking getCatalog.

property name

name: string;

The catalog name.

property scope

scope?: undefined | string;

The scope of the catalog. cluster, global, and project are supported. Default global (string)

interface GetCatalogResult

interface GetCatalogResult

A collection of values returned by getCatalog.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for the catalog (map)

property branch

branch: string;

(Computed) The branch of the catalog repo to use (string)

property clusterId

clusterId: string;

(Computed) The cluster id of the catalog (string)

property description

description: string;

(Computed) A catalog description (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kind

kind: string;

(Computed) The kind of the catalog. Just helm by the moment (string)

property labels

labels: {[key: string]: any};

(Computed) Labels for the catalog (map)

property name

name: string;

property password

password: string;

(Computed/Sensitive) The password to access the catalog if needed (string)

property projectId

projectId: string;

(Computed) The project id of the catalog (string)

property scope

scope?: undefined | string;

property url

url: string;

(Computed) The url of the catalog repo (string)

property username

username: string;

(Computed/Sensitive) The username to access the catalog if needed (string)

property version

version: string;

(Computed) Helm version for the catalog (string)

interface GetCertificateArgs

interface GetCertificateArgs

A collection of arguments for invoking getCertificate.

property name

name: string;

The name of the certificate (string)

property namespaceId

namespaceId?: undefined | string;

The namespace id where to assign the namespaced certificate (string)

property projectId

projectId: string;

The project id where to assign the certificate (string)

interface GetCertificateResult

interface GetCertificateResult

A collection of values returned by getCertificate.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for certificate object (map)

property certs

certs: string;

(Computed) Base64 encoded certs (string)

property description

description: string;

(Computed) A certificate description (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for certificate object (map)

property name

name: string;

property namespaceId

namespaceId?: undefined | string;

property projectId

projectId: string;

interface GetCloudCredentialArgs

interface GetCloudCredentialArgs

A collection of arguments for invoking getCloudCredential.

property name

name: string;

The Cloud Credential name.

interface GetCloudCredentialResult

interface GetCloudCredentialResult

A collection of values returned by getCloudCredential.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for the Cloud Credential (map)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for the Cloud Credential (map)

property name

name: string;

interface GetClusterAlertGroupArgs

interface GetClusterAlertGroupArgs

A collection of arguments for invoking getClusterAlertGroup.

property clusterId

clusterId: string;

The cluster id where create cluster alert group (string)

property name

name: string;

The cluster alert group name (string)

interface GetClusterAlertGroupResult

interface GetClusterAlertGroupResult

A collection of values returned by getClusterAlertGroup.

property annotations

annotations: {[key: string]: any};

(Computed) The cluster alert group annotations (map)

property clusterId

clusterId: string;

property description

description: string;

(Computed) The cluster alert group description (string)

property groupIntervalSeconds

groupIntervalSeconds: number;

(Computed) The cluster alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds: number;

(Computed) The cluster alert group wait seconds. Default: 180 (int)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) The cluster alert group labels (map)

property name

name: string;

property recipients

recipients: GetClusterAlertGroupRecipient[];

(Computed) The cluster alert group recipients (list)

property repeatIntervalSeconds

repeatIntervalSeconds: number;

(Computed) The cluster alert group wait seconds. Default: 3600 (int)

interface GetClusterAlterRuleArgs

interface GetClusterAlterRuleArgs

A collection of arguments for invoking getClusterAlterRule.

property clusterId

clusterId: string;

The cluster id where create cluster alert rule (string)

property labels

labels?: undefined | {[key: string]: any};

(Computed) The cluster alert rule labels (map)

property name

name: string;

The cluster alert rule name (string)

interface GetClusterAlterRuleResult

interface GetClusterAlterRuleResult

A collection of values returned by getClusterAlterRule.

property annotations

annotations: {[key: string]: any};

(Computed) The cluster alert rule annotations (map)

property clusterId

clusterId: string;

property eventRule

eventRule: GetClusterAlterRuleEventRule;

(Computed) The cluster alert rule event rule. ConflictsWith: "metricRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property groupId

groupId: string;

(Computed) The cluster alert rule alert group ID (string)

property groupIntervalSeconds

groupIntervalSeconds: number;

(Computed) The cluster alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds: number;

(Computed) The cluster alert rule group wait seconds. Default: 180 (int)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property inherited

inherited: boolean;

(Computed) The cluster alert rule inherited. Default: true (bool)

property labels

labels?: undefined | {[key: string]: any};

(Computed) The cluster alert rule labels (map)

property metricRule

metricRule: GetClusterAlterRuleMetricRule;

(Computed) The cluster alert rule metric rule. ConflictsWith: "eventRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property name

name: string;

property nodeRule

nodeRule: GetClusterAlterRuleNodeRule;

(Computed) The cluster alert rule node rule. ConflictsWith: "eventRule", "metricRule", "systemServiceRule"` (list Maxitems:1)

property repeatIntervalSeconds

repeatIntervalSeconds: number;

(Optional) The cluster alert rule wait seconds. Default: 3600 (int)

property severity

severity: string;

(Computed) The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property systemServiceRule

systemServiceRule: GetClusterAlterRuleSystemServiceRule;

(Computed) The cluster alert rule system service rule. ConflictsWith: "eventRule", "metricRule", "nodeRule"` (list Maxitems:1)

interface GetClusterArgs

interface GetClusterArgs

A collection of arguments for invoking getCluster.

property name

name: string;

The name of the Cluster (string)

interface GetClusterDriverArgs

interface GetClusterDriverArgs

A collection of arguments for invoking getClusterDriver.

property name

name: string;

Name of the cluster driver (string)

property url

url?: undefined | string;

The URL to download the machine driver binary for 64-bit Linux (string)

interface GetClusterDriverResult

interface GetClusterDriverResult

A collection of values returned by getClusterDriver.

property active

active: boolean;

(Computed) Specify if the cluster driver state (bool)

property actualUrl

actualUrl: string;

(Computed) Actual url of the cluster driver (string)

property annotations

annotations: {[key: string]: any};

(Computed) Annotations of the resource (map)

property builtin

builtin: boolean;

(Computed) Specify whether the cluster driver is an internal cluster driver or not (bool)

property checksum

checksum: string;

(Computed) Verify that the downloaded driver matches the expected checksum (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels of the resource (map)

property name

name: string;

property uiUrl

uiUrl: string;

(Computed) The URL to load for customized Add Clusters screen for this driver (string)

property url

url: string;

property whitelistDomains

whitelistDomains: string[];

(Computed) Domains to whitelist for the ui (list)

interface GetClusterLoggingArgs

interface GetClusterLoggingArgs

A collection of arguments for invoking getClusterLogging.

property clusterId

clusterId: string;

The cluster id to configure logging (string)

interface GetClusterLoggingResult

interface GetClusterLoggingResult

A collection of values returned by getClusterLogging.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Cluster Logging object (map)

property clusterId

clusterId: string;

property customTargetConfig

customTargetConfig: GetClusterLoggingCustomTargetConfig;

property elasticsearchConfig

elasticsearchConfig: GetClusterLoggingElasticsearchConfig;

(Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

property enableJsonParsing

enableJsonParsing: boolean;

property fluentdConfig

fluentdConfig: GetClusterLoggingFluentdConfig;

(Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kafkaConfig

kafkaConfig: GetClusterLoggingKafkaConfig;

(Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

property kind

kind: string;

(Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

labels: {[key: string]: any};

(Computed) Labels for Cluster Logging object (map)

property name

name: string;

(Computed) The name of the cluster logging config (string)

property namespaceId

namespaceId: string;

(Computed) The namespace id from cluster logging (string)

property outputFlushInterval

outputFlushInterval: number;

(Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

outputTags: {[key: string]: any};

(computed) The output tags for Cluster Logging (map)

property splunkConfig

splunkConfig: GetClusterLoggingSplunkConfig;

(Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

property syslogConfig

syslogConfig: GetClusterLoggingSyslogConfig;

(Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

interface GetClusterResult

interface GetClusterResult

A collection of values returned by getCluster.

property aksConfig

aksConfig: GetClusterAksConfig;

(Computed) The Azure aks configuration for aks Clusters. Conflicts with eksConfig, gkeConfig and rkeConfig (list maxitems:1)

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Node Pool object (map)

property clusterAuthEndpoint

clusterAuthEndpoint: GetClusterClusterAuthEndpoint;

(Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

property clusterMonitoringInput

clusterMonitoringInput: GetClusterClusterMonitoringInput;

(Computed) Cluster monitoring config (list maxitems:1)

property clusterRegistrationToken

clusterRegistrationToken: GetClusterClusterRegistrationToken;

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

property clusterTemplateAnswers

clusterTemplateAnswers: GetClusterClusterTemplateAnswers;

(Computed) Cluster template answers (list maxitems:1)

property clusterTemplateId

clusterTemplateId: string;

(Computed) Cluster template ID (string)

property clusterTemplateQuestions

clusterTemplateQuestions: GetClusterClusterTemplateQuestion[];

(Computed) Cluster template questions (list)

property clusterTemplateRevisionId

clusterTemplateRevisionId: string;

(Computed) Cluster template revision ID (string)

property defaultPodSecurityPolicyTemplateId

defaultPodSecurityPolicyTemplateId: string;

(Optional/Computed) Default pod security policy template id (string)

property defaultProjectId

defaultProjectId: string;

(Computed) Default project ID for the cluster (string)

property description

description: string;

(Computed) The description for Cluster (string)

property driver

driver: string;

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

property eksConfig

eksConfig: GetClusterEksConfig;

(Computed) The Amazon eks configuration for eks Clusters. Conflicts with aksConfig, gkeConfig and rkeConfig (list maxitems:1)

property enableClusterAlerting

enableClusterAlerting: boolean;

property enableClusterMonitoring

enableClusterMonitoring: boolean;

(Computed) Enable built-in cluster monitoring. Default false (bool)

property enableNetworkPolicy

enableNetworkPolicy: boolean;

(Computed) Enable project network isolation. Default false (bool)

property gkeConfig

gkeConfig: GetClusterGkeConfig;

(Computed) The Google gke configuration for gke Clusters. Conflicts with aksConfig, eksConfig and rkeConfig (list maxitems:1)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property k3sConfig

k3sConfig: GetClusterK3sConfig;

(Computed) The K3S configuration for k3s imported Clusters. Conflicts with aksConfig, eksConfig, gkeConfig and rkeConfig (list maxitems:1)

property kubeConfig

kubeConfig: string;

(Computed) Kube Config generated for the cluster (string)

property labels

labels: {[key: string]: any};

(Computed) Labels for Node Pool object (map)

property name

name: string;

property rkeConfig

rkeConfig: GetClusterRkeConfig;

(Computed) The RKE configuration for rke Clusters. Conflicts with aksConfig, eksConfig and gkeConfig (list maxitems:1)

property scheduledClusterScans

scheduledClusterScans: GetClusterScheduledClusterScan[];

property systemProjectId

systemProjectId: string;

(Computed) System project ID for the cluster (string)

interface GetClusterRoleTemplateBindingArgs

interface GetClusterRoleTemplateBindingArgs

A collection of arguments for invoking getClusterRoleTemplateBinding.

property clusterId

clusterId: string;

The cluster id where bind cluster role template (string)

property name

name: string;

The name of the cluster role template binding (string)

property roleTemplateId

roleTemplateId?: undefined | string;

The role template id from create cluster role template binding (string)

interface GetClusterRoleTemplateBindingResult

interface GetClusterRoleTemplateBindingResult

A collection of values returned by getClusterRoleTemplateBinding.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations of the resource (map)

property clusterId

clusterId: string;

property groupId

groupId: string;

(Computed) The group ID to assign cluster role template binding (string)

property groupPrincipalId

groupPrincipalId: string;

(Computed) The groupPrincipal ID to assign cluster role template binding (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels of the resource (map)

property name

name: string;

property roleTemplateId

roleTemplateId: string;

property userId

userId: string;

(Computed) The user ID to assign cluster role template binding (string)

property userPrincipalId

userPrincipalId: string;

(Computed) The userPrincipal ID to assign cluster role template binding (string)

interface GetClusterScanArgs

interface GetClusterScanArgs

A collection of arguments for invoking getClusterScan.

property clusterId

clusterId: string;

property name

name?: undefined | string;

interface GetClusterScanResult

interface GetClusterScanResult

A collection of values returned by getClusterScan.

property annotations

annotations: {[key: string]: any};

property clusterId

clusterId: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

property name

name: string;

property runType

runType: string;

property scanConfig

scanConfig: GetClusterScanScanConfig;

property scanType

scanType: string;

property status

status: string;

interface GetClusterTemplateArgs

interface GetClusterTemplateArgs

A collection of arguments for invoking getClusterTemplate.

property annotations

annotations?: undefined | {[key: string]: any};

(Computed) Annotations for the cluster template (map)

property description

description?: undefined | string;

property labels

labels?: undefined | {[key: string]: any};

(Computed) Labels for the cluster template (map)

property name

name: string;

The cluster template name (string)

interface GetClusterTemplateResult

interface GetClusterTemplateResult

A collection of values returned by getClusterTemplate.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for the cluster template (map)

property defaultRevisionId

defaultRevisionId: string;

(Computed) Default cluster template revision ID (string)

property description

description: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for the cluster template (map)

property members

members: GetClusterTemplateMember[];

(Computed) Cluster template members (list)

property name

name: string;

property templateRevisions

templateRevisions: GetClusterTemplateTemplateRevision[];

(Computed) Cluster template revisions (list)

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

interface GetEtcdBackupArgs

interface GetEtcdBackupArgs

A collection of arguments for invoking getEtcdBackup.

property clusterId

clusterId: string;

Cluster ID to config Etcd Backup (string)

property name

name: string;

The name of the Etcd Backup (string)

interface GetEtcdBackupResult

interface GetEtcdBackupResult

A collection of values returned by getEtcdBackup.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Etcd Backup object (map)

property backupConfig

backupConfig: GetEtcdBackupBackupConfig;

(Computed) Backup config for etcd backup (list maxitems:1)

property clusterId

clusterId: string;

property filename

filename: string;

(Computed) Filename of the Etcd Backup (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for Etcd Backup object (map)

property manual

manual: boolean;

(Computed) Manual execution of the Etcd Backup. Default false (bool)

property name

name: string;

property namespaceId

namespaceId: string;

(Computed) Description for the Etcd Backup (string)

interface GetGlobalRoleBindingArgs

interface GetGlobalRoleBindingArgs

A collection of arguments for invoking getGlobalRoleBinding.

property globalRoleId

globalRoleId?: undefined | string;

The global role id (string)

property name

name: string;

The name of the global role binding (string)

interface GetGlobalRoleBindingResult

interface GetGlobalRoleBindingResult

A collection of values returned by getGlobalRoleBinding.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations of the resource (map)

property globalRoleId

globalRoleId: string;

property groupPrincipalId

groupPrincipalId: string;

(Computed) The group principal ID to assign global role binding. Rancher v2.4.0 or higher is required (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels of the resource (map)

property name

name: string;

property userId

userId: string;

(Computed) The user ID to assign global role binding (string)

interface GetMultiClusterAppArgs

interface GetMultiClusterAppArgs

A collection of arguments for invoking getMultiClusterApp.

property name

name: string;

The multi cluster app name (string)

interface GetMultiClusterAppResult

interface GetMultiClusterAppResult

A collection of values returned by getMultiClusterApp.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for multi cluster app object (map)

property answers

answers: GetMultiClusterAppAnswer[];

(Computed) The multi cluster app answers (list)

property catalogName

catalogName: string;

(Computed) The multi cluster app catalog name (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for multi cluster app object (map)

property members

members: GetMultiClusterAppMember[];

(Computed) The multi cluster app members (list)

property name

name: string;

property revisionHistoryLimit

revisionHistoryLimit: number;

(Computed) The multi cluster app revision history limit (int)

property revisionId

revisionId: string;

(Computed) Current revision id for the multi cluster app (string)

property roles

roles: string[];

(Computed) The multi cluster app roles (list)

property targets

targets: GetMultiClusterAppTarget[];

(Computed) The multi cluster app target projects (list)

property templateName

templateName: string;

(Computed) The multi cluster app template name (string)

property templateVersion

templateVersion: string;

(Computed) The multi cluster app template version (string)

property templateVersionId

templateVersionId: string;

(Computed) The multi cluster app template version ID (string)

property upgradeStrategies

upgradeStrategies: GetMultiClusterAppUpgradeStrategy[];

(Computed) The multi cluster app upgrade strategy (list)

interface GetNamespaceArgs

interface GetNamespaceArgs

A collection of arguments for invoking getNamespace.

property name

name: string;

The name of the namespace (string)

property projectId

projectId: string;

The project id where namespace is assigned (string)

interface GetNamespaceResult

interface GetNamespaceResult

A collection of values returned by getNamespace.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Node Pool object (map)

property containerResourceLimit

containerResourceLimit: GetNamespaceContainerResourceLimit;

(Computed) Default containers resource limits on namespace (List maxitem:1)

property description

description: string;

(Computed) A namespace description (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for Node Pool object (map)

property name

name: string;

property projectId

projectId: string;

property resourceQuota

resourceQuota: GetNamespaceResourceQuota;

(Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)

interface GetNodeDriverArgs

interface GetNodeDriverArgs

A collection of arguments for invoking getNodeDriver.

property name

name: string;

Name of the node driver (string)

property url

url?: undefined | string;

The URL to download the machine driver binary for 64-bit Linux (string)

interface GetNodeDriverResult

interface GetNodeDriverResult

A collection of values returned by getNodeDriver.

property active

active: boolean;

(Computed) Specify if the node driver state (bool)

property annotations

annotations: {[key: string]: any};

(Computed) Annotations of the resource (map)

property builtin

builtin: boolean;

(Computed) Specify wheter the node driver is an internal cluster driver or not (bool)

property checksum

checksum: string;

(Computed) Verify that the downloaded driver matches the expected checksum (string)

property description

description: string;

(Computed) Description of the node driver (string)

property externalId

externalId: string;

(Computed) External ID (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels of the resource (map)

property name

name: string;

property uiUrl

uiUrl: string;

(Computed) The URL to load for customized Add Node screen for this driver (string)

property url

url: string;

property whitelistDomains

whitelistDomains: string[];

(Computed) Domains to whitelist for the ui (list)

interface GetNodePoolArgs

interface GetNodePoolArgs

A collection of arguments for invoking getNodePool.

property clusterId

clusterId: string;

The RKE cluster id to use Node Pool (string)

property name

name: string;

The name of the Node Pool (string)

property nodeTemplateId

nodeTemplateId?: undefined | string;

The Node Template ID to use for node creation (string)

interface GetNodePoolResult

interface GetNodePoolResult

A collection of values returned by getNodePool.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Node Pool object (map)

property clusterId

clusterId: string;

property controlPlane

controlPlane: boolean;

(Computed) RKE control plane role for created nodes (bool)

property deleteNotReadyAfterSecs

deleteNotReadyAfterSecs: number;

(Computed) Delete not ready node after secs. Default 0 (int)

property etcd

etcd: boolean;

(Computed) RKE etcd role for created nodes (bool)

property hostnamePrefix

hostnamePrefix: string;

(Computed) The prefix for created nodes of the Node Pool (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for Node Pool object (map)

property name

name: string;

property nodeTaints

nodeTaints: GetNodePoolNodeTaint[];

(Computed) Node taints (List)

property nodeTemplateId

nodeTemplateId: string;

property quantity

quantity: number;

(Computed) The number of nodes to create on Node Pool (int)

property worker

worker: boolean;

(Computed) RKE role role for created nodes (bool)

interface GetNodeTemplateArgs

interface GetNodeTemplateArgs

A collection of arguments for invoking getNodeTemplate.

property name

name: string;

The name of the Node Template (string)

property useInternalIpAddress

useInternalIpAddress?: undefined | false | true;

(Computed) Engine storage driver for the node template (bool)

interface GetNodeTemplateResult

interface GetNodeTemplateResult

A collection of values returned by getNodeTemplate.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Node Template object (map)

property cloudCredentialId

cloudCredentialId: string;

(Computed) Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

property description

description: string;

(Computed) Description for the Node Template (string)

property driver

driver: string;

(Computed) The driver of the node template (string)

property engineEnv

engineEnv: {[key: string]: any};

(Computed) Engine environment for the node template (string)

property engineInsecureRegistries

engineInsecureRegistries: string[];

(Computed) Insecure registry for the node template (list)

property engineInstallUrl

engineInstallUrl: string;

(Computed) Docker engine install URL for the node template (string)

property engineLabel

engineLabel: {[key: string]: any};

(Computed) Engine label for the node template (string)

property engineOpt

engineOpt: {[key: string]: any};

(Computed) Engine options for the node template (map)

property engineRegistryMirrors

engineRegistryMirrors: string[];

(Computed) Engine registry mirror for the node template (list)

property engineStorageDriver

engineStorageDriver: string;

(Computed) Engine storage driver for the node template (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for Node Template object (map)

property name

name: string;

property useInternalIpAddress

useInternalIpAddress?: undefined | false | true;

(Computed) Engine storage driver for the node template (bool)

interface GetNotifierArgs

interface GetNotifierArgs

A collection of arguments for invoking getNotifier.

property clusterId

clusterId: string;

The cluster id where create notifier (string)

property name

name: string;

The name of the notifier (string)

interface GetNotifierResult

interface GetNotifierResult

A collection of values returned by getNotifier.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for notifier object (map)

property clusterId

clusterId: string;

property description

description: string;

(Computed) The notifier description (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for notifier object (map)

property name

name: string;

property pagerdutyConfig

pagerdutyConfig: GetNotifierPagerdutyConfig;

(Computed) Pagerduty config for notifier (list maxitems:1)

property slackConfig

slackConfig: GetNotifierSlackConfig;

(Computed) Slack config for notifier (list maxitems:1)

property smtpConfig

smtpConfig: GetNotifierSmtpConfig;

(Computed) SMTP config for notifier (list maxitems:1)

property webhookConfig

webhookConfig: GetNotifierWebhookConfig;

(Computed) Webhook config for notifier (list maxitems:1)

property wechatConfig

wechatConfig: GetNotifierWechatConfig;

(Computed) Wechat config for notifier (list maxitems:1)

interface GetPodSecurityPolicyTemplateArgs

interface GetPodSecurityPolicyTemplateArgs

A collection of arguments for invoking getPodSecurityPolicyTemplate.

property allowPrivilegeEscalation

allowPrivilegeEscalation?: undefined | false | true;

= (Optional)

property allowedCapabilities

allowedCapabilities?: string[];

(list)

property allowedCsiDrivers

allowedCsiDrivers?: GetPodSecurityPolicyTemplateAllowedCsiDriver[];

(list)

property allowedFlexVolumes

allowedFlexVolumes?: GetPodSecurityPolicyTemplateAllowedFlexVolume[];

(list)

property allowedHostPaths

allowedHostPaths?: GetPodSecurityPolicyTemplateAllowedHostPath[];

(list)

property allowedProcMountTypes

allowedProcMountTypes?: string[];

(list)

property allowedUnsafeSysctls

allowedUnsafeSysctls?: string[];

(list)

property annotations

annotations?: undefined | {[key: string]: any};

Annotations for PodSecurityPolicyTemplate object (map)

property defaultAddCapabilities

defaultAddCapabilities?: string[];

(list)

property defaultAllowPrivilegeEscalation

defaultAllowPrivilegeEscalation?: undefined | false | true;

(list)

property description

description?: undefined | string;

The PodSecurityPolicyTemplate description (string)

property forbiddenSysctls

forbiddenSysctls?: string[];

(list)

property fsGroup

fsGroup?: inputs.GetPodSecurityPolicyTemplateFsGroup;

(list maxitems:1)

property hostIpc

hostIpc?: undefined | false | true;

(bool)

property hostNetwork

hostNetwork?: undefined | false | true;

property hostPid

hostPid?: undefined | false | true;

(bool)

property hostPorts

hostPorts?: GetPodSecurityPolicyTemplateHostPort[];

(list)

property labels

labels?: undefined | {[key: string]: any};

Labels for PodSecurityPolicyTemplate object (map)

property name

name: string;

The name of the PodSecurityPolicyTemplate (string)

property privileged

privileged?: undefined | false | true;

(bool)

property readOnlyRootFilesystem

readOnlyRootFilesystem?: undefined | false | true;

(bool)

property requiredDropCapabilities

requiredDropCapabilities?: string[];

(list)

property runAsGroup

runAsGroup?: inputs.GetPodSecurityPolicyTemplateRunAsGroup;

(list maxitems:1)

property runAsUser

runAsUser?: inputs.GetPodSecurityPolicyTemplateRunAsUser;

(list maxitems:1)

property runtimeClass

runtimeClass?: inputs.GetPodSecurityPolicyTemplateRuntimeClass;

(list maxitems:1)

property seLinux

seLinux?: inputs.GetPodSecurityPolicyTemplateSeLinux;

(list maxitems:1)

property supplementalGroup

supplementalGroup?: inputs.GetPodSecurityPolicyTemplateSupplementalGroup;

(list maxitems:1)

property volumes

volumes?: string[];

(list)

interface GetPodSecurityPolicyTemplateResult

interface GetPodSecurityPolicyTemplateResult

A collection of values returned by getPodSecurityPolicyTemplate.

property allowPrivilegeEscalation

allowPrivilegeEscalation: boolean;

property allowedCapabilities

allowedCapabilities?: string[];

property allowedCsiDrivers

allowedCsiDrivers?: GetPodSecurityPolicyTemplateAllowedCsiDriver[];

property allowedFlexVolumes

allowedFlexVolumes?: GetPodSecurityPolicyTemplateAllowedFlexVolume[];

property allowedHostPaths

allowedHostPaths?: GetPodSecurityPolicyTemplateAllowedHostPath[];

property allowedProcMountTypes

allowedProcMountTypes?: string[];

property allowedUnsafeSysctls

allowedUnsafeSysctls?: string[];

property annotations

annotations: {[key: string]: any};

property defaultAddCapabilities

defaultAddCapabilities?: string[];

property defaultAllowPrivilegeEscalation

defaultAllowPrivilegeEscalation?: undefined | false | true;

property description

description: string;

property forbiddenSysctls

forbiddenSysctls?: string[];

property fsGroup

fsGroup: GetPodSecurityPolicyTemplateFsGroup;

property hostIpc

hostIpc: boolean;

property hostNetwork

hostNetwork: boolean;

property hostPid

hostPid: boolean;

property hostPorts

hostPorts: GetPodSecurityPolicyTemplateHostPort[];

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

property name

name: string;

property privileged

privileged: boolean;

property readOnlyRootFilesystem

readOnlyRootFilesystem: boolean;

property requiredDropCapabilities

requiredDropCapabilities?: string[];

property runAsGroup

runAsGroup?: outputs.GetPodSecurityPolicyTemplateRunAsGroup;

property runAsUser

runAsUser: GetPodSecurityPolicyTemplateRunAsUser;

property runtimeClass

runtimeClass?: outputs.GetPodSecurityPolicyTemplateRuntimeClass;

property seLinux

seLinux: GetPodSecurityPolicyTemplateSeLinux;

property supplementalGroup

supplementalGroup: GetPodSecurityPolicyTemplateSupplementalGroup;

property volumes

volumes: string[];

interface GetProjectAlertGroupArgs

interface GetProjectAlertGroupArgs

A collection of arguments for invoking getProjectAlertGroup.

property name

name: string;

The project alert group name (string)

property projectId

projectId: string;

The project id where create project alert group (string)

interface GetProjectAlertGroupResult

interface GetProjectAlertGroupResult

A collection of values returned by getProjectAlertGroup.

property annotations

annotations: {[key: string]: any};

(Computed) The project alert group annotations (map)

property description

description: string;

(Computed) The project alert group description (string)

property groupIntervalSeconds

groupIntervalSeconds: number;

(Computed) The project alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds: number;

(Computed) The project alert group wait seconds. Default: 180 (int)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) The project alert group labels (map)

property name

name: string;

property projectId

projectId: string;

property recipients

recipients: GetProjectAlertGroupRecipient[];

(Computed) The project alert group recipients (list)

property repeatIntervalSeconds

repeatIntervalSeconds: number;

(Computed) The project alert group wait seconds. Default: 3600 (int)

interface GetProjectAlertRuleArgs

interface GetProjectAlertRuleArgs

A collection of arguments for invoking getProjectAlertRule.

property labels

labels?: undefined | {[key: string]: any};

(Computed) The project alert rule labels (map)

property name

name: string;

The project alert rule name (string)

property projectId

projectId: string;

The project id where create project alert rule (string)

interface GetProjectAlertRuleResult

interface GetProjectAlertRuleResult

A collection of values returned by getProjectAlertRule.

property annotations

annotations: {[key: string]: any};

(Computed) The project alert rule annotations (map)

property groupId

groupId: string;

(Computed) The project alert rule alert group ID (string)

property groupIntervalSeconds

groupIntervalSeconds: number;

(Computed) The project alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds: number;

(Computed) The project alert rule group wait seconds. Default: 180 (int)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property inherited

inherited: boolean;

(Computed) The project alert rule inherited. Default: true (bool)

property labels

labels?: undefined | {[key: string]: any};

(Computed) The project alert rule labels (map)

property metricRule

metricRule: GetProjectAlertRuleMetricRule;

(Computed) The project alert rule metric rule. ConflictsWith: "podRule", "workloadRule"` (list Maxitems:1)

property name

name: string;

property podRule

podRule: GetProjectAlertRulePodRule;

(Computed) The project alert rule pod rule. ConflictsWith: "metricRule", "workloadRule"` (list Maxitems:1)

property projectId

projectId: string;

property repeatIntervalSeconds

repeatIntervalSeconds: number;

(Computed) The project alert rule wait seconds. Default: 3600 (int)

property severity

severity: string;

(Computed) The project alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property workloadRule

workloadRule: GetProjectAlertRuleWorkloadRule;

(Computed) The project alert rule workload rule. ConflictsWith: "metricRule", "podRule"` (list Maxitems:1)

interface GetProjectArgs

interface GetProjectArgs

A collection of arguments for invoking getProject.

property clusterId

clusterId: string;

ID of the Rancher 2 cluster (string)

property name

name: string;

The project name (string)

interface GetProjectLoggingArgs

interface GetProjectLoggingArgs

A collection of arguments for invoking getProjectLogging.

property projectId

projectId: string;

The project id to configure logging (string)

interface GetProjectLoggingResult

interface GetProjectLoggingResult

A collection of values returned by getProjectLogging.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Cluster Logging object (map)

property customTargetConfig

customTargetConfig: GetProjectLoggingCustomTargetConfig;

property elasticsearchConfig

elasticsearchConfig: GetProjectLoggingElasticsearchConfig;

(Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

property enableJsonParsing

enableJsonParsing: boolean;

property fluentdConfig

fluentdConfig: GetProjectLoggingFluentdConfig;

(Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kafkaConfig

kafkaConfig: GetProjectLoggingKafkaConfig;

(Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

property kind

kind: string;

(Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

labels: {[key: string]: any};

(Computed) Labels for Cluster Logging object (map)

property name

name: string;

(Computed) The name of the cluster logging config (string)

property namespaceId

namespaceId: string;

(Computed) The namespace id from cluster logging (string)

property outputFlushInterval

outputFlushInterval: number;

(Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

outputTags: {[key: string]: any};

(computed) The output tags for Cluster Logging (map)

property projectId

projectId: string;

property splunkConfig

splunkConfig: GetProjectLoggingSplunkConfig;

(Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

property syslogConfig

syslogConfig: GetProjectLoggingSyslogConfig;

(Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

interface GetProjectResult

interface GetProjectResult

A collection of values returned by getProject.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations of the rancher2 project (map)

property clusterId

clusterId: string;

property containerResourceLimit

containerResourceLimit: GetProjectContainerResourceLimit;

(Computed) Default containers resource limits on project (List maxitem:1)

property description

description: string;

(Computed) The project’s description (string)

property enableProjectMonitoring

enableProjectMonitoring: boolean;

(Computed) Enable built-in project monitoring. Default false (bool)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels of the rancher2 project (map)

property name

name: string;

property podSecurityPolicyTemplateId

podSecurityPolicyTemplateId: string;

(Computed) Default Pod Security Policy ID for the project (string)

property resourceQuota

resourceQuota: GetProjectResourceQuota;

(Computed) Resource quota for project. Rancher v2.1.x or higher (list maxitems:1)

property uuid

uuid: string;

(Computed) UUID of the project as stored by Rancher 2 (string)

interface GetProjectRoleTemplateBindingArgs

interface GetProjectRoleTemplateBindingArgs

A collection of arguments for invoking getProjectRoleTemplateBinding.

property name

name: string;

The name of the project role template binding (string)

property projectId

projectId: string;

The project id where bind project role template (string)

property roleTemplateId

roleTemplateId?: undefined | string;

The role template id from create project role template binding (string)

interface GetProjectRoleTemplateBindingResult

interface GetProjectRoleTemplateBindingResult

A collection of values returned by getProjectRoleTemplateBinding.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations of the resource (map)

property groupId

groupId: string;

(Computed) The group ID to assign project role template binding (string)

property groupPrincipalId

groupPrincipalId: string;

(Computed) The groupPrincipal ID to assign project role template binding (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels of the resource (map)

property name

name: string;

property projectId

projectId: string;

property roleTemplateId

roleTemplateId: string;

property userId

userId: string;

(Computed) The user ID to assign project role template binding (string)

property userPrincipalId

userPrincipalId: string;

(Computed) The userPrincipal ID to assign project role template binding (string)

interface GetRegistryArgs

interface GetRegistryArgs

A collection of arguments for invoking getRegistry.

property name

name: string;

The name of the registry (string)

property namespaceId

namespaceId?: undefined | string;

The namespace id where to assign the namespaced registry (string)

property projectId

projectId: string;

The project id where to assign the registry (string)

interface GetRegistryResult

interface GetRegistryResult

A collection of values returned by getRegistry.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Registry object (map)

property description

description: string;

(Computed) A registry description (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for Registry object (map)

property name

name: string;

property namespaceId

namespaceId?: undefined | string;

property projectId

projectId: string;

property registries

registries: GetRegistryRegistry[];

(Computed) Registries data for registry (list)

interface GetRoleTempalteArgs

interface GetRoleTempalteArgs

A collection of arguments for invoking getRoleTempalte.

property context

context?: undefined | string;

Role template context. cluster and project values are supported (string)

property name

name: string;

The name of the Node Template (string)

interface GetRoleTempalteResult

interface GetRoleTempalteResult

A collection of values returned by getRoleTempalte.

property administrative

administrative: boolean;

(Computed) Administrative role template (bool)

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for role template object (map)

property builtin

builtin: boolean;

(Computed) Builtin role template (string)

property context

context: string;

property defaultRole

defaultRole: boolean;

(Computed) Default role template for new created cluster or project (bool)

property description

description: string;

(Computed) Role template description (string)

property external

external: boolean;

(Computed) External role template (bool)

property hidden

hidden: boolean;

(Computed) Hidden role template (bool)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for role template object (map)

property locked

locked: boolean;

(Computed) Locked role template (bool)

property name

name: string;

property roleTemplateIds

roleTemplateIds: string[];

(Computed) Inherit role template IDs (list)

property rules

rules: GetRoleTempalteRule[];

(Computed) Role template policy rules (list)

interface GetRoleTemplateArgs

interface GetRoleTemplateArgs

A collection of arguments for invoking getRoleTemplate.

property context

context?: undefined | string;

Role template context. cluster and project values are supported (string)

property name

name: string;

The name of the Node Template (string)

interface GetRoleTemplateResult

interface GetRoleTemplateResult

A collection of values returned by getRoleTemplate.

property administrative

administrative: boolean;

(Computed) Administrative role template (bool)

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for role template object (map)

property builtin

builtin: boolean;

(Computed) Builtin role template (string)

property context

context: string;

property defaultRole

defaultRole: boolean;

(Computed) Default role template for new created cluster or project (bool)

property description

description: string;

(Computed) Role template description (string)

property external

external: boolean;

(Computed) External role template (bool)

property hidden

hidden: boolean;

(Computed) Hidden role template (bool)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for role template object (map)

property locked

locked: boolean;

(Computed) Locked role template (bool)

property name

name: string;

property roleTemplateIds

roleTemplateIds: string[];

(Computed) Inherit role template IDs (list)

property rules

rules: GetRoleTemplateRule[];

(Computed) Role template policy rules (list)

interface GetSecretArgs

interface GetSecretArgs

A collection of arguments for invoking getSecret.

property name

name: string;

The name of the secret (string)

property namespaceId

namespaceId?: undefined | string;

The namespace id where to assign the namespaced secret (string)

property projectId

projectId: string;

The project id where to assign the secret (string)

interface GetSecretResult

interface GetSecretResult

A collection of values returned by getSecret.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for secret object (map)

property data

data: {[key: string]: any};

(Computed) Secret key/value data. Base64 encoding required for values (map)

property description

description: string;

(Computed) A secret description (string)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels: {[key: string]: any};

(Computed) Labels for secret object (map)

property name

name: string;

property namespaceId

namespaceId?: undefined | string;

property projectId

projectId: string;

interface GetSettingArgs

interface GetSettingArgs

A collection of arguments for invoking getSetting.

property name

name: string;

The setting name.

interface GetSettingResult

interface GetSettingResult

A collection of values returned by getSetting.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property value

value: string;

the settting’s value.

interface GetUserArgs

interface GetUserArgs

A collection of arguments for invoking getUser.

property isExternal

isExternal?: undefined | false | true;

Set is the user if the user is external. Default: false (bool)

property name

name?: undefined | string;

The name of the user (string)

property username

username?: undefined | string;

The username of the user (string)

interface GetUserResult

interface GetUserResult

A collection of values returned by getUser.

property annotations

annotations: {[key: string]: any};

(Computed) Annotations of the resource (map)

property enabled

enabled: boolean;

(Computed) The user is enabled (bool)

property id

id: string;

The provider-assigned unique ID for this managed resource.

property isExternal

isExternal?: undefined | false | true;

property labels

labels: {[key: string]: any};

(Computed) Labels of the resource (map)

property name

name: string;

(Computed) The user common name (string)

property principalIds

principalIds: string[];

(Computed) The user principal IDs (list)

property username

username: string;

function getVersion

getVersion(): string

interface GlobalRoleBindingArgs

interface GlobalRoleBindingArgs

The set of arguments for constructing a GlobalRoleBinding resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for global role binding (map)

property globalRoleId

globalRoleId: pulumi.Input<string>;

The role id from create global role binding (string)

property groupPrincipalId

groupPrincipalId?: pulumi.Input<string>;

The group principal ID to assign global role binding (only works with external auth providers that support groups). Rancher v2.4.0 or higher is required (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for global role binding (map)

property name

name?: pulumi.Input<string>;

The name of the global role binding (string)

property userId

userId?: pulumi.Input<string>;

The user ID to assign global role binding (string)

interface GlobalRoleBindingState

interface GlobalRoleBindingState

Input properties used for looking up and filtering GlobalRoleBinding resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for global role binding (map)

property globalRoleId

globalRoleId?: pulumi.Input<string>;

The role id from create global role binding (string)

property groupPrincipalId

groupPrincipalId?: pulumi.Input<string>;

The group principal ID to assign global role binding (only works with external auth providers that support groups). Rancher v2.4.0 or higher is required (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for global role binding (map)

property name

name?: pulumi.Input<string>;

The name of the global role binding (string)

property userId

userId?: pulumi.Input<string>;

The user ID to assign global role binding (string)

interface MultiClusterAppArgs

interface MultiClusterAppArgs

The set of arguments for constructing a MultiClusterApp resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for multi cluster app object (map)

property answers

answers?: pulumi.Input<pulumi.Input<MultiClusterAppAnswer>[]>;

The multi cluster app answers (list)

property catalogName

catalogName: pulumi.Input<string>;

The multi cluster app catalog name (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for multi cluster app object (map)

property members

members?: pulumi.Input<pulumi.Input<MultiClusterAppMember>[]>;

The multi cluster app answers (list)

property name

name?: pulumi.Input<string>;

The multi cluster app name (string)

property revisionHistoryLimit

revisionHistoryLimit?: pulumi.Input<number>;

The multi cluster app revision history limit. Default 10 (int)

property revisionId

revisionId?: pulumi.Input<string>;

Current revision id for the multi cluster app (string)

property roles

roles: pulumi.Input<pulumi.Input<string>[]>;

The multi cluster app roles (list)

property targets

targets: pulumi.Input<pulumi.Input<MultiClusterAppTarget>[]>;

The multi cluster app target projects (list)

property templateName

templateName: pulumi.Input<string>;

The multi cluster app template name (string)

property templateVersion

templateVersion?: pulumi.Input<string>;

The multi cluster app template version. Default: latest (string)

property upgradeStrategy

upgradeStrategy?: pulumi.Input<MultiClusterAppUpgradeStrategy>;

The multi cluster app upgrade strategy (list MaxItems:1)

property wait

wait?: pulumi.Input<boolean>;

Wait until the multi cluster app is active. Default true (bool)

interface MultiClusterAppState

interface MultiClusterAppState

Input properties used for looking up and filtering MultiClusterApp resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for multi cluster app object (map)

property answers

answers?: pulumi.Input<pulumi.Input<MultiClusterAppAnswer>[]>;

The multi cluster app answers (list)

property catalogName

catalogName?: pulumi.Input<string>;

The multi cluster app catalog name (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for multi cluster app object (map)

property members

members?: pulumi.Input<pulumi.Input<MultiClusterAppMember>[]>;

The multi cluster app answers (list)

property name

name?: pulumi.Input<string>;

The multi cluster app name (string)

property revisionHistoryLimit

revisionHistoryLimit?: pulumi.Input<number>;

The multi cluster app revision history limit. Default 10 (int)

property revisionId

revisionId?: pulumi.Input<string>;

Current revision id for the multi cluster app (string)

property roles

roles?: pulumi.Input<pulumi.Input<string>[]>;

The multi cluster app roles (list)

property targets

targets?: pulumi.Input<pulumi.Input<MultiClusterAppTarget>[]>;

The multi cluster app target projects (list)

property templateName

templateName?: pulumi.Input<string>;

The multi cluster app template name (string)

property templateVersion

templateVersion?: pulumi.Input<string>;

The multi cluster app template version. Default: latest (string)

property templateVersionId

templateVersionId?: pulumi.Input<string>;

(Computed) The multi cluster app template version ID (string)

property upgradeStrategy

upgradeStrategy?: pulumi.Input<MultiClusterAppUpgradeStrategy>;

The multi cluster app upgrade strategy (list MaxItems:1)

property wait

wait?: pulumi.Input<boolean>;

Wait until the multi cluster app is active. Default true (bool)

interface NamespaceArgs

interface NamespaceArgs

The set of arguments for constructing a Namespace resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Pool object (map)

property containerResourceLimit

containerResourceLimit?: pulumi.Input<NamespaceContainerResourceLimit>;

Default containers resource limits on namespace (List maxitem:1)

property description

description?: pulumi.Input<string>;

A namespace description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

name?: pulumi.Input<string>;

The name of the namespace (string)

property projectId

projectId: pulumi.Input<string>;

The project id where assign namespace. It’s on the form project_id=<cluster_id>:<id>. Updating <id> part on same <cluster_id> namespace will be moved between projects (string)

property resourceQuota

resourceQuota?: pulumi.Input<NamespaceResourceQuota>;

Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)

property waitForCluster

waitForCluster?: pulumi.Input<boolean>;

Wait for cluster becomes active. Default false (bool)

interface NamespaceState

interface NamespaceState

Input properties used for looking up and filtering Namespace resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Pool object (map)

property containerResourceLimit

containerResourceLimit?: pulumi.Input<NamespaceContainerResourceLimit>;

Default containers resource limits on namespace (List maxitem:1)

property description

description?: pulumi.Input<string>;

A namespace description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

name?: pulumi.Input<string>;

The name of the namespace (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where assign namespace. It’s on the form project_id=<cluster_id>:<id>. Updating <id> part on same <cluster_id> namespace will be moved between projects (string)

property resourceQuota

resourceQuota?: pulumi.Input<NamespaceResourceQuota>;

Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)

property waitForCluster

waitForCluster?: pulumi.Input<boolean>;

Wait for cluster becomes active. Default false (bool)

interface NodeDriverArgs

interface NodeDriverArgs

The set of arguments for constructing a NodeDriver resource.

property active

active: pulumi.Input<boolean>;

Specify if the node driver state (bool)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property builtin

builtin: pulumi.Input<boolean>;

Specify wheter the node driver is an internal node driver or not (bool)

property checksum

checksum?: pulumi.Input<string>;

Verify that the downloaded driver matches the expected checksum (string)

property description

description?: pulumi.Input<string>;

Description of the node driver (string)

property externalId

externalId?: pulumi.Input<string>;

External ID (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

Name of the node driver (string)

property uiUrl

uiUrl?: pulumi.Input<string>;

The URL to load for customized Add Nodes screen for this driver (string)

property url

url: pulumi.Input<string>;

The URL to download the machine driver binary for 64-bit Linux (string)

property whitelistDomains

whitelistDomains?: pulumi.Input<pulumi.Input<string>[]>;

Domains to whitelist for the ui (list)

interface NodeDriverState

interface NodeDriverState

Input properties used for looking up and filtering NodeDriver resources.

property active

active?: pulumi.Input<boolean>;

Specify if the node driver state (bool)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property builtin

builtin?: pulumi.Input<boolean>;

Specify wheter the node driver is an internal node driver or not (bool)

property checksum

checksum?: pulumi.Input<string>;

Verify that the downloaded driver matches the expected checksum (string)

property description

description?: pulumi.Input<string>;

Description of the node driver (string)

property externalId

externalId?: pulumi.Input<string>;

External ID (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

Name of the node driver (string)

property uiUrl

uiUrl?: pulumi.Input<string>;

The URL to load for customized Add Nodes screen for this driver (string)

property url

url?: pulumi.Input<string>;

The URL to download the machine driver binary for 64-bit Linux (string)

property whitelistDomains

whitelistDomains?: pulumi.Input<pulumi.Input<string>[]>;

Domains to whitelist for the ui (list)

interface NodePoolArgs

interface NodePoolArgs

The set of arguments for constructing a NodePool resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Pool object (map)

property clusterId

clusterId: pulumi.Input<string>;

The RKE cluster id to use Node Pool (string)

property controlPlane

controlPlane?: pulumi.Input<boolean>;

RKE control plane role for created nodes (bool)

property deleteNotReadyAfterSecs

deleteNotReadyAfterSecs?: pulumi.Input<number>;

Delete not ready node after secs. For Rancher v2.3.3 or above. Default 0 (int)

property etcd

etcd?: pulumi.Input<boolean>;

RKE etcd role for created nodes (bool)

property hostnamePrefix

hostnamePrefix: pulumi.Input<string>;

The prefix for created nodes of the Node Pool (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

name?: pulumi.Input<string>;

The name of the Node Pool (string)

property nodeTaints

nodeTaints?: pulumi.Input<pulumi.Input<NodePoolNodeTaint>[]>;

Node taints. For Rancher v2.3.3 or above (List)

property nodeTemplateId

nodeTemplateId: pulumi.Input<string>;

The Node Template ID to use for node creation (string)

property quantity

quantity?: pulumi.Input<number>;

The number of nodes to create on Node Pool. Default 1. Only values >= 1 allowed (int)

property worker

worker?: pulumi.Input<boolean>;

RKE role role for created nodes (bool)

interface NodePoolState

interface NodePoolState

Input properties used for looking up and filtering NodePool resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Pool object (map)

property clusterId

clusterId?: pulumi.Input<string>;

The RKE cluster id to use Node Pool (string)

property controlPlane

controlPlane?: pulumi.Input<boolean>;

RKE control plane role for created nodes (bool)

property deleteNotReadyAfterSecs

deleteNotReadyAfterSecs?: pulumi.Input<number>;

Delete not ready node after secs. For Rancher v2.3.3 or above. Default 0 (int)

property etcd

etcd?: pulumi.Input<boolean>;

RKE etcd role for created nodes (bool)

property hostnamePrefix

hostnamePrefix?: pulumi.Input<string>;

The prefix for created nodes of the Node Pool (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

name?: pulumi.Input<string>;

The name of the Node Pool (string)

property nodeTaints

nodeTaints?: pulumi.Input<pulumi.Input<NodePoolNodeTaint>[]>;

Node taints. For Rancher v2.3.3 or above (List)

property nodeTemplateId

nodeTemplateId?: pulumi.Input<string>;

The Node Template ID to use for node creation (string)

property quantity

quantity?: pulumi.Input<number>;

The number of nodes to create on Node Pool. Default 1. Only values >= 1 allowed (int)

property worker

worker?: pulumi.Input<boolean>;

RKE role role for created nodes (bool)

interface NodeTemplateArgs

interface NodeTemplateArgs

The set of arguments for constructing a NodeTemplate resource.

property amazonec2Config

amazonec2Config?: pulumi.Input<NodeTemplateAmazonec2Config>;

AWS config for the Node Template (list maxitems:1)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Template object (map)

property authCertificateAuthority

authCertificateAuthority?: pulumi.Input<string>;

Auth certificate authority for the Node Template (string)

property authKey

authKey?: pulumi.Input<string>;

Auth key for the Node Template (string)

property azureConfig

azureConfig?: pulumi.Input<NodeTemplateAzureConfig>;

Azure config for the Node Template (list maxitems:1)

property cloudCredentialId

cloudCredentialId?: pulumi.Input<string>;

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

property description

description?: pulumi.Input<string>;

Description for the Node Template (string)

property digitaloceanConfig

digitaloceanConfig?: pulumi.Input<NodeTemplateDigitaloceanConfig>;

Digitalocean config for the Node Template (list maxitems:1)

property driverId

driverId?: pulumi.Input<string>;

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

property engineEnv

engineEnv?: pulumi.Input<{[key: string]: any}>;

Engine environment for the node template (string)

property engineInsecureRegistries

engineInsecureRegistries?: pulumi.Input<pulumi.Input<string>[]>;

Insecure registry for the node template (list)

property engineInstallUrl

engineInstallUrl?: pulumi.Input<string>;

property engineLabel

engineLabel?: pulumi.Input<{[key: string]: any}>;

Engine label for the node template (string)

property engineOpt

engineOpt?: pulumi.Input<{[key: string]: any}>;

Engine options for the node template (map)

property engineRegistryMirrors

engineRegistryMirrors?: pulumi.Input<pulumi.Input<string>[]>;

Engine registry mirror for the node template (list)

property engineStorageDriver

engineStorageDriver?: pulumi.Input<string>;

Engine storage driver for the node template (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Template object (map)

property linodeConfig

linodeConfig?: pulumi.Input<NodeTemplateLinodeConfig>;

Linode config for the Node Template (list maxitems:1)

property name

name?: pulumi.Input<string>;

The name of the Node Template (string)

property opennebulaConfig

opennebulaConfig?: pulumi.Input<NodeTemplateOpennebulaConfig>;

Opennebula config for the Node Template (list maxitems:1)

property openstackConfig

openstackConfig?: pulumi.Input<NodeTemplateOpenstackConfig>;

Openstack config for the Node Template (list maxitems:1)

property useInternalIpAddress

useInternalIpAddress?: pulumi.Input<boolean>;

Engine storage driver for the node template (bool)

property vsphereConfig

vsphereConfig?: pulumi.Input<NodeTemplateVsphereConfig>;

vSphere config for the Node Template (list maxitems:1)

interface NodeTemplateState

interface NodeTemplateState

Input properties used for looking up and filtering NodeTemplate resources.

property amazonec2Config

amazonec2Config?: pulumi.Input<NodeTemplateAmazonec2Config>;

AWS config for the Node Template (list maxitems:1)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Template object (map)

property authCertificateAuthority

authCertificateAuthority?: pulumi.Input<string>;

Auth certificate authority for the Node Template (string)

property authKey

authKey?: pulumi.Input<string>;

Auth key for the Node Template (string)

property azureConfig

azureConfig?: pulumi.Input<NodeTemplateAzureConfig>;

Azure config for the Node Template (list maxitems:1)

property cloudCredentialId

cloudCredentialId?: pulumi.Input<string>;

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

property description

description?: pulumi.Input<string>;

Description for the Node Template (string)

property digitaloceanConfig

digitaloceanConfig?: pulumi.Input<NodeTemplateDigitaloceanConfig>;

Digitalocean config for the Node Template (list maxitems:1)

property driver

driver?: pulumi.Input<string>;

(Computed) The driver of the node template (string)

property driverId

driverId?: pulumi.Input<string>;

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

property engineEnv

engineEnv?: pulumi.Input<{[key: string]: any}>;

Engine environment for the node template (string)

property engineInsecureRegistries

engineInsecureRegistries?: pulumi.Input<pulumi.Input<string>[]>;

Insecure registry for the node template (list)

property engineInstallUrl

engineInstallUrl?: pulumi.Input<string>;

property engineLabel

engineLabel?: pulumi.Input<{[key: string]: any}>;

Engine label for the node template (string)

property engineOpt

engineOpt?: pulumi.Input<{[key: string]: any}>;

Engine options for the node template (map)

property engineRegistryMirrors

engineRegistryMirrors?: pulumi.Input<pulumi.Input<string>[]>;

Engine registry mirror for the node template (list)

property engineStorageDriver

engineStorageDriver?: pulumi.Input<string>;

Engine storage driver for the node template (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Template object (map)

property linodeConfig

linodeConfig?: pulumi.Input<NodeTemplateLinodeConfig>;

Linode config for the Node Template (list maxitems:1)

property name

name?: pulumi.Input<string>;

The name of the Node Template (string)

property opennebulaConfig

opennebulaConfig?: pulumi.Input<NodeTemplateOpennebulaConfig>;

Opennebula config for the Node Template (list maxitems:1)

property openstackConfig

openstackConfig?: pulumi.Input<NodeTemplateOpenstackConfig>;

Openstack config for the Node Template (list maxitems:1)

property useInternalIpAddress

useInternalIpAddress?: pulumi.Input<boolean>;

Engine storage driver for the node template (bool)

property vsphereConfig

vsphereConfig?: pulumi.Input<NodeTemplateVsphereConfig>;

vSphere config for the Node Template (list maxitems:1)

interface NotifierArgs

interface NotifierArgs

The set of arguments for constructing a Notifier resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for notifier object (map)

property clusterId

clusterId: pulumi.Input<string>;

The cluster id where create notifier (string)

property description

description?: pulumi.Input<string>;

The notifier description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for notifier object (map)

property name

name?: pulumi.Input<string>;

The name of the notifier (string)

property pagerdutyConfig

pagerdutyConfig?: pulumi.Input<NotifierPagerdutyConfig>;

Pagerduty config for notifier (list maxitems:1)

property sendResolved

sendResolved?: pulumi.Input<boolean>;

= (Optional) Enable the notifier to send resolved notifications. Default false (bool)

property slackConfig

slackConfig?: pulumi.Input<NotifierSlackConfig>;

Slack config for notifier (list maxitems:1)

property smtpConfig

smtpConfig?: pulumi.Input<NotifierSmtpConfig>;

SMTP config for notifier (list maxitems:1)

property webhookConfig

webhookConfig?: pulumi.Input<NotifierWebhookConfig>;

Webhook config for notifier (list maxitems:1)

property wechatConfig

wechatConfig?: pulumi.Input<NotifierWechatConfig>;

Wechat config for notifier (list maxitems:1)

interface NotifierState

interface NotifierState

Input properties used for looking up and filtering Notifier resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for notifier object (map)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id where create notifier (string)

property description

description?: pulumi.Input<string>;

The notifier description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for notifier object (map)

property name

name?: pulumi.Input<string>;

The name of the notifier (string)

property pagerdutyConfig

pagerdutyConfig?: pulumi.Input<NotifierPagerdutyConfig>;

Pagerduty config for notifier (list maxitems:1)

property sendResolved

sendResolved?: pulumi.Input<boolean>;

= (Optional) Enable the notifier to send resolved notifications. Default false (bool)

property slackConfig

slackConfig?: pulumi.Input<NotifierSlackConfig>;

Slack config for notifier (list maxitems:1)

property smtpConfig

smtpConfig?: pulumi.Input<NotifierSmtpConfig>;

SMTP config for notifier (list maxitems:1)

property webhookConfig

webhookConfig?: pulumi.Input<NotifierWebhookConfig>;

Webhook config for notifier (list maxitems:1)

property wechatConfig

wechatConfig?: pulumi.Input<NotifierWechatConfig>;

Wechat config for notifier (list maxitems:1)

interface PodSecurityPolicyTemplateArgs

interface PodSecurityPolicyTemplateArgs

The set of arguments for constructing a PodSecurityPolicyTemplate resource.

property allowPrivilegeEscalation

allowPrivilegeEscalation?: pulumi.Input<boolean>;

= (Optional)

property allowedCapabilities

allowedCapabilities?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property allowedCsiDrivers

allowedCsiDrivers?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateAllowedCsiDriver>[]>;

(list)

property allowedFlexVolumes

allowedFlexVolumes?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateAllowedFlexVolume>[]>;

(list)

property allowedHostPaths

allowedHostPaths?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateAllowedHostPath>[]>;

(list)

property allowedProcMountTypes

allowedProcMountTypes?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property allowedUnsafeSysctls

allowedUnsafeSysctls?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for PodSecurityPolicyTemplate object (map)

property defaultAddCapabilities

defaultAddCapabilities?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property defaultAllowPrivilegeEscalation

defaultAllowPrivilegeEscalation?: pulumi.Input<boolean>;

(list)

property description

description?: pulumi.Input<string>;

The PodSecurityPolicyTemplate description (string)

property forbiddenSysctls

forbiddenSysctls?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property fsGroup

fsGroup?: pulumi.Input<PodSecurityPolicyTemplateFsGroup>;

(list maxitems:1)

property hostIpc

hostIpc?: pulumi.Input<boolean>;

(bool)

property hostNetwork

hostNetwork?: pulumi.Input<boolean>;

hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.

property hostPid

hostPid?: pulumi.Input<boolean>;

(bool)

property hostPorts

hostPorts?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateHostPort>[]>;

(list)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for PodSecurityPolicyTemplate object (map)

property name

name?: pulumi.Input<string>;

The name of the PodSecurityPolicyTemplate (string)

property privileged

privileged?: pulumi.Input<boolean>;

(bool)

property readOnlyRootFilesystem

readOnlyRootFilesystem?: pulumi.Input<boolean>;

(bool)

property requiredDropCapabilities

requiredDropCapabilities?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property runAsGroup

runAsGroup?: pulumi.Input<PodSecurityPolicyTemplateRunAsGroup>;

(list maxitems:1)

property runAsUser

runAsUser?: pulumi.Input<PodSecurityPolicyTemplateRunAsUser>;

(list maxitems:1)

property runtimeClass

runtimeClass?: pulumi.Input<PodSecurityPolicyTemplateRuntimeClass>;

(list maxitems:1)

property seLinux

seLinux?: pulumi.Input<PodSecurityPolicyTemplateSeLinux>;

(list maxitems:1)

property supplementalGroup

supplementalGroup?: pulumi.Input<PodSecurityPolicyTemplateSupplementalGroup>;

(list maxitems:1)

property volumes

volumes?: pulumi.Input<pulumi.Input<string>[]>;

(list)

interface PodSecurityPolicyTemplateState

interface PodSecurityPolicyTemplateState

Input properties used for looking up and filtering PodSecurityPolicyTemplate resources.

property allowPrivilegeEscalation

allowPrivilegeEscalation?: pulumi.Input<boolean>;

= (Optional)

property allowedCapabilities

allowedCapabilities?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property allowedCsiDrivers

allowedCsiDrivers?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateAllowedCsiDriver>[]>;

(list)

property allowedFlexVolumes

allowedFlexVolumes?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateAllowedFlexVolume>[]>;

(list)

property allowedHostPaths

allowedHostPaths?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateAllowedHostPath>[]>;

(list)

property allowedProcMountTypes

allowedProcMountTypes?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property allowedUnsafeSysctls

allowedUnsafeSysctls?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for PodSecurityPolicyTemplate object (map)

property defaultAddCapabilities

defaultAddCapabilities?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property defaultAllowPrivilegeEscalation

defaultAllowPrivilegeEscalation?: pulumi.Input<boolean>;

(list)

property description

description?: pulumi.Input<string>;

The PodSecurityPolicyTemplate description (string)

property forbiddenSysctls

forbiddenSysctls?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property fsGroup

fsGroup?: pulumi.Input<PodSecurityPolicyTemplateFsGroup>;

(list maxitems:1)

property hostIpc

hostIpc?: pulumi.Input<boolean>;

(bool)

property hostNetwork

hostNetwork?: pulumi.Input<boolean>;

hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.

property hostPid

hostPid?: pulumi.Input<boolean>;

(bool)

property hostPorts

hostPorts?: pulumi.Input<pulumi.Input<PodSecurityPolicyTemplateHostPort>[]>;

(list)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for PodSecurityPolicyTemplate object (map)

property name

name?: pulumi.Input<string>;

The name of the PodSecurityPolicyTemplate (string)

property privileged

privileged?: pulumi.Input<boolean>;

(bool)

property readOnlyRootFilesystem

readOnlyRootFilesystem?: pulumi.Input<boolean>;

(bool)

property requiredDropCapabilities

requiredDropCapabilities?: pulumi.Input<pulumi.Input<string>[]>;

(list)

property runAsGroup

runAsGroup?: pulumi.Input<PodSecurityPolicyTemplateRunAsGroup>;

(list maxitems:1)

property runAsUser

runAsUser?: pulumi.Input<PodSecurityPolicyTemplateRunAsUser>;

(list maxitems:1)

property runtimeClass

runtimeClass?: pulumi.Input<PodSecurityPolicyTemplateRuntimeClass>;

(list maxitems:1)

property seLinux

seLinux?: pulumi.Input<PodSecurityPolicyTemplateSeLinux>;

(list maxitems:1)

property supplementalGroup

supplementalGroup?: pulumi.Input<PodSecurityPolicyTemplateSupplementalGroup>;

(list maxitems:1)

property volumes

volumes?: pulumi.Input<pulumi.Input<string>[]>;

(list)

interface ProjectAlertGroupArgs

interface ProjectAlertGroupArgs

The set of arguments for constructing a ProjectAlertGroup resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The project alert group annotations (map)

property description

description?: pulumi.Input<string>;

The project alert group description (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The project alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The project alert group wait seconds. Default: 180 (int)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The project alert group labels (map)

property name

name?: pulumi.Input<string>;

The project alert group name (string)

property projectId

projectId: pulumi.Input<string>;

The project id where create project alert group (string)

property recipients

recipients?: pulumi.Input<pulumi.Input<ProjectAlertGroupRecipient>[]>;

The project alert group recipients (list)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The project alert group wait seconds. Default: 3600 (int)

interface ProjectAlertGroupState

interface ProjectAlertGroupState

Input properties used for looking up and filtering ProjectAlertGroup resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The project alert group annotations (map)

property description

description?: pulumi.Input<string>;

The project alert group description (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The project alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The project alert group wait seconds. Default: 180 (int)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The project alert group labels (map)

property name

name?: pulumi.Input<string>;

The project alert group name (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where create project alert group (string)

property recipients

recipients?: pulumi.Input<pulumi.Input<ProjectAlertGroupRecipient>[]>;

The project alert group recipients (list)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The project alert group wait seconds. Default: 3600 (int)

interface ProjectAlertRuleArgs

interface ProjectAlertRuleArgs

The set of arguments for constructing a ProjectAlertRule resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The project alert rule annotations (map)

property groupId

groupId: pulumi.Input<string>;

The project alert rule alert group ID (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The project alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The project alert rule group wait seconds. Default: 180 (int)

property inherited

inherited?: pulumi.Input<boolean>;

The project alert rule inherited. Default: true (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The project alert rule labels (map)

property metricRule

metricRule?: pulumi.Input<ProjectAlertRuleMetricRule>;

The project alert rule metric rule. ConflictsWith: "podRule", "workloadRule"` (list Maxitems:1)

property name

name?: pulumi.Input<string>;

The project alert rule name (string)

property podRule

podRule?: pulumi.Input<ProjectAlertRulePodRule>;

The project alert rule pod rule. ConflictsWith: "metricRule", "workloadRule"` (list Maxitems:1)

property projectId

projectId: pulumi.Input<string>;

The project id where create project alert rule (string)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The project alert rule wait seconds. Default: 3600 (int)

property severity

severity?: pulumi.Input<string>;

The project alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property workloadRule

workloadRule?: pulumi.Input<ProjectAlertRuleWorkloadRule>;

The project alert rule workload rule. ConflictsWith: "metricRule", "podRule"` (list Maxitems:1)

interface ProjectAlertRuleState

interface ProjectAlertRuleState

Input properties used for looking up and filtering ProjectAlertRule resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

The project alert rule annotations (map)

property groupId

groupId?: pulumi.Input<string>;

The project alert rule alert group ID (string)

property groupIntervalSeconds

groupIntervalSeconds?: pulumi.Input<number>;

The project alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

groupWaitSeconds?: pulumi.Input<number>;

The project alert rule group wait seconds. Default: 180 (int)

property inherited

inherited?: pulumi.Input<boolean>;

The project alert rule inherited. Default: true (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

The project alert rule labels (map)

property metricRule

metricRule?: pulumi.Input<ProjectAlertRuleMetricRule>;

The project alert rule metric rule. ConflictsWith: "podRule", "workloadRule"` (list Maxitems:1)

property name

name?: pulumi.Input<string>;

The project alert rule name (string)

property podRule

podRule?: pulumi.Input<ProjectAlertRulePodRule>;

The project alert rule pod rule. ConflictsWith: "metricRule", "workloadRule"` (list Maxitems:1)

property projectId

projectId?: pulumi.Input<string>;

The project id where create project alert rule (string)

property repeatIntervalSeconds

repeatIntervalSeconds?: pulumi.Input<number>;

The project alert rule wait seconds. Default: 3600 (int)

property severity

severity?: pulumi.Input<string>;

The project alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property workloadRule

workloadRule?: pulumi.Input<ProjectAlertRuleWorkloadRule>;

The project alert rule workload rule. ConflictsWith: "metricRule", "podRule"` (list Maxitems:1)

interface ProjectArgs

interface ProjectArgs

The set of arguments for constructing a Project resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Pool object (map)

property clusterId

clusterId: pulumi.Input<string>;

The cluster id where create project (string)

property containerResourceLimit

containerResourceLimit?: pulumi.Input<ProjectContainerResourceLimit>;

Default containers resource limits on project (List maxitem:1)

property description

description?: pulumi.Input<string>;

A project description (string)

property enableProjectMonitoring

enableProjectMonitoring?: pulumi.Input<boolean>;

Enable built-in project monitoring. Default false (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

name?: pulumi.Input<string>;

The name of the project (string)

property podSecurityPolicyTemplateId

podSecurityPolicyTemplateId?: pulumi.Input<string>;

Default Pod Security Policy ID for the project (string)

property projectMonitoringInput

projectMonitoringInput?: pulumi.Input<ProjectProjectMonitoringInput>;

Project monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property resourceQuota

resourceQuota?: pulumi.Input<ProjectResourceQuota>;

Resource quota for project. Rancher v2.1.x or higher (list maxitems:1)

property waitForCluster

waitForCluster?: pulumi.Input<boolean>;

Wait for cluster becomes active. Default false (bool)

interface ProjectLoggingArgs

interface ProjectLoggingArgs

The set of arguments for constructing a ProjectLogging resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Project Logging object (map)

property customTargetConfig

customTargetConfig?: pulumi.Input<ProjectLoggingCustomTargetConfig>;

The custom target config for Cluster Logging. For kind = custom. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property elasticsearchConfig

elasticsearchConfig?: pulumi.Input<ProjectLoggingElasticsearchConfig>;

The elasticsearch config for Project Logging. For kind = elasticsearch. Conflicts with customTargetConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property enableJsonParsing

enableJsonParsing?: pulumi.Input<boolean>;

Enable json log parsing. Default: false (bool)

property fluentdConfig

fluentdConfig?: pulumi.Input<ProjectLoggingFluentdConfig>;

The fluentd config for Project Logging. For kind = fluentd. Conflicts with customTargetConfig, elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property kafkaConfig

kafkaConfig?: pulumi.Input<ProjectLoggingKafkaConfig>;

The kafka config for Project Logging. For kind = kafka. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

kind: pulumi.Input<string>;

The kind of the Project Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Project Logging object (map)

property name

name?: pulumi.Input<string>;

The name of the Project Logging config (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id from Project logging (string)

property outputFlushInterval

outputFlushInterval?: pulumi.Input<number>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

outputTags?: pulumi.Input<{[key: string]: any}>;

The output tags for Project Logging (map)

property projectId

projectId: pulumi.Input<string>;

The project id to configure logging (string)

property splunkConfig

splunkConfig?: pulumi.Input<ProjectLoggingSplunkConfig>;

The splunk config for Project Logging. For kind = splunk. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

syslogConfig?: pulumi.Input<ProjectLoggingSyslogConfig>;

The syslog config for Project Logging. For kind = syslog. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

interface ProjectLoggingState

interface ProjectLoggingState

Input properties used for looking up and filtering ProjectLogging resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Project Logging object (map)

property customTargetConfig

customTargetConfig?: pulumi.Input<ProjectLoggingCustomTargetConfig>;

The custom target config for Cluster Logging. For kind = custom. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property elasticsearchConfig

elasticsearchConfig?: pulumi.Input<ProjectLoggingElasticsearchConfig>;

The elasticsearch config for Project Logging. For kind = elasticsearch. Conflicts with customTargetConfig, fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property enableJsonParsing

enableJsonParsing?: pulumi.Input<boolean>;

Enable json log parsing. Default: false (bool)

property fluentdConfig

fluentdConfig?: pulumi.Input<ProjectLoggingFluentdConfig>;

The fluentd config for Project Logging. For kind = fluentd. Conflicts with customTargetConfig, elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property kafkaConfig

kafkaConfig?: pulumi.Input<ProjectLoggingKafkaConfig>;

The kafka config for Project Logging. For kind = kafka. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

kind?: pulumi.Input<string>;

The kind of the Project Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Project Logging object (map)

property name

name?: pulumi.Input<string>;

The name of the Project Logging config (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id from Project logging (string)

property outputFlushInterval

outputFlushInterval?: pulumi.Input<number>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

outputTags?: pulumi.Input<{[key: string]: any}>;

The output tags for Project Logging (map)

property projectId

projectId?: pulumi.Input<string>;

The project id to configure logging (string)

property splunkConfig

splunkConfig?: pulumi.Input<ProjectLoggingSplunkConfig>;

The splunk config for Project Logging. For kind = splunk. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

syslogConfig?: pulumi.Input<ProjectLoggingSyslogConfig>;

The syslog config for Project Logging. For kind = syslog. Conflicts with customTargetConfig, elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

interface ProjectRoleTemplateBindingArgs

interface ProjectRoleTemplateBindingArgs

The set of arguments for constructing a ProjectRoleTemplateBinding resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property groupId

groupId?: pulumi.Input<string>;

The group ID to assign project role template binding (string)

property groupPrincipalId

groupPrincipalId?: pulumi.Input<string>;

The groupPrincipal ID to assign project role template binding (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

The name of the project role template binding (string)

property projectId

projectId: pulumi.Input<string>;

The project id where bind project role template (string)

property roleTemplateId

roleTemplateId: pulumi.Input<string>;

The role template id from create project role template binding (string)

property userId

userId?: pulumi.Input<string>;

The user ID to assign project role template binding (string)

property userPrincipalId

userPrincipalId?: pulumi.Input<string>;

The userPrincipal ID to assign project role template binding (string)

interface ProjectRoleTemplateBindingState

interface ProjectRoleTemplateBindingState

Input properties used for looking up and filtering ProjectRoleTemplateBinding resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property groupId

groupId?: pulumi.Input<string>;

The group ID to assign project role template binding (string)

property groupPrincipalId

groupPrincipalId?: pulumi.Input<string>;

The groupPrincipal ID to assign project role template binding (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

The name of the project role template binding (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where bind project role template (string)

property roleTemplateId

roleTemplateId?: pulumi.Input<string>;

The role template id from create project role template binding (string)

property userId

userId?: pulumi.Input<string>;

The user ID to assign project role template binding (string)

property userPrincipalId

userPrincipalId?: pulumi.Input<string>;

The userPrincipal ID to assign project role template binding (string)

interface ProjectState

interface ProjectState

Input properties used for looking up and filtering Project resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Node Pool object (map)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id where create project (string)

property containerResourceLimit

containerResourceLimit?: pulumi.Input<ProjectContainerResourceLimit>;

Default containers resource limits on project (List maxitem:1)

property description

description?: pulumi.Input<string>;

A project description (string)

property enableProjectMonitoring

enableProjectMonitoring?: pulumi.Input<boolean>;

Enable built-in project monitoring. Default false (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

name?: pulumi.Input<string>;

The name of the project (string)

property podSecurityPolicyTemplateId

podSecurityPolicyTemplateId?: pulumi.Input<string>;

Default Pod Security Policy ID for the project (string)

property projectMonitoringInput

projectMonitoringInput?: pulumi.Input<ProjectProjectMonitoringInput>;

Project monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property resourceQuota

resourceQuota?: pulumi.Input<ProjectResourceQuota>;

Resource quota for project. Rancher v2.1.x or higher (list maxitems:1)

property waitForCluster

waitForCluster?: pulumi.Input<boolean>;

Wait for cluster becomes active. Default false (bool)

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property accessKey

accessKey?: pulumi.Input<string>;

API Key used to authenticate with the rancher server

property apiUrl

apiUrl?: pulumi.Input<string>;

The URL to the rancher API

property bootstrap

bootstrap?: pulumi.Input<boolean>;

Bootstrap rancher server

property caCerts

caCerts?: pulumi.Input<string>;

CA certificates used to sign rancher server tls certificates. Mandatory if self signed tls and insecure option false

property insecure

insecure?: pulumi.Input<boolean>;

Allow insecure connections to Rancher. Mandatory if self signed tls and not ca_certs provided

property retries

retries?: pulumi.Input<number>;

Rancher connection retries

property secretKey

secretKey?: pulumi.Input<string>;

API secret used to authenticate with the rancher server

property tokenKey

tokenKey?: pulumi.Input<string>;

API token used to authenticate with the rancher server

interface RegistryArgs

interface RegistryArgs

The set of arguments for constructing a Registry resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Registry object (map)

property description

description?: pulumi.Input<string>;

A registry description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Registry object (map)

property name

name?: pulumi.Input<string>;

The name of the registry (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id where to assign the namespaced registry (string)

property projectId

projectId: pulumi.Input<string>;

The project id where to assign the registry (string)

property registries

registries: pulumi.Input<pulumi.Input<RegistryRegistry>[]>;

Registries data for registry (list)

interface RegistryState

interface RegistryState

Input properties used for looking up and filtering Registry resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for Registry object (map)

property description

description?: pulumi.Input<string>;

A registry description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for Registry object (map)

property name

name?: pulumi.Input<string>;

The name of the registry (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id where to assign the namespaced registry (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where to assign the registry (string)

property registries

registries?: pulumi.Input<pulumi.Input<RegistryRegistry>[]>;

Registries data for registry (list)

interface RoleTempalteArgs

interface RoleTempalteArgs

The set of arguments for constructing a RoleTempalte resource.

property administrative

administrative?: pulumi.Input<boolean>;

Administrative role template. Default false (bool)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for role template object (map)

property context

context?: pulumi.Input<string>;

Role template context. cluster and project values are supported. Default: cluster (string)

property defaultRole

defaultRole?: pulumi.Input<boolean>;

Default role template for new created cluster or project. Default false (bool)

property description

description?: pulumi.Input<string>;

Role template description (string)

property external

external?: pulumi.Input<boolean>;

External role template. Default false (bool)

property hidden

hidden?: pulumi.Input<boolean>;

Hidden role template. Default false (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for role template object (map)

property locked

locked?: pulumi.Input<boolean>;

Locked role template. Default false (bool)

property name

name?: pulumi.Input<string>;

Role template name (string)

property roleTemplateIds

roleTemplateIds?: pulumi.Input<pulumi.Input<string>[]>;

Inherit role template IDs (list)

property rules

rules?: pulumi.Input<pulumi.Input<RoleTempalteRule>[]>;

Role template policy rules (list)

interface RoleTempalteState

interface RoleTempalteState

Input properties used for looking up and filtering RoleTempalte resources.

property administrative

administrative?: pulumi.Input<boolean>;

Administrative role template. Default false (bool)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for role template object (map)

property builtin

builtin?: pulumi.Input<boolean>;

(Computed) Builtin role template (string)

property context

context?: pulumi.Input<string>;

Role template context. cluster and project values are supported. Default: cluster (string)

property defaultRole

defaultRole?: pulumi.Input<boolean>;

Default role template for new created cluster or project. Default false (bool)

property description

description?: pulumi.Input<string>;

Role template description (string)

property external

external?: pulumi.Input<boolean>;

External role template. Default false (bool)

property hidden

hidden?: pulumi.Input<boolean>;

Hidden role template. Default false (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for role template object (map)

property locked

locked?: pulumi.Input<boolean>;

Locked role template. Default false (bool)

property name

name?: pulumi.Input<string>;

Role template name (string)

property roleTemplateIds

roleTemplateIds?: pulumi.Input<pulumi.Input<string>[]>;

Inherit role template IDs (list)

property rules

rules?: pulumi.Input<pulumi.Input<RoleTempalteRule>[]>;

Role template policy rules (list)

interface SecretArgs

interface SecretArgs

The set of arguments for constructing a Secret resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for secret object (map)

property data

data: pulumi.Input<{[key: string]: any}>;

Secret key/value data. Base64 encoding required for values (map)

property description

description?: pulumi.Input<string>;

A secret description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for secret object (map)

property name

name?: pulumi.Input<string>;

The name of the secret (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id where to assign the namespaced secret (string)

property projectId

projectId: pulumi.Input<string>;

The project id where to assign the secret (string)

interface SecretState

interface SecretState

Input properties used for looking up and filtering Secret resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for secret object (map)

property data

data?: pulumi.Input<{[key: string]: any}>;

Secret key/value data. Base64 encoding required for values (map)

property description

description?: pulumi.Input<string>;

A secret description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for secret object (map)

property name

name?: pulumi.Input<string>;

The name of the secret (string)

property namespaceId

namespaceId?: pulumi.Input<string>;

The namespace id where to assign the namespaced secret (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where to assign the secret (string)

interface SettingArgs

interface SettingArgs

The set of arguments for constructing a Setting resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for setting object (map)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for setting object (map)

property name

name?: pulumi.Input<string>;

The name of the setting (string)

property value

value: pulumi.Input<string>;

The value of the setting (string)

interface SettingState

interface SettingState

Input properties used for looking up and filtering Setting resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for setting object (map)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for setting object (map)

property name

name?: pulumi.Input<string>;

The name of the setting (string)

property value

value?: pulumi.Input<string>;

The value of the setting (string)

interface TokenArgs

interface TokenArgs

The set of arguments for constructing a Token resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the token (map)

property clusterId

clusterId?: pulumi.Input<string>;

Cluster ID for scoped token (string)

property description

description?: pulumi.Input<string>;

Token description (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the token (map)

property renew

renew?: pulumi.Input<boolean>;

Renew expired or disabled token

property ttl

ttl?: pulumi.Input<number>;

Token time to live in seconds. Default 0 (int)

interface TokenState

interface TokenState

Input properties used for looking up and filtering Token resources.

property accessKey

accessKey?: pulumi.Input<string>;

(Computed) Token access key part (string)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the token (map)

property clusterId

clusterId?: pulumi.Input<string>;

Cluster ID for scoped token (string)

property description

description?: pulumi.Input<string>;

Token description (string)

property enabled

enabled?: pulumi.Input<boolean>;

(Computed) Token is enabled (bool)

property expired

expired?: pulumi.Input<boolean>;

(Computed) Token is expired (bool)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the token (map)

property name

name?: pulumi.Input<string>;

(Computed) Token name (string)

property renew

renew?: pulumi.Input<boolean>;

Renew expired or disabled token

property secretKey

secretKey?: pulumi.Input<string>;

(Computed/Sensitive) Token secret key part (string)

property token

token?: pulumi.Input<string>;

(Computed/Sensitive) Token value (string)

property ttl

ttl?: pulumi.Input<number>;

Token time to live in seconds. Default 0 (int)

property userId

userId?: pulumi.Input<string>;

(Computed) Token user ID (string)

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for global role binding (map)

property enabled

enabled?: pulumi.Input<boolean>;

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for global role binding (map)

property name

name?: pulumi.Input<string>;

The user full name (string)

property password

password: pulumi.Input<string>;

The user password (string)

property username

username: pulumi.Input<string>;

The user username (string)

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for global role binding (map)

property enabled

enabled?: pulumi.Input<boolean>;

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for global role binding (map)

property name

name?: pulumi.Input<string>;

The user full name (string)

property password

password?: pulumi.Input<string>;

The user password (string)

property principalIds

principalIds?: pulumi.Input<pulumi.Input<string>[]>;

(Computed) The user principal IDs (list)

property username

username?: pulumi.Input<string>;

The user username (string)

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Package @pulumi/rancher2

Modules

Resources

Functions

Others

Resources

Example Usage

Example Usage