Class CfnGroup
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.xray.CfnGroup
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:36.669Z")
@Stability(Stable)
public class CfnGroup
extends CfnResource
implements IInspectable
A CloudFormation
AWS::XRay::Group
.
Use the AWS::XRay::Group
resource to specify a group with a name and a filter expression. Groups enable the collection of traces that match the filter expression, can be used to filter service graphs and traces, and to supply Amazon CloudWatch metrics.
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.xray.*; Object tags; CfnGroup cfnGroup = CfnGroup.Builder.create(this, "MyCfnGroup") .groupName("groupName") // the properties below are optional .filterExpression("filterExpression") .insightsConfiguration(InsightsConfigurationProperty.builder() .insightsEnabled(false) .notificationsEnabled(false) .build()) .tags(List.of(tags)) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnGroup
.static interface
The structure containing configurations related to insights.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe group ARN that was created or updated.The filter expression defining the parameters to include traces.The unique case-sensitive name of the group.The structure containing configurations related to insights.getTags()
An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setFilterExpression
(String value) The filter expression defining the parameters to include traces.void
setGroupName
(String value) The unique case-sensitive name of the group.void
The structure containing configurations related to insights.void
The structure containing configurations related to insights.void
An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnGroup
protected CfnGroup(software.amazon.jsii.JsiiObjectRef objRef) -
CfnGroup
protected CfnGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnGroup
@Stability(Stable) public CfnGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnGroupProps props) Create a newAWS::XRay::Group
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrGroupArn
The group ARN that was created or updated. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getGroupName
The unique case-sensitive name of the group. -
setGroupName
The unique case-sensitive name of the group. -
getFilterExpression
The filter expression defining the parameters to include traces. -
setFilterExpression
The filter expression defining the parameters to include traces. -
getInsightsConfiguration
The structure containing configurations related to insights.- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
-
setInsightsConfiguration
@Stability(Stable) public void setInsightsConfiguration(@Nullable CfnGroup.InsightsConfigurationProperty value) The structure containing configurations related to insights.- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
-
setInsightsConfiguration
The structure containing configurations related to insights.- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
-
getTags
An array of key-value pairs to apply to this resource. -
setTags
An array of key-value pairs to apply to this resource.
-