@pulumi/nomad
Version:
A Pulumi package for creating and managing nomad cloud resources.
181 lines (180 loc) • 6.67 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Manages an ACL Auth Method in Nomad.
*
* ## Example Usage
*
* Creating an ALC Auth Method:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as nomad from "@pulumi/nomad";
*
* const myNomadAclAuthMethod = new nomad.AclAuthMethod("my_nomad_acl_auth_method", {
* name: "my-nomad-acl-auth-method",
* type: "OIDC",
* tokenLocality: "global",
* maxTokenTtl: "10m0s",
* tokenNameFormat: `${auth_method_type}-${value.user}`,
* "default": true,
* config: {
* oidcDiscoveryUrl: "https://uk.auth0.com/",
* oidcClientId: "someclientid",
* oidcClientSecret: "someclientsecret-t",
* boundAudiences: ["someclientid"],
* allowedRedirectUris: [
* "http://localhost:4649/oidc/callback",
* "http://localhost:4646/ui/settings/tokens",
* ],
* listClaimMappings: {
* "http://nomad.internal/roles": "roles",
* },
* },
* });
* ```
*/
export declare class AclAuthMethod extends pulumi.CustomResource {
/**
* Get an existing AclAuthMethod 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<pulumi.ID>, state?: AclAuthMethodState, opts?: pulumi.CustomResourceOptions): AclAuthMethod;
/**
* Returns true if the given object is an instance of AclAuthMethod. 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 AclAuthMethod;
/**
* `(block: <required>)` - Configuration specific to the auth method
* provider.
*/
readonly config: pulumi.Output<outputs.AclAuthMethodConfig>;
/**
* `(bool: false)` - Defines whether this ACL Auth Method is to be set
* as default.
*/
readonly default: pulumi.Output<boolean | undefined>;
/**
* `(string: <required>)` - Defines the maximum life of a token
* created by this method and is specified as a time duration such as "15h".
*/
readonly maxTokenTtl: pulumi.Output<string>;
/**
* `(string: <required>)` - The identifier of the ACL Auth Method.
*/
readonly name: pulumi.Output<string>;
/**
* `(string: <required>)` - Defines whether the ACL Auth Method
* creates a local or global token when performing SSO login. This field must be
* set to either `local` or `global`.
*/
readonly tokenLocality: pulumi.Output<string>;
/**
* `(string: "${auth_method_type}-${auth_method_name}")` -
* Defines the token name format for the generated tokens This can be lightly
* templated using HIL '${foo}' syntax.
*/
readonly tokenNameFormat: pulumi.Output<string | undefined>;
/**
* `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
* are `OIDC` and `JWT`.
*/
readonly type: pulumi.Output<string>;
/**
* Create a AclAuthMethod 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: AclAuthMethodArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AclAuthMethod resources.
*/
export interface AclAuthMethodState {
/**
* `(block: <required>)` - Configuration specific to the auth method
* provider.
*/
config?: pulumi.Input<inputs.AclAuthMethodConfig>;
/**
* `(bool: false)` - Defines whether this ACL Auth Method is to be set
* as default.
*/
default?: pulumi.Input<boolean>;
/**
* `(string: <required>)` - Defines the maximum life of a token
* created by this method and is specified as a time duration such as "15h".
*/
maxTokenTtl?: pulumi.Input<string>;
/**
* `(string: <required>)` - The identifier of the ACL Auth Method.
*/
name?: pulumi.Input<string>;
/**
* `(string: <required>)` - Defines whether the ACL Auth Method
* creates a local or global token when performing SSO login. This field must be
* set to either `local` or `global`.
*/
tokenLocality?: pulumi.Input<string>;
/**
* `(string: "${auth_method_type}-${auth_method_name}")` -
* Defines the token name format for the generated tokens This can be lightly
* templated using HIL '${foo}' syntax.
*/
tokenNameFormat?: pulumi.Input<string>;
/**
* `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
* are `OIDC` and `JWT`.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AclAuthMethod resource.
*/
export interface AclAuthMethodArgs {
/**
* `(block: <required>)` - Configuration specific to the auth method
* provider.
*/
config: pulumi.Input<inputs.AclAuthMethodConfig>;
/**
* `(bool: false)` - Defines whether this ACL Auth Method is to be set
* as default.
*/
default?: pulumi.Input<boolean>;
/**
* `(string: <required>)` - Defines the maximum life of a token
* created by this method and is specified as a time duration such as "15h".
*/
maxTokenTtl: pulumi.Input<string>;
/**
* `(string: <required>)` - The identifier of the ACL Auth Method.
*/
name?: pulumi.Input<string>;
/**
* `(string: <required>)` - Defines whether the ACL Auth Method
* creates a local or global token when performing SSO login. This field must be
* set to either `local` or `global`.
*/
tokenLocality: pulumi.Input<string>;
/**
* `(string: "${auth_method_type}-${auth_method_name}")` -
* Defines the token name format for the generated tokens This can be lightly
* templated using HIL '${foo}' syntax.
*/
tokenNameFormat?: pulumi.Input<string>;
/**
* `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
* are `OIDC` and `JWT`.
*/
type: pulumi.Input<string>;
}