@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
99 lines (98 loc) • 2.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "../types";
/**
* Use this data source to get the list of the available HuaweiCloud security groups.
*
* ## Example Usage
* ### Filter the list of security groups by a description keyword
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as huaweicloud from "@pulumi/huaweicloud";
*
* const config = new pulumi.Config();
* const keyWord = config.requireObject("keyWord");
* const test = huaweicloud.Vpc.getSecgroups({
* description: keyWord,
* });
* ```
*/
export declare function getSecgroups(args?: GetSecgroupsArgs, opts?: pulumi.InvokeOptions): Promise<GetSecgroupsResult>;
/**
* A collection of arguments for invoking getSecgroups.
*/
export interface GetSecgroupsArgs {
/**
* Specifies the description of the security group. The security groups can be
* filtered by keywords in the description.
*/
description?: string;
/**
* Specifies the enterprise project ID of the security group.
*/
enterpriseProjectId?: string;
/**
* Specifies the id of the desired security group.
*/
id?: string;
/**
* Specifies the name of the security group.
*/
name?: string;
/**
* Specifies the region in which to obtain the security group list.
* If omitted, the provider-level region will be used.
*/
region?: string;
}
/**
* A collection of values returned by getSecgroups.
*/
export interface GetSecgroupsResult {
readonly description?: string;
/**
* The enterprise project ID of the security group.
*/
readonly enterpriseProjectId?: string;
/**
* The security group ID.
*/
readonly id: string;
/**
* The name of the security group.
*/
readonly name?: string;
readonly region: string;
/**
* The list of security groups. The object is documented below.
*/
readonly securityGroups: outputs.Vpc.GetSecgroupsSecurityGroup[];
}
export declare function getSecgroupsOutput(args?: GetSecgroupsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetSecgroupsResult>;
/**
* A collection of arguments for invoking getSecgroups.
*/
export interface GetSecgroupsOutputArgs {
/**
* Specifies the description of the security group. The security groups can be
* filtered by keywords in the description.
*/
description?: pulumi.Input<string>;
/**
* Specifies the enterprise project ID of the security group.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* Specifies the id of the desired security group.
*/
id?: pulumi.Input<string>;
/**
* Specifies the name of the security group.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to obtain the security group list.
* If omitted, the provider-level region will be used.
*/
region?: pulumi.Input<string>;
}