Package software.amazon.awscdk.services.resourcegroups

Class CfnGroup.Builder

java.lang.Object

software.amazon.awscdk.services.resourcegroups.CfnGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGroup>

Enclosing class:

CfnGroup

@Stability(Stable)
public static final class CfnGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGroup>

A fluent builder for CfnGroup.

Method Summary

Modifier and Type	Method	Description
CfnGroup	build()
CfnGroup.Builder	configuration(List<? extends Object> configuration)	The service configuration currently associated with the resource group and in effect for the members of the resource group.
CfnGroup.Builder	configuration(IResolvable configuration)	The service configuration currently associated with the resource group and in effect for the members of the resource group.
static CfnGroup.Builder	create(software.constructs.Construct scope, String id)
CfnGroup.Builder	description(String description)	The description of the resource group.
CfnGroup.Builder	name(String name)	The name of a resource group.
CfnGroup.Builder	resourceQuery(IResolvable resourceQuery)	The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.
CfnGroup.Builder	resourceQuery(CfnGroup.ResourceQueryProperty resourceQuery)	The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group.
CfnGroup.Builder	resources(List<String> resources)	A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.
CfnGroup.Builder	tags(List<? extends CfnTag> tags)	The tag key and value pairs that are attached to the resource group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnGroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGroup.Builder.

name

@Stability(Stable)
public CfnGroup.Builder name(String name)

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.

Parameters:

name - The name of a resource group. This parameter is required.

Returns:

this

See Also:

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

configuration

@Stability(Stable)
public CfnGroup.Builder configuration(IResolvable configuration)

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.

Parameters:

configuration - The service configuration currently associated with the resource group and in effect for the members of the resource group. This parameter is required.

Returns:

this

See Also:

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

configuration

@Stability(Stable)
public CfnGroup.Builder configuration(List<? extends Object> configuration)

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.

Parameters:

configuration - The service configuration currently associated with the resource group and in effect for the members of the resource group. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnGroup.Builder description(String description)

The description of the resource group.

Parameters:

description - The description of the resource group. This parameter is required.

Returns:

this

See Also:

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

resourceQuery

@Stability(Stable)
public CfnGroup.Builder resourceQuery(IResolvable resourceQuery)

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.

Parameters:

resourceQuery - The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. This parameter is required.

Returns:

this

See Also:

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

resourceQuery

@Stability(Stable)
public CfnGroup.Builder resourceQuery(CfnGroup.ResourceQueryProperty resourceQuery)

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.

Parameters:

resourceQuery - The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. This parameter is required.

Returns:

this

See Also:

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

resources

@Stability(Stable)
public CfnGroup.Builder resources(List<String> resources)

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.

Parameters:

resources - A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnGroup.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - The tag key and value pairs that are attached to the resource group. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGroup>

Returns:

a newly built instance of CfnGroup.