@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
205 lines (204 loc) • 7.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an APIG application 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 appName = config.requireObject("appName");
* const appCode = config.requireObject("appCode");
* const test = new huaweicloud.dedicatedapig.Application("test", {
* instanceId: instanceId,
* description: "Created by script",
* appCodes: [appCode],
* });
* ```
*
* ## Import
*
* Applications can be imported using their `id` and the ID of the related dedicated instance, separated by a slash, e.g.
*
* ```sh
* $ pulumi import huaweicloud:DedicatedApig/application:Application test <instance_id>/<id>
* ```
*/
export declare class Application extends pulumi.CustomResource {
/**
* Get an existing Application 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?: ApplicationState, opts?: pulumi.CustomResourceOptions): Application;
/**
* Returns true if the given object is an instance of Application. 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 Application;
/**
* Specifies an array of one or more application codes that the application has.
* Up to five application codes can be created.
* The valid length of each application code is limited from can contain `64` to `180`.
* The application code must start with a letter, digit, plus sign (+) or slash (/).
* Only letters, digits and following special special characters are allowed: `!@#$%+-_/=`.
*/
readonly appCodes: pulumi.Output<string[]>;
/**
* App key.
*/
readonly appKey: pulumi.Output<string>;
/**
* App secret.
*/
readonly appSecret: pulumi.Output<string>;
/**
* Specifies the application description.
* The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
*/
readonly description: pulumi.Output<string>;
/**
* Specifies the ID of the dedicated instance to which the application
* belongs.
* Changing this will create a new resource.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Specifies the application name.
* The valid length is limited from `3` to `64`, only Chinese characters, English letters, digits and hyphens (-)
* are allowed.
* The name must start with a Chinese character or English letter.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the region where the application is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* the registration time.
*/
readonly registrationTime: pulumi.Output<string>;
/**
* Specifies the secret action to be done for the application.
* The valid action is **RESET**.
*/
readonly secretAction: pulumi.Output<string | undefined>;
/**
* The latest update time of the application.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a Application 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: ApplicationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Application resources.
*/
export interface ApplicationState {
/**
* Specifies an array of one or more application codes that the application has.
* Up to five application codes can be created.
* The valid length of each application code is limited from can contain `64` to `180`.
* The application code must start with a letter, digit, plus sign (+) or slash (/).
* Only letters, digits and following special special characters are allowed: `!@#$%+-_/=`.
*/
appCodes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* App key.
*/
appKey?: pulumi.Input<string>;
/**
* App secret.
*/
appSecret?: pulumi.Input<string>;
/**
* Specifies the application description.
* The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* Specifies the ID of the dedicated instance to which the application
* belongs.
* Changing this will create a new resource.
*/
instanceId?: pulumi.Input<string>;
/**
* Specifies the application name.
* The valid length is limited from `3` to `64`, only Chinese characters, English letters, digits and hyphens (-)
* are allowed.
* The name must start with a Chinese character or English letter.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region where the application is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* the registration time.
*/
registrationTime?: pulumi.Input<string>;
/**
* Specifies the secret action to be done for the application.
* The valid action is **RESET**.
*/
secretAction?: pulumi.Input<string>;
/**
* The latest update time of the application.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Application resource.
*/
export interface ApplicationArgs {
/**
* Specifies an array of one or more application codes that the application has.
* Up to five application codes can be created.
* The valid length of each application code is limited from can contain `64` to `180`.
* The application code must start with a letter, digit, plus sign (+) or slash (/).
* Only letters, digits and following special special characters are allowed: `!@#$%+-_/=`.
*/
appCodes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Specifies the application description.
* The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* Specifies the ID of the dedicated instance to which the application
* belongs.
* Changing this will create a new resource.
*/
instanceId: pulumi.Input<string>;
/**
* Specifies the application name.
* The valid length is limited from `3` to `64`, only Chinese characters, English letters, digits and hyphens (-)
* are allowed.
* The name must start with a Chinese character or English letter.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region where the application is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the secret action to be done for the application.
* The valid action is **RESET**.
*/
secretAction?: pulumi.Input<string>;
}