class CfnGroupPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ResourceGroups.CfnGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsresourcegroups#CfnGroupPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.resourcegroups.CfnGroupPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_resourcegroups.CfnGroupPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_resourcegroups » CfnGroupPropsMixin

Implements IMixin

Extends Mixin

Creates a resource group with the specified name and description.

You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide . For more information about service-linked groups and service configurations, see Service configurations for Resource Groups .

Minimum permissions

To run this command, you must have the following permissions:

• resource-groups:CreateGroup

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_resourcegroups as resourcegroups } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnGroupPropsMixin = new resourcegroups.CfnGroupPropsMixin({
  configuration: [{
    parameters: [{
      name: 'name',
      values: ['values'],
    }],
    type: 'type',
  }],
  description: 'description',
  name: 'name',
  resourceQuery: {
    query: {
      resourceTypeFilters: ['resourceTypeFilters'],
      stackIdentifier: 'stackIdentifier',
      tagFilters: [{
        key: 'key',
        values: ['values'],
      }],
    },
    type: 'type',
  },
  resources: ['resources'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnGroupPropsMixin(props: CfnGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ResourceGroups::Group.

Properties

Name	Type	Description
props	CfnGroupMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnGroupMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.