Package software.amazon.awscdk.services.resourcegroups

Interface CfnGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-27T16:51:04.359Z")
@Stability(Stable)
public interface CfnGroupProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.resourcegroups.*;
 CfnGroupProps cfnGroupProps = CfnGroupProps.builder()
         .name("name")
         // the properties below are optional
         .configuration(List.of(ConfigurationItemProperty.builder()
                 .parameters(List.of(ConfigurationParameterProperty.builder()
                         .name("name")
                         .values(List.of("values"))
                         .build()))
                 .type("type")
                 .build()))
         .description("description")
         .resourceQuery(ResourceQueryProperty.builder()
                 .query(QueryProperty.builder()
                         .resourceTypeFilters(List.of("resourceTypeFilters"))
                         .stackIdentifier("stackIdentifier")
                         .tagFilters(List.of(TagFilterProperty.builder()
                                 .key("key")
                                 .values(List.of("values"))
                                 .build()))
                         .build())
                 .type("type")
                 .build())
         .resources(List.of("resources"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGroupProps.Builder	A builder for CfnGroupProps
static final class	CfnGroupProps.Jsii$Proxy	An implementation for CfnGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnGroupProps.Builder	builder()
default Object	getConfiguration()	The service configuration currently associated with the resource group and in effect for the members of the resource group.
default String	getDescription()	The description of the resource group.
String	getName()	The name of a resource group.
default Object	getResourceQuery()	The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.
default List<String>	getResources()	A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.
default List<CfnTag>	getTags()	The tag key and value pairs that are attached to the resource group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-name

getConfiguration

@Stability(Stable)
@Nullable
default Object getConfiguration()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-configuration

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the resource group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-description

getResourceQuery

@Stability(Stable)
@Nullable
default Object getResourceQuery()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resourcequery

getResources

@Stability(Stable)
@Nullable
default List<String> getResources()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resources

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-tags

builder

@Stability(Stable)
static CfnGroupProps.Builder builder()

Returns:

a CfnGroupProps.Builder of CfnGroupProps