@huaweicloudos/pulumi/dedicatedapig/environment.d.ts

A Pulumi package for creating and managing Huaweicloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages an APIG environment resource within HuaweiCloud.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pulumi from "@huaweicloudos/pulumi";
 *
 * const config = new pulumi.Config();
 * const instanceId = config.requireObject("instanceId");
 * const environmentName = config.requireObject("environmentName");
 * const description = config.requireObject("description");
 * const test = new huaweicloud.dedicatedapig.Environment("test", {
 *     instanceId: instanceId,
 *     description: description,
 * });
 * ```
 *
 * ## Import
 *
 * Environments can be imported using their `name` and the ID of the related dedicated instance, separated by a slash, e.g. bash
 *
 * ```sh
 *  $ pulumi import huaweicloud:DedicatedApig/environment:Environment test <instance_id>/<name>
 * ```
 */
export declare class Environment extends pulumi.CustomResource {
    /**
     * Get an existing Environment 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?: EnvironmentState, opts?: pulumi.CustomResourceOptions): Environment;
    /**
     * Returns true if the given object is an instance of Environment.  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 Environment;
    /**
     * schema: Deprecated; The time when the environment was created.
     *
     * @deprecated Use 'created_at' instead
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * The time when the environment was created.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * Specifies the environment description.
     * The value can contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
     * Chinese characters must be in **UTF-8** or **Unicode** format.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Specifies the ID of the dedicated instance to which the environment
     * belongs.
     * Changing this will create a new resource.
     */
    readonly instanceId: pulumi.Output<string>;
    /**
     * Specifies the environment name.
     * The valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.
     * The name must start with a letter.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Specifies the region where the dedicated instance is located.
     * If omitted, the provider-level region will be used. Changing this will create a new resource.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Create a Environment 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: EnvironmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Environment resources.
 */
export interface EnvironmentState {
    /**
     * schema: Deprecated; The time when the environment was created.
     *
     * @deprecated Use 'created_at' instead
     */
    createTime?: pulumi.Input<string>;
    /**
     * The time when the environment was created.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * Specifies the environment description.
     * The value can contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
     * Chinese characters must be in **UTF-8** or **Unicode** format.
     */
    description?: pulumi.Input<string>;
    /**
     * Specifies the ID of the dedicated instance to which the environment
     * belongs.
     * Changing this will create a new resource.
     */
    instanceId?: pulumi.Input<string>;
    /**
     * Specifies the environment name.
     * The valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.
     * The name must start with a letter.
     */
    name?: pulumi.Input<string>;
    /**
     * Specifies the region where the dedicated instance is located.
     * If omitted, the provider-level region will be used. Changing this will create a new resource.
     */
    region?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Environment resource.
 */
export interface EnvironmentArgs {
    /**
     * Specifies the environment description.
     * The value can contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
     * Chinese characters must be in **UTF-8** or **Unicode** format.
     */
    description?: pulumi.Input<string>;
    /**
     * Specifies the ID of the dedicated instance to which the environment
     * belongs.
     * Changing this will create a new resource.
     */
    instanceId: pulumi.Input<string>;
    /**
     * Specifies the environment name.
     * The valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.
     * The name must start with a letter.
     */
    name?: pulumi.Input<string>;
    /**
     * Specifies the region where the dedicated instance is located.
     * If omitted, the provider-level region will be used. Changing this will create a new resource.
     */
    region?: pulumi.Input<string>;
}