@volcengine/pulumi/iam/samlProvider.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a resource to manage iam saml provider
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@volcengine/pulumi";
 *
 * const foo = new volcengine.iam.SamlProvider("foo", {
 *     encodedSamlMetadataDocument: "your document",
 *     samlProviderName: "terraform",
 *     ssoType: 2,
 *     status: 1,
 * });
 * ```
 *
 * ## Import
 *
 * IamSamlProvider can be imported using the id, e.g.
 *
 * ```sh
 * $ pulumi import volcengine:iam/samlProvider:SamlProvider default SAMLProviderName
 * ```
 */
export declare class SamlProvider extends pulumi.CustomResource {
    /**
     * Get an existing SamlProvider 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?: SamlProviderState, opts?: pulumi.CustomResourceOptions): SamlProvider;
    /**
     * Returns true if the given object is an instance of SamlProvider.  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 SamlProvider;
    /**
     * Identity provider creation time, such as 20150123T123318Z.
     */
    readonly createDate: pulumi.Output<string>;
    /**
     * The description of the SAML provider.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Metadata document, encoded in Base64.
     */
    readonly encodedSamlMetadataDocument: pulumi.Output<string>;
    /**
     * The name of the SAML provider.
     */
    readonly samlProviderName: pulumi.Output<string>;
    /**
     * SSO types, 1. Role-based SSO, 2. User-based SSO.
     */
    readonly ssoType: pulumi.Output<number>;
    /**
     * User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
     */
    readonly status: pulumi.Output<number | undefined>;
    /**
     * The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
     */
    readonly trn: pulumi.Output<string>;
    /**
     * Identity provider update time, such as: 20150123T123318Z.
     */
    readonly updateDate: pulumi.Output<string>;
    /**
     * Create a SamlProvider 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: SamlProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SamlProvider resources.
 */
export interface SamlProviderState {
    /**
     * Identity provider creation time, such as 20150123T123318Z.
     */
    createDate?: pulumi.Input<string>;
    /**
     * The description of the SAML provider.
     */
    description?: pulumi.Input<string>;
    /**
     * Metadata document, encoded in Base64.
     */
    encodedSamlMetadataDocument?: pulumi.Input<string>;
    /**
     * The name of the SAML provider.
     */
    samlProviderName?: pulumi.Input<string>;
    /**
     * SSO types, 1. Role-based SSO, 2. User-based SSO.
     */
    ssoType?: pulumi.Input<number>;
    /**
     * User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
     */
    status?: pulumi.Input<number>;
    /**
     * The format for the resource name of an identity provider is trn:iam::${accountID}:saml-provider/{$SAMLProviderName}.
     */
    trn?: pulumi.Input<string>;
    /**
     * Identity provider update time, such as: 20150123T123318Z.
     */
    updateDate?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a SamlProvider resource.
 */
export interface SamlProviderArgs {
    /**
     * The description of the SAML provider.
     */
    description?: pulumi.Input<string>;
    /**
     * Metadata document, encoded in Base64.
     */
    encodedSamlMetadataDocument: pulumi.Input<string>;
    /**
     * The name of the SAML provider.
     */
    samlProviderName: pulumi.Input<string>;
    /**
     * SSO types, 1. Role-based SSO, 2. User-based SSO.
     */
    ssoType: pulumi.Input<number>;
    /**
     * User SSO status, 1. Enabled, 2. Disable other console login methods after enabling, 3. Disabled, is a required field when creating user SSO.
     */
    status?: pulumi.Input<number>;
}