@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
142 lines (141 loc) • 4.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "../types";
/**
* Use this data source to get the list of CFW address groups.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as huaweicloud from "@pulumi/huaweicloud";
*
* const config = new pulumi.Config();
* const objectId = config.requireObject("objectId");
* const test = huaweicloud.Cfw.getAddressGroups({
* objectId: objectId,
* });
* ```
*/
export declare function getAddressGroups(args: GetAddressGroupsArgs, opts?: pulumi.InvokeOptions): Promise<GetAddressGroupsResult>;
/**
* A collection of arguments for invoking getAddressGroups.
*/
export interface GetAddressGroupsArgs {
/**
* Specifies IP address of the IP address group.
*/
address?: string;
/**
* Specifies the IP address type.
* The value can be **0** (IPv4) or **1** (IPv6).
*/
addressType?: string;
/**
* Specifies the enterprise project id to which the IP address group belongs.
*/
enterpriseProjectId?: string;
/**
* Specifies the firewall instance ID.
*/
fwInstanceId?: string;
/**
* Specifies the keyword of the address group description.
*/
keyWord?: string;
/**
* Specifies the name of the address group.
*/
name?: string;
/**
* Specifies the protected object ID.
*/
objectId: string;
/**
* Specifies the address group type of the query.
* + **0:** indicates a custom IP address group.
* + **1:** indicates a predefined IP address group.
*/
queryAddressSetType?: number;
/**
* Specifies the region in which to query the resource.
* If omitted, the provider-level region will be used.
*/
region?: string;
}
/**
* A collection of values returned by getAddressGroups.
*/
export interface GetAddressGroupsResult {
readonly address?: string;
/**
* The IP address group list.
*/
readonly addressGroups: outputs.Cfw.GetAddressGroupsAddressGroup[];
/**
* The address type.
*/
readonly addressType?: string;
readonly enterpriseProjectId?: string;
readonly fwInstanceId?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly keyWord?: string;
/**
* The IP address group name.
*/
readonly name?: string;
/**
* The protected object ID.
*/
readonly objectId: string;
readonly queryAddressSetType?: number;
readonly region: string;
}
export declare function getAddressGroupsOutput(args: GetAddressGroupsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetAddressGroupsResult>;
/**
* A collection of arguments for invoking getAddressGroups.
*/
export interface GetAddressGroupsOutputArgs {
/**
* Specifies IP address of the IP address group.
*/
address?: pulumi.Input<string>;
/**
* Specifies the IP address type.
* The value can be **0** (IPv4) or **1** (IPv6).
*/
addressType?: pulumi.Input<string>;
/**
* Specifies the enterprise project id to which the IP address group belongs.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* Specifies the firewall instance ID.
*/
fwInstanceId?: pulumi.Input<string>;
/**
* Specifies the keyword of the address group description.
*/
keyWord?: pulumi.Input<string>;
/**
* Specifies the name of the address group.
*/
name?: pulumi.Input<string>;
/**
* Specifies the protected object ID.
*/
objectId: pulumi.Input<string>;
/**
* Specifies the address group type of the query.
* + **0:** indicates a custom IP address group.
* + **1:** indicates a predefined IP address group.
*/
queryAddressSetType?: pulumi.Input<number>;
/**
* Specifies the region in which to query the resource.
* If omitted, the provider-level region will be used.
*/
region?: pulumi.Input<string>;
}