@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
104 lines (103 loc) • 3.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an API gateway group resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as huaweicloud from "@pulumi/huaweicloud";
*
* const apigwGroup = new huaweicloud.SharedApig.Group("apigw_group", {
* description: "your descpiption",
* });
* ```
*/
export declare class Group extends pulumi.CustomResource {
/**
* Get an existing Group 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?: GroupState, opts?: pulumi.CustomResourceOptions): Group;
/**
* Returns true if the given object is an instance of Group. 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 Group;
/**
* Specifies the description of the API group. The description cannot exceed 255
* characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies the name of the API group. An API group name consists of 3–64 characters,
* starting with a letter. Only letters, digits, and underscores (_) are allowed.
*/
readonly name: pulumi.Output<string>;
/**
* The region in which to create the API gateway group resource. If omitted, the
* provider-level region will be used. Changing this creates a new gateway group resource.
*/
readonly region: pulumi.Output<string>;
/**
* Status of the API group.
*/
readonly status: pulumi.Output<number>;
/**
* Create a Group 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?: GroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Group resources.
*/
export interface GroupState {
/**
* Specifies the description of the API group. The description cannot exceed 255
* characters.
*/
description?: pulumi.Input<string>;
/**
* Specifies the name of the API group. An API group name consists of 3–64 characters,
* starting with a letter. Only letters, digits, and underscores (_) are allowed.
*/
name?: pulumi.Input<string>;
/**
* The region in which to create the API gateway group resource. If omitted, the
* provider-level region will be used. Changing this creates a new gateway group resource.
*/
region?: pulumi.Input<string>;
/**
* Status of the API group.
*/
status?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Group resource.
*/
export interface GroupArgs {
/**
* Specifies the description of the API group. The description cannot exceed 255
* characters.
*/
description?: pulumi.Input<string>;
/**
* Specifies the name of the API group. An API group name consists of 3–64 characters,
* starting with a letter. Only letters, digits, and underscores (_) are allowed.
*/
name?: pulumi.Input<string>;
/**
* The region in which to create the API gateway group resource. If omitted, the
* provider-level region will be used. Changing this creates a new gateway group resource.
*/
region?: pulumi.Input<string>;
}