Interface CfnGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:22.674Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGroupProps
static final class
An implementation forCfnGroupProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnGroupProps.Builder
builder()
default Object
The service configuration currently associated with the resource group and in effect for the members of the resource group.default String
The description of the resource group.getName()
The name of a resource group.default Object
The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.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
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:
-
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 moreConfigurationItem
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 aResourceQuery
, but not both.- See Also:
-
getDescription
The description of the resource group.- See Also:
-
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 aConfiguration
, but not both. - You can specify the group's membership either by using a
ResourceQuery
or by using a list ofResources
, but not both.
- See Also:
- You can include either a
-
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 aResourceQuery
, but not both. - You can include a
Resources
property only if you also specify aConfiguration
property.
- See Also:
- You can specify the group membership either by using a list of
-
getTags
The tag key and value pairs that are attached to the resource group.- See Also:
-
builder
- Returns:
- a
CfnGroupProps.Builder
ofCfnGroupProps
-