@volcengine/pulumi/kms/keyPrimaryRegion.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a resource to manage kms key primary region
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@volcengine/pulumi";
 *
 * const primary = new volcengine.kms.KeyPrimaryRegion("primary", {
 *     keyName: "mrk-Tf-test",
 *     keyringName: "test",
 *     primaryRegion: "cn-shanghai",
 * });
 * ```
 *
 * ## Import
 *
 * KmsKeyPrimaryRegion can be imported using the id, e.g.
 *
 * ```sh
 * $ pulumi import volcengine:kms/keyPrimaryRegion:KeyPrimaryRegion default key_id
 * ```
 *
 * or
 *
 * ```sh
 * $ pulumi import volcengine:kms/keyPrimaryRegion:KeyPrimaryRegion default key_name:keyring_name
 * ```
 */
export declare class KeyPrimaryRegion extends pulumi.CustomResource {
    /**
     * Get an existing KeyPrimaryRegion 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?: KeyPrimaryRegionState, opts?: pulumi.CustomResourceOptions): KeyPrimaryRegion;
    /**
     * Returns true if the given object is an instance of KeyPrimaryRegion.  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 KeyPrimaryRegion;
    /**
     * The id of the key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    readonly keyId: pulumi.Output<string>;
    /**
     * The name of the key. Note: Only multi-region keys support updating primary region.
     */
    readonly keyName: pulumi.Output<string>;
    /**
     * The name of the keyring.
     */
    readonly keyringName: pulumi.Output<string | undefined>;
    /**
     * The new primary region.
     */
    readonly primaryRegion: pulumi.Output<string>;
    /**
     * Create a KeyPrimaryRegion 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: KeyPrimaryRegionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering KeyPrimaryRegion resources.
 */
export interface KeyPrimaryRegionState {
    /**
     * The id of the key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    keyId?: pulumi.Input<string>;
    /**
     * The name of the key. Note: Only multi-region keys support updating primary region.
     */
    keyName?: pulumi.Input<string>;
    /**
     * The name of the keyring.
     */
    keyringName?: pulumi.Input<string>;
    /**
     * The new primary region.
     */
    primaryRegion?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a KeyPrimaryRegion resource.
 */
export interface KeyPrimaryRegionArgs {
    /**
     * The id of the key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    keyId?: pulumi.Input<string>;
    /**
     * The name of the key. Note: Only multi-region keys support updating primary region.
     */
    keyName?: pulumi.Input<string>;
    /**
     * The name of the keyring.
     */
    keyringName?: pulumi.Input<string>;
    /**
     * The new primary region.
     */
    primaryRegion: pulumi.Input<string>;
}