CfnGroupPropsMixin

class aws_cdk.mixins_preview.aws_resourcegroups.mixins.CfnGroupPropsMixin(props, *, strategy=None)

Bases: 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 AWS Resource Groups in the AWS 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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html
CloudformationResource:: AWS::ResourceGroups::Group
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_resourcegroups import mixins as resourcegroups_mixins

cfn_group_props_mixin = resourcegroups_mixins.CfnGroupPropsMixin(resourcegroups_mixins.CfnGroupMixinProps(
    configuration=[resourcegroups_mixins.CfnGroupPropsMixin.ConfigurationItemProperty(
        parameters=[resourcegroups_mixins.CfnGroupPropsMixin.ConfigurationParameterProperty(
            name="name",
            values=["values"]
        )],
        type="type"
    )],
    description="description",
    name="name",
    resource_query=resourcegroups_mixins.CfnGroupPropsMixin.ResourceQueryProperty(
        query=resourcegroups_mixins.CfnGroupPropsMixin.QueryProperty(
            resource_type_filters=["resourceTypeFilters"],
            stack_identifier="stackIdentifier",
            tag_filters=[resourcegroups_mixins.CfnGroupPropsMixin.TagFilterProperty(
                key="key",
                values=["values"]
            )]
        ),
        type="type"
    ),
    resources=["resources"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['configuration', 'description', 'name', 'resourceQuery', 'resources', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConfigurationItemProperty

class CfnGroupPropsMixin.ConfigurationItemProperty(*, parameters=None, type=None)

Bases: object

One of the items in the service configuration assigned to a resource group.

A service configuration can consist of one or more items. For details service configurations and how to construct them, see Service configurations for resource groups in the AWS Resource Groups User Guide .

Parameters:

parameters (Union[IResolvable, Sequence[Union[IResolvable, ConfigurationParameterProperty, Dict[str, Any]]], None]) – A collection of parameters for this configuration item. For the list of parameters that you can use with each configuration item Type , see Supported resource types and parameters in the AWS Resource Groups User Guide .
type (Optional[str]) –
Specifies the type of configuration item. Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see Supported resource types and parameters in the AWS Resource Groups User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_resourcegroups import mixins as resourcegroups_mixins

configuration_item_property = resourcegroups_mixins.CfnGroupPropsMixin.ConfigurationItemProperty(
    parameters=[resourcegroups_mixins.CfnGroupPropsMixin.ConfigurationParameterProperty(
        name="name",
        values=["values"]
    )],
    type="type"
)

Attributes

parameters

A collection of parameters for this configuration item.

For the list of parameters that you can use with each configuration item Type , see Supported resource types and parameters in the AWS Resource Groups User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-parameters

type

Specifies the type of configuration item.

Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see Supported resource types and parameters in the AWS Resource Groups User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-type

ConfigurationParameterProperty

class CfnGroupPropsMixin.ConfigurationParameterProperty(*, name=None, values=None)

Bases: object

One parameter for a group configuration item.

For details about service configurations and how to construct them, see Service configurations for resource groups in the AWS Resource Groups User Guide .

Parameters:

name (Optional[str]) –
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters in the AWS Resource Groups User Guide .
values (Optional[Sequence[str]]) –
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_resourcegroups import mixins as resourcegroups_mixins

configuration_parameter_property = resourcegroups_mixins.CfnGroupPropsMixin.ConfigurationParameterProperty(
    name="name",
    values=["values"]
)

Attributes

name

The name of the group configuration parameter.

For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters in the AWS Resource Groups User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html#cfn-resourcegroups-group-configurationparameter-name

values

The value or values to be used for the specified parameter.

For the list of values you can use with each parameter, see Supported resource types and parameters .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html#cfn-resourcegroups-group-configurationparameter-values

QueryProperty

class CfnGroupPropsMixin.QueryProperty(*, resource_type_filters=None, stack_identifier=None, tag_filters=None)

Bases: object

Specifies details within a ResourceQuery structure that determines the membership of the resource group.

The contents required in the Query structure are determined by the Type property of the containing ResourceQuery structure.

Parameters:

resource_type_filters (Optional[Sequence[str]]) – Specifies limits to the types of resources that can be included in the resource group. For example, if ResourceTypeFilters is ["AWS::EC2::Instance", "AWS::DynamoDB::Table"] , only EC2 instances or DynamoDB tables can be members of this resource group. The default value is ["AWS::AllSupported"] .
stack_identifier (Optional[str]) – Specifies the ARN of a CloudFormation stack. All supported resources of the CloudFormation stack are members of the resource group. If you don’t specify an ARN, this parameter defaults to the current stack that you are defining, which means that all the resources of the current stack are grouped. You can specify a value for StackIdentifier only when the ResourceQuery.Type property is CLOUDFORMATION_STACK_1_0.
tag_filters (Union[IResolvable, Sequence[Union[IResolvable, TagFilterProperty, Dict[str, Any]]], None]) – A list of key-value pair objects that limit which resources can be members of the resource group. This property is required when the ResourceQuery.Type property is TAG_FILTERS_1_0 . A resource must have a tag that matches every filter that is provided in the TagFilters list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_resourcegroups import mixins as resourcegroups_mixins

query_property = resourcegroups_mixins.CfnGroupPropsMixin.QueryProperty(
    resource_type_filters=["resourceTypeFilters"],
    stack_identifier="stackIdentifier",
    tag_filters=[resourcegroups_mixins.CfnGroupPropsMixin.TagFilterProperty(
        key="key",
        values=["values"]
    )]
)

Attributes

resource_type_filters

Specifies limits to the types of resources that can be included in the resource group.

For example, if ResourceTypeFilters is ["AWS::EC2::Instance", "AWS::DynamoDB::Table"] , only EC2 instances or DynamoDB tables can be members of this resource group. The default value is ["AWS::AllSupported"] .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-resourcetypefilters

stack_identifier

Specifies the ARN of a CloudFormation stack.

All supported resources of the CloudFormation stack are members of the resource group. If you don’t specify an ARN, this parameter defaults to the current stack that you are defining, which means that all the resources of the current stack are grouped.

You can specify a value for StackIdentifier only when the ResourceQuery.Type property is CLOUDFORMATION_STACK_1_0.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-stackidentifier

tag_filters

A list of key-value pair objects that limit which resources can be members of the resource group.

This property is required when the ResourceQuery.Type property is TAG_FILTERS_1_0 .

A resource must have a tag that matches every filter that is provided in the TagFilters list.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-tagfilters

ResourceQueryProperty

class CfnGroupPropsMixin.ResourceQueryProperty(*, query=None, type=None)

Bases: object

The query used to dynamically define the members of a group.

For more information about how to construct a query, see Build queries and groups in AWS Resource Groups .

Parameters:

query (Union[IResolvable, QueryProperty, Dict[str, Any], None]) – The query that defines the membership of the group. This is a structure with properties that depend on the Type . The Query structure must be included in the following scenarios: - When the Type is TAG_FILTERS_1_0 , you must specify a Query structure that contains a TagFilters list of tags. Resources with tags that match those in the TagFilter list become members of the resource group. - When the Type is CLOUDFORMATION_STACK_1_0 then this field is required only when you must specify a CloudFormation stack other than the one you are defining. To do this, the Query structure must contain the StackIdentifier property. If you don’t specify either a Query structure or a StackIdentifier within that Query , then it defaults to the CloudFormation stack that you’re currently constructing.
type (Optional[str]) – Specifies the type of resource query that determines this group’s membership. There are two valid query types:. - TAG_FILTERS_1_0 indicates that the group is a tag-based group. To complete the group membership, you must include the TagFilters property to specify the tag filters to use in the query. - CLOUDFORMATION_STACK_1_0 , the default, indicates that the group is a CloudFormation stack-based group. Group membership is based on the CloudFormation stack. You must specify the StackIdentifier property in the query to define which stack to associate the group with, or leave it empty to default to the stack where the group is defined.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_resourcegroups import mixins as resourcegroups_mixins

resource_query_property = resourcegroups_mixins.CfnGroupPropsMixin.ResourceQueryProperty(
    query=resourcegroups_mixins.CfnGroupPropsMixin.QueryProperty(
        resource_type_filters=["resourceTypeFilters"],
        stack_identifier="stackIdentifier",
        tag_filters=[resourcegroups_mixins.CfnGroupPropsMixin.TagFilterProperty(
            key="key",
            values=["values"]
        )]
    ),
    type="type"
)

Attributes

query

The query that defines the membership of the group.

This is a structure with properties that depend on the Type .

The Query structure must be included in the following scenarios:

When the Type is TAG_FILTERS_1_0 , you must specify a Query structure that contains a TagFilters list of tags. Resources with tags that match those in the TagFilter list become members of the resource group.
When the Type is CLOUDFORMATION_STACK_1_0 then this field is required only when you must specify a CloudFormation stack other than the one you are defining. To do this, the Query structure must contain the StackIdentifier property. If you don’t specify either a Query structure or a StackIdentifier within that Query , then it defaults to the CloudFormation stack that you’re currently constructing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html#cfn-resourcegroups-group-resourcequery-query

type

.

TAG_FILTERS_1_0 indicates that the group is a tag-based group. To complete the group membership, you must include the TagFilters property to specify the tag filters to use in the query.
CLOUDFORMATION_STACK_1_0 , the default, indicates that the group is a CloudFormation stack-based group. Group membership is based on the CloudFormation stack. You must specify the StackIdentifier property in the query to define which stack to associate the group with, or leave it empty to default to the stack where the group is defined.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html#cfn-resourcegroups-group-resourcequery-type
Type:: Specifies the type of resource query that determines this group’s membership. There are two valid query types

TagFilterProperty

class CfnGroupPropsMixin.TagFilterProperty(*, key=None, values=None)

Bases: object

Specifies a single tag key and optional values that you can use to specify membership in a tag-based group.

An AWS resource that doesn’t have a matching tag key and value is rejected as a member of the group.

A TagFilter object includes two properties: Key (a string) and Values (a list of strings). Only resources in the account that are tagged with a matching key-value pair are members of the group. The Values property of TagFilter is optional, but specifying it narrows the query results.

As an example, suppose the TagFilters string is [{"Key": "Stage", "Values": ["Test", "Beta"]}, {"Key": "Storage"}] . In this case, only resources with all of the following tags are members of the group:

Stage tag key with a value of either Test or Beta
Storage tag key with any value

Parameters:

key (Optional[str]) – A string that defines a tag key. Only resources in the account that are tagged with a specified tag key are members of the tag-based resource group. This field is required when the ResourceQuery structure’s Type property is TAG_FILTERS_1_0 . You must specify at least one tag key.
values (Optional[Sequence[str]]) – A list of tag values that can be included in the tag-based resource group. This is optional. If you don’t specify a value or values for a key, then an AWS resource with any value for that key is a member.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_resourcegroups import mixins as resourcegroups_mixins

tag_filter_property = resourcegroups_mixins.CfnGroupPropsMixin.TagFilterProperty(
    key="key",
    values=["values"]
)

Attributes

key

A string that defines a tag key.

Only resources in the account that are tagged with a specified tag key are members of the tag-based resource group.

This field is required when the ResourceQuery structure’s Type property is TAG_FILTERS_1_0 . You must specify at least one tag key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html#cfn-resourcegroups-group-tagfilter-key

values

A list of tag values that can be included in the tag-based resource group.

This is optional. If you don’t specify a value or values for a key, then an AWS resource with any value for that key is a member.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html#cfn-resourcegroups-group-tagfilter-values