@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
146 lines (145 loc) • 5.64 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "../types";
/**
* Manages an APIG (API) custom response resource within HuaweiCloud.
*
* ## Import
*
* API Responses can be imported using their `name` and IDs of the APIG dedicated instances and API groups to which the API response belongs, separated by slashes, e.g.
*
* ```sh
* $ pulumi import huaweicloud:DedicatedApig/response:Response test <instance_id>/<group_id>/<name>
* ```
*/
export declare class Response extends pulumi.CustomResource {
/**
* Get an existing Response 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?: ResponseState, opts?: pulumi.CustomResourceOptions): Response;
/**
* Returns true if the given object is an instance of Response. 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 Response;
/**
* The creation time of the API custom response.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Specifies the ID of the API group to which the API custom response
* belongs.
* Changing this will create a new resource.
*/
readonly groupId: pulumi.Output<string>;
/**
* Specifies the ID of the dedicated instance to which the API group and the
* API custom response belong.
* Changing this will create a new resource.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Specifies the name of the API custom response.
* The valid length is limited from `1` to `64`, letters, digits, hyphens (-) and underscores (_) are allowed.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the region where the API custom response is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Specifies the API custom response rules definition.
* The rule structure is documented below.
*/
readonly rules: pulumi.Output<outputs.DedicatedApig.ResponseRule[]>;
/**
* The latest update time of the API custom response.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a Response 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: ResponseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Response resources.
*/
export interface ResponseState {
/**
* The creation time of the API custom response.
*/
createdAt?: pulumi.Input<string>;
/**
* Specifies the ID of the API group to which the API custom response
* belongs.
* Changing this will create a new resource.
*/
groupId?: pulumi.Input<string>;
/**
* Specifies the ID of the dedicated instance to which the API group and the
* API custom response belong.
* Changing this will create a new resource.
*/
instanceId?: pulumi.Input<string>;
/**
* Specifies the name of the API custom response.
* The valid length is limited from `1` to `64`, letters, digits, hyphens (-) and underscores (_) are allowed.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region where the API custom response is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the API custom response rules definition.
* The rule structure is documented below.
*/
rules?: pulumi.Input<pulumi.Input<inputs.DedicatedApig.ResponseRule>[]>;
/**
* The latest update time of the API custom response.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Response resource.
*/
export interface ResponseArgs {
/**
* Specifies the ID of the API group to which the API custom response
* belongs.
* Changing this will create a new resource.
*/
groupId: pulumi.Input<string>;
/**
* Specifies the ID of the dedicated instance to which the API group and the
* API custom response belong.
* Changing this will create a new resource.
*/
instanceId: pulumi.Input<string>;
/**
* Specifies the name of the API custom response.
* The valid length is limited from `1` to `64`, letters, digits, hyphens (-) and underscores (_) are allowed.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region where the API custom response is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the API custom response rules definition.
* The rule structure is documented below.
*/
rules?: pulumi.Input<pulumi.Input<inputs.DedicatedApig.ResponseRule>[]>;
}