import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; export declare class Settings extends pulumi.CustomResource { /** * Get an existing Settings resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: SettingsState, opts?: pulumi.CustomResourceOptions): Settings; /** * Returns true if the given object is an instance of Settings. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Settings; /** * Authentication method used by Portainer. 1 = internal, 2 = LDAP, 3 = OAuth. */ readonly authenticationMethod: pulumi.Output; /** * List of container labels that Portainer should hide from the UI. */ readonly blackListedLabels: pulumi.Output; /** * Whether automatic synchronization of Kubernetes roles is disabled. */ readonly disableKubeRolesSync: pulumi.Output; /** * Whether the in-browser Kubernetes shell is disabled for users. */ readonly disableKubeShell: pulumi.Output; /** * Whether downloading kubeconfig files from the Portainer UI is disabled. */ readonly disableKubeconfigDownload: pulumi.Output; /** * Whether the donation header banner is shown in the Portainer UI. */ readonly displayDonationHeader: pulumi.Output; /** * Whether external contributors are displayed in the Portainer UI. */ readonly displayExternalContributors: pulumi.Output; /** * Heartbeat interval (in seconds) used by edge agents to poll Portainer. */ readonly edgeAgentCheckinInterval: pulumi.Output; /** * Public URL of the Portainer instance that edge agents use to reach back for polling and tunneling. */ readonly edgePortainerUrl: pulumi.Output; /** * Whether Edge Compute features (edge agents, edge stacks, edge jobs) are enabled. */ readonly enableEdgeComputeFeatures: pulumi.Output; /** * Whether anonymous usage telemetry is sent to Portainer. */ readonly enableTelemetry: pulumi.Output; /** * Whether Portainer enforces a matching edge identifier when an edge agent connects. */ readonly enforceEdgeId: pulumi.Output; /** * Global deployment options applied across environments. */ readonly globalDeploymentOptions: pulumi.Output; /** * Global Helm repository URL used by Portainer for chart browsing. */ readonly helmRepositoryUrl: pulumi.Output; /** * Settings for Portainer's internal authentication provider, such as the password policy. */ readonly internalAuthSettings: pulumi.Output; /** * Whether this Portainer instance runs as a Docker Desktop extension. */ readonly isDockerDesktopExtension: pulumi.Output; /** * Validity period of kubeconfig files generated for users (e.g. "24h", "0" for never). */ readonly kubeconfigExpiry: pulumi.Output; /** * Container image used for the in-browser kubectl shell. */ readonly kubectlShellImage: pulumi.Output; /** * Configuration for the LDAP authentication provider. */ readonly ldapSettings: pulumi.Output; /** * URL of a custom logo displayed in the Portainer UI. */ readonly logoUrl: pulumi.Output; /** * Configuration for the OAuth authentication provider. */ readonly oauthSettings: pulumi.Output; readonly settingsId: pulumi.Output; /** * Interval at which Portainer snapshots endpoints (e.g. "5m", "1h"). */ readonly snapshotInterval: pulumi.Output; /** * URL of the JSON file with application templates used by the Portainer UI. */ readonly templatesUrl: pulumi.Output; /** * Whether edge agents are automatically trusted on their first connection. */ readonly trustOnFirstConnect: pulumi.Output; /** * Duration after which an idle user session expires (e.g. "8h"). */ readonly userSessionTimeout: pulumi.Output; /** * Create a Settings resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: SettingsArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Settings resources. */ export interface SettingsState { /** * Authentication method used by Portainer. 1 = internal, 2 = LDAP, 3 = OAuth. */ authenticationMethod?: pulumi.Input; /** * List of container labels that Portainer should hide from the UI. */ blackListedLabels?: pulumi.Input[] | undefined>; /** * Whether automatic synchronization of Kubernetes roles is disabled. */ disableKubeRolesSync?: pulumi.Input; /** * Whether the in-browser Kubernetes shell is disabled for users. */ disableKubeShell?: pulumi.Input; /** * Whether downloading kubeconfig files from the Portainer UI is disabled. */ disableKubeconfigDownload?: pulumi.Input; /** * Whether the donation header banner is shown in the Portainer UI. */ displayDonationHeader?: pulumi.Input; /** * Whether external contributors are displayed in the Portainer UI. */ displayExternalContributors?: pulumi.Input; /** * Heartbeat interval (in seconds) used by edge agents to poll Portainer. */ edgeAgentCheckinInterval?: pulumi.Input; /** * Public URL of the Portainer instance that edge agents use to reach back for polling and tunneling. */ edgePortainerUrl?: pulumi.Input; /** * Whether Edge Compute features (edge agents, edge stacks, edge jobs) are enabled. */ enableEdgeComputeFeatures?: pulumi.Input; /** * Whether anonymous usage telemetry is sent to Portainer. */ enableTelemetry?: pulumi.Input; /** * Whether Portainer enforces a matching edge identifier when an edge agent connects. */ enforceEdgeId?: pulumi.Input; /** * Global deployment options applied across environments. */ globalDeploymentOptions?: pulumi.Input; /** * Global Helm repository URL used by Portainer for chart browsing. */ helmRepositoryUrl?: pulumi.Input; /** * Settings for Portainer's internal authentication provider, such as the password policy. */ internalAuthSettings?: pulumi.Input; /** * Whether this Portainer instance runs as a Docker Desktop extension. */ isDockerDesktopExtension?: pulumi.Input; /** * Validity period of kubeconfig files generated for users (e.g. "24h", "0" for never). */ kubeconfigExpiry?: pulumi.Input; /** * Container image used for the in-browser kubectl shell. */ kubectlShellImage?: pulumi.Input; /** * Configuration for the LDAP authentication provider. */ ldapSettings?: pulumi.Input; /** * URL of a custom logo displayed in the Portainer UI. */ logoUrl?: pulumi.Input; /** * Configuration for the OAuth authentication provider. */ oauthSettings?: pulumi.Input; settingsId?: pulumi.Input; /** * Interval at which Portainer snapshots endpoints (e.g. "5m", "1h"). */ snapshotInterval?: pulumi.Input; /** * URL of the JSON file with application templates used by the Portainer UI. */ templatesUrl?: pulumi.Input; /** * Whether edge agents are automatically trusted on their first connection. */ trustOnFirstConnect?: pulumi.Input; /** * Duration after which an idle user session expires (e.g. "8h"). */ userSessionTimeout?: pulumi.Input; } /** * The set of arguments for constructing a Settings resource. */ export interface SettingsArgs { /** * Authentication method used by Portainer. 1 = internal, 2 = LDAP, 3 = OAuth. */ authenticationMethod?: pulumi.Input; /** * List of container labels that Portainer should hide from the UI. */ blackListedLabels?: pulumi.Input[] | undefined>; /** * Whether automatic synchronization of Kubernetes roles is disabled. */ disableKubeRolesSync?: pulumi.Input; /** * Whether the in-browser Kubernetes shell is disabled for users. */ disableKubeShell?: pulumi.Input; /** * Whether downloading kubeconfig files from the Portainer UI is disabled. */ disableKubeconfigDownload?: pulumi.Input; /** * Whether the donation header banner is shown in the Portainer UI. */ displayDonationHeader?: pulumi.Input; /** * Whether external contributors are displayed in the Portainer UI. */ displayExternalContributors?: pulumi.Input; /** * Heartbeat interval (in seconds) used by edge agents to poll Portainer. */ edgeAgentCheckinInterval?: pulumi.Input; /** * Public URL of the Portainer instance that edge agents use to reach back for polling and tunneling. */ edgePortainerUrl?: pulumi.Input; /** * Whether Edge Compute features (edge agents, edge stacks, edge jobs) are enabled. */ enableEdgeComputeFeatures?: pulumi.Input; /** * Whether anonymous usage telemetry is sent to Portainer. */ enableTelemetry?: pulumi.Input; /** * Whether Portainer enforces a matching edge identifier when an edge agent connects. */ enforceEdgeId?: pulumi.Input; /** * Global deployment options applied across environments. */ globalDeploymentOptions?: pulumi.Input; /** * Global Helm repository URL used by Portainer for chart browsing. */ helmRepositoryUrl?: pulumi.Input; /** * Settings for Portainer's internal authentication provider, such as the password policy. */ internalAuthSettings?: pulumi.Input; /** * Whether this Portainer instance runs as a Docker Desktop extension. */ isDockerDesktopExtension?: pulumi.Input; /** * Validity period of kubeconfig files generated for users (e.g. "24h", "0" for never). */ kubeconfigExpiry?: pulumi.Input; /** * Container image used for the in-browser kubectl shell. */ kubectlShellImage?: pulumi.Input; /** * Configuration for the LDAP authentication provider. */ ldapSettings?: pulumi.Input; /** * URL of a custom logo displayed in the Portainer UI. */ logoUrl?: pulumi.Input; /** * Configuration for the OAuth authentication provider. */ oauthSettings?: pulumi.Input; settingsId?: pulumi.Input; /** * Interval at which Portainer snapshots endpoints (e.g. "5m", "1h"). */ snapshotInterval?: pulumi.Input; /** * URL of the JSON file with application templates used by the Portainer UI. */ templatesUrl?: pulumi.Input; /** * Whether edge agents are automatically trusted on their first connection. */ trustOnFirstConnect?: pulumi.Input; /** * Duration after which an idle user session expires (e.g. "8h"). */ userSessionTimeout?: pulumi.Input; } //# sourceMappingURL=settings.d.ts.map