interface CfnGroupProps

Language	Type name
.NET	`Amazon.CDK.AWS.ResourceGroups.CfnGroupProps`
Java	`software.amazon.awscdk.services.resourcegroups.CfnGroupProps`
Python	`aws_cdk.aws_resourcegroups.CfnGroupProps`
TypeScript	`@aws-cdk/aws-resourcegroups` » `CfnGroupProps`

Properties for defining a CfnGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as resourcegroups from '@aws-cdk/aws-resourcegroups';
const cfnGroupProps: resourcegroups.CfnGroupProps = {
  name: 'name',

  // the properties below are optional
  configuration: [{
    parameters: [{
      name: 'name',
      values: ['values'],
    }],
    type: 'type',
  }],
  description: 'description',
  resourceQuery: {
    query: {
      resourceTypeFilters: ['resourceTypeFilters'],
      stackIdentifier: 'stackIdentifier',
      tagFilters: [{
        key: 'key',
        values: ['values'],
      }],
    },
    type: 'type',
  },
  resources: ['resources'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of a resource group.
configuration?	`IResolvable` `\|` `ConfigurationItemProperty` `\|` `IResolvable[]`	The service configuration currently associated with the resource group and in effect for the members of the resource group.
description?	`string`	The description of the resource group.
resourceQuery?	`IResolvable` `\|` `ResourceQueryProperty`	The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.
resources?	`string[]`	A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.
tags?	`CfnTag[]`	The tag key and value pairs that are attached to the resource group.

name

Type: string

The name of a resource group.

The name must be unique within the AWS Region in which you create the resource. To create multiple resource groups based on the same CloudFormation stack, you must generate unique names for each.

configuration?

Type: IResolvable | ConfigurationItemProperty | IResolvable[] (optional)

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 in the AWS Resource Groups User Guide .

You can include either a Configuration or a ResourceQuery , but not both.

description?

Type: string (optional)

The description of the resource group.

resourceQuery?

Type: IResolvable | ResourceQueryProperty (optional)

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 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.

resources?

Type: string[] (optional)

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.

tags?

Type: CfnTag[] (optional)

The tag key and value pairs that are attached to the resource group.