@lbrlabs/pulumi-scaleway/iamApiKey.d.ts

A Pulumi package for creating and managing scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Creates and manages Scaleway IAM API Keys. For more information, please
 * check [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#api-keys-3665ae)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@lbrlabs/pulumi-scaleway";
 *
 * const ciCd = new scaleway.IamApplication("ciCd", {});
 * const main = new scaleway.IamApiKey("main", {
 *     applicationId: scaleway_iam_application.main.id,
 *     description: "a description",
 * });
 * ```
 *
 * ## Import
 *
 * Api keys can be imported using the `{id}`, e.g. bash
 *
 * ```sh
 *  $ pulumi import scaleway:index/iamApiKey:IamApiKey main 11111111111111111111
 * ```
 */
export declare class IamApiKey extends pulumi.CustomResource {
    /**
     * Get an existing IamApiKey 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?: IamApiKeyState, opts?: pulumi.CustomResourceOptions): IamApiKey;
    /**
     * Returns true if the given object is an instance of IamApiKey.  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 IamApiKey;
    /**
     * The access key of the iam api key.
     */
    readonly accessKey: pulumi.Output<string>;
    /**
     * ID of the application attached to the api key.
     * Only one of the `applicationId` and `userId` should be specified.
     */
    readonly applicationId: pulumi.Output<string | undefined>;
    /**
     * The date and time of the creation of the iam api key.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The IP Address of the device which created the API key.
     */
    readonly creationIp: pulumi.Output<string>;
    /**
     * The default project ID to use with object storage.
     */
    readonly defaultProjectId: pulumi.Output<string>;
    /**
     * The description of the iam api key.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Whether the iam api key is editable.
     */
    readonly editable: pulumi.Output<boolean>;
    /**
     * The date and time of the expiration of the iam api key. Please note that in case of change,
     * the resource will be recreated.
     */
    readonly expiresAt: pulumi.Output<string | undefined>;
    /**
     * The secret Key of the iam api key.
     */
    readonly secretKey: pulumi.Output<string>;
    /**
     * The date and time of the last update of the iam api key.
     */
    readonly updatedAt: pulumi.Output<string>;
    /**
     * ID of the user attached to the api key.
     * Only one of the `applicationId` and `userId` should be specified.
     */
    readonly userId: pulumi.Output<string | undefined>;
    /**
     * Create a IamApiKey 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?: IamApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IamApiKey resources.
 */
export interface IamApiKeyState {
    /**
     * The access key of the iam api key.
     */
    accessKey?: pulumi.Input<string>;
    /**
     * ID of the application attached to the api key.
     * Only one of the `applicationId` and `userId` should be specified.
     */
    applicationId?: pulumi.Input<string>;
    /**
     * The date and time of the creation of the iam api key.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * The IP Address of the device which created the API key.
     */
    creationIp?: pulumi.Input<string>;
    /**
     * The default project ID to use with object storage.
     */
    defaultProjectId?: pulumi.Input<string>;
    /**
     * The description of the iam api key.
     */
    description?: pulumi.Input<string>;
    /**
     * Whether the iam api key is editable.
     */
    editable?: pulumi.Input<boolean>;
    /**
     * The date and time of the expiration of the iam api key. Please note that in case of change,
     * the resource will be recreated.
     */
    expiresAt?: pulumi.Input<string>;
    /**
     * The secret Key of the iam api key.
     */
    secretKey?: pulumi.Input<string>;
    /**
     * The date and time of the last update of the iam api key.
     */
    updatedAt?: pulumi.Input<string>;
    /**
     * ID of the user attached to the api key.
     * Only one of the `applicationId` and `userId` should be specified.
     */
    userId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a IamApiKey resource.
 */
export interface IamApiKeyArgs {
    /**
     * ID of the application attached to the api key.
     * Only one of the `applicationId` and `userId` should be specified.
     */
    applicationId?: pulumi.Input<string>;
    /**
     * The default project ID to use with object storage.
     */
    defaultProjectId?: pulumi.Input<string>;
    /**
     * The description of the iam api key.
     */
    description?: pulumi.Input<string>;
    /**
     * The date and time of the expiration of the iam api key. Please note that in case of change,
     * the resource will be recreated.
     */
    expiresAt?: pulumi.Input<string>;
    /**
     * ID of the user attached to the api key.
     * Only one of the `applicationId` and `userId` should be specified.
     */
    userId?: pulumi.Input<string>;
}