@pulumi/vault/identity/oidcKey.d.ts

A Pulumi package for creating and managing HashiCorp Vault cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as vault from "@pulumi/vault";
 *
 * const key = new vault.identity.OidcKey("key", {
 *     name: "key",
 *     algorithm: "RS256",
 * });
 * const role = new vault.identity.OidcRole("role", {
 *     name: "role",
 *     key: key.name,
 * });
 * const roleOidcKeyAllowedClientID = new vault.identity.OidcKeyAllowedClientID("role", {
 *     keyName: key.name,
 *     allowedClientId: role.clientId,
 * });
 * ```
 *
 * ## Import
 *
 * The key can be imported with the key name, for example:
 *
 * ```sh
 * $ pulumi import vault:identity/oidcKey:OidcKey key key
 * ```
 */
export declare class OidcKey extends pulumi.CustomResource {
    /**
     * Get an existing OidcKey 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?: OidcKeyState, opts?: pulumi.CustomResourceOptions): OidcKey;
    /**
     * Returns true if the given object is an instance of OidcKey.  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 OidcKey;
    /**
     * Signing algorithm to use. Signing algorithm to use.
     * Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
     */
    readonly algorithm: pulumi.Output<string | undefined>;
    /**
     * Array of role client ID allowed to use this key for signing. If
     * empty, no roles are allowed. If `["*"]`, all roles are allowed.
     */
    readonly allowedClientIds: pulumi.Output<string[]>;
    /**
     * Name of the OIDC Key to create.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The namespace to provision the resource in.
     * The value should not contain leading or trailing forward slashes.
     * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    readonly namespace: pulumi.Output<string | undefined>;
    /**
     * How often to generate a new signing key in number of seconds
     */
    readonly rotationPeriod: pulumi.Output<number | undefined>;
    /**
     * "Controls how long the public portion of a signing key will be
     * available for verification after being rotated in seconds.
     */
    readonly verificationTtl: pulumi.Output<number | undefined>;
    /**
     * Create a OidcKey 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?: OidcKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OidcKey resources.
 */
export interface OidcKeyState {
    /**
     * Signing algorithm to use. Signing algorithm to use.
     * Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
     */
    algorithm?: pulumi.Input<string>;
    /**
     * Array of role client ID allowed to use this key for signing. If
     * empty, no roles are allowed. If `["*"]`, all roles are allowed.
     */
    allowedClientIds?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Name of the OIDC Key to create.
     */
    name?: pulumi.Input<string>;
    /**
     * The namespace to provision the resource in.
     * The value should not contain leading or trailing forward slashes.
     * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    namespace?: pulumi.Input<string>;
    /**
     * How often to generate a new signing key in number of seconds
     */
    rotationPeriod?: pulumi.Input<number>;
    /**
     * "Controls how long the public portion of a signing key will be
     * available for verification after being rotated in seconds.
     */
    verificationTtl?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a OidcKey resource.
 */
export interface OidcKeyArgs {
    /**
     * Signing algorithm to use. Signing algorithm to use.
     * Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
     */
    algorithm?: pulumi.Input<string>;
    /**
     * Array of role client ID allowed to use this key for signing. If
     * empty, no roles are allowed. If `["*"]`, all roles are allowed.
     */
    allowedClientIds?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Name of the OIDC Key to create.
     */
    name?: pulumi.Input<string>;
    /**
     * The namespace to provision the resource in.
     * The value should not contain leading or trailing forward slashes.
     * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    namespace?: pulumi.Input<string>;
    /**
     * How often to generate a new signing key in number of seconds
     */
    rotationPeriod?: pulumi.Input<number>;
    /**
     * "Controls how long the public portion of a signing key will be
     * available for verification after being rotated in seconds.
     */
    verificationTtl?: pulumi.Input<number>;
}