Package software.amazon.awscdk.services.synthetics

Interface CfnGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:07.006Z")
@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.synthetics.*;
 CfnGroupProps cfnGroupProps = CfnGroupProps.builder()
         .name("name")
         // the properties below are optional
         .resourceArns(List.of("resourceArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-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()
String	getName()	A name for the group.
default List<String>	getResourceArns()	The ARNs of the canaries that you want to associate with this group.
default List<CfnTag>	getTags()	The list of key-value pairs that are associated with the group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A name for the group. It can include any Unicode characters.

The names for all groups in your account, across all Regions, must be unique.

See Also:

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

getResourceArns

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

The ARNs of the canaries that you want to associate with this group.

See Also:

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

getTags

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

The list of key-value pairs that are associated with the group.

See Also:

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

builder

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

Returns:

a CfnGroupProps.Builder of CfnGroupProps