UNPKG

@pulumi/aws-native

Version:

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

104 lines (103 loc) 5.86 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Schema for ResourceGroups::Group */ 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 opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, 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; /** * The Resource Group ARN. */ readonly arn: pulumi.Output<string>; /** * The service configuration currently associated with the resource group and in effect for the members of the resource group. A `Configuration` consists of one or more `ConfigurationItem` entries. For information about service configurations for resource groups and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* . * * > You can include either a `Configuration` or a `ResourceQuery` , but not both. */ readonly configuration: pulumi.Output<outputs.resourcegroups.GroupConfigurationItem[] | undefined>; /** * The description of the resource group */ readonly description: pulumi.Output<string | undefined>; /** * The name of the resource group */ readonly name: pulumi.Output<string>; /** * The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. For more information about queries and how to construct them, see [Build queries and groups in AWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/gettingstarted-query.html) in the *AWS Resource Groups User Guide* * * > - You can include either a `ResourceQuery` or a `Configuration` , but not both. * > - You can specify the group's membership either by using a `ResourceQuery` or by using a list of `Resources` , but not both. */ readonly resourceQuery: pulumi.Output<outputs.resourcegroups.GroupResourceQuery | undefined>; /** * A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group. * * > - You can specify the group membership either by using a list of `Resources` or by using a `ResourceQuery` , but not both. * > - You can include a `Resources` property only if you also specify a `Configuration` property. */ readonly resources: pulumi.Output<string[] | undefined>; /** * The tag key and value pairs that are attached to the resource group. */ readonly tags: pulumi.Output<outputs.Tag[] | undefined>; /** * 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); } /** * The set of arguments for constructing a Group resource. */ export interface GroupArgs { /** * The service configuration currently associated with the resource group and in effect for the members of the resource group. A `Configuration` consists of one or more `ConfigurationItem` entries. For information about service configurations for resource groups and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* . * * > You can include either a `Configuration` or a `ResourceQuery` , but not both. */ configuration?: pulumi.Input<pulumi.Input<inputs.resourcegroups.GroupConfigurationItemArgs>[]>; /** * The description of the resource group */ description?: pulumi.Input<string>; /** * The name of the resource group */ name?: pulumi.Input<string>; /** * The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. For more information about queries and how to construct them, see [Build queries and groups in AWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/gettingstarted-query.html) in the *AWS Resource Groups User Guide* * * > - You can include either a `ResourceQuery` or a `Configuration` , but not both. * > - You can specify the group's membership either by using a `ResourceQuery` or by using a list of `Resources` , but not both. */ resourceQuery?: pulumi.Input<inputs.resourcegroups.GroupResourceQueryArgs>; /** * A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group. * * > - You can specify the group membership either by using a list of `Resources` or by using a `ResourceQuery` , but not both. * > - You can include a `Resources` property only if you also specify a `Configuration` property. */ resources?: pulumi.Input<pulumi.Input<string>[]>; /** * The tag key and value pairs that are attached to the resource group. */ tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>; }