@pulumi/databricks/accountFederationPolicy.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Account federation policies allow users and service principals in your Databricks account to securely access Databricks APIs using tokens from your trusted identity providers (IdPs).
 *
 * Token federation policies eliminate the need to manage Databricks secrets, and allow you to centralize management of token issuance policies in your IdP. Databricks token federation policies are typically used in combination with [SCIM](https://www.terraform.io/admin/users-groups/scim/index.html), so users in your IdP are synchronized into your Databricks account.
 *
 * An account federation policy specifies:
 * * which IdP, or issuer, your Databricks account should accept tokens from
 * * how to determine which Databricks user, or subject, a token is issued for
 *
 * ## Import
 *
 * As of Pulumi v1.5, resources can be imported through configuration.
 *
 * hcl
 *
 * import {
 *
 *   id = "policy_id"
 *
 *   to = databricks_account_federation_policy.this
 *
 * }
 *
 * If you are using an older version of Pulumi, import the resource using the `pulumi import` command as follows:
 *
 * ```sh
 * $ pulumi import databricks:index/accountFederationPolicy:AccountFederationPolicy databricks_account_federation_policy "policy_id"
 * ```
 */
export declare class AccountFederationPolicy extends pulumi.CustomResource {
    /**
     * Get an existing AccountFederationPolicy 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?: AccountFederationPolicyState, opts?: pulumi.CustomResourceOptions): AccountFederationPolicy;
    /**
     * Returns true if the given object is an instance of AccountFederationPolicy.  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 AccountFederationPolicy;
    /**
     * (string) - Creation time of the federation policy
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * Description of the federation policy
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * (string) - Resource name for the federation policy. Example values include
     * `accounts/<account-id>/federationPolicies/my-federation-policy` for Account Federation Policies, and
     * `accounts/<account-id>/servicePrincipals/<service-principal-id>/federationPolicies/my-federation-policy`
     * for Service Principal Federation Policies. Typically an output parameter, which does not need to be
     * specified in create or update requests. If specified in a request, must match the value in the
     * request URL
     */
    readonly name: pulumi.Output<string>;
    readonly oidcPolicy: pulumi.Output<outputs.AccountFederationPolicyOidcPolicy | undefined>;
    /**
     * (string) - The ID of the federation policy
     */
    readonly policyId: pulumi.Output<string>;
    /**
     * (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
     */
    readonly servicePrincipalId: pulumi.Output<number>;
    /**
     * (string) - Unique, immutable id of the federation policy
     */
    readonly uid: pulumi.Output<string>;
    /**
     * (string) - Last update time of the federation policy
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a AccountFederationPolicy 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?: AccountFederationPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AccountFederationPolicy resources.
 */
export interface AccountFederationPolicyState {
    /**
     * (string) - Creation time of the federation policy
     */
    createTime?: pulumi.Input<string>;
    /**
     * Description of the federation policy
     */
    description?: pulumi.Input<string>;
    /**
     * (string) - Resource name for the federation policy. Example values include
     * `accounts/<account-id>/federationPolicies/my-federation-policy` for Account Federation Policies, and
     * `accounts/<account-id>/servicePrincipals/<service-principal-id>/federationPolicies/my-federation-policy`
     * for Service Principal Federation Policies. Typically an output parameter, which does not need to be
     * specified in create or update requests. If specified in a request, must match the value in the
     * request URL
     */
    name?: pulumi.Input<string>;
    oidcPolicy?: pulumi.Input<inputs.AccountFederationPolicyOidcPolicy>;
    /**
     * (string) - The ID of the federation policy
     */
    policyId?: pulumi.Input<string>;
    /**
     * (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
     */
    servicePrincipalId?: pulumi.Input<number>;
    /**
     * (string) - Unique, immutable id of the federation policy
     */
    uid?: pulumi.Input<string>;
    /**
     * (string) - Last update time of the federation policy
     */
    updateTime?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a AccountFederationPolicy resource.
 */
export interface AccountFederationPolicyArgs {
    /**
     * Description of the federation policy
     */
    description?: pulumi.Input<string>;
    oidcPolicy?: pulumi.Input<inputs.AccountFederationPolicyOidcPolicy>;
    /**
     * (string) - The ID of the federation policy
     */
    policyId?: pulumi.Input<string>;
    /**
     * (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
     */
    servicePrincipalId?: pulumi.Input<number>;
}