software.amazon.awscdk.services.xray

Class CfnGroup

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.850Z")
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.

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")
         .filterExpression("filterExpression")
         .groupName("groupName")
         .insightsConfiguration(InsightsConfigurationProperty.builder()
                 .insightsEnabled(false)
                 .notificationsEnabled(false)
                 .build())
         .tags(List.of(tags))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGroup.Builder A fluent builder for CfnGroup.
static interface	CfnGroup.InsightsConfigurationProperty The structure containing configurations related to insights.
static interface	CfnGroup.TagsItemsProperty Example:

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGroup(Construct scope, java.lang.String id) Create a new `AWS::XRay::Group`.
	CfnGroup(Construct scope, java.lang.String id, CfnGroupProps props) Create a new `AWS::XRay::Group`.
protected	CfnGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrGroupArn() The group ARN that was created or updated.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getFilterExpression() The filter expression defining the parameters to include traces.
java.lang.String	getGroupName() The unique case-sensitive name of the group.
java.lang.Object	getInsightsConfiguration() The structure containing configurations related to insights.
java.util.List<java.lang.Object>	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setFilterExpression(java.lang.String value) The filter expression defining the parameters to include traces.
void	setGroupName(java.lang.String value) The unique case-sensitive name of the group.
void	setInsightsConfiguration(CfnGroup.InsightsConfigurationProperty value) The structure containing configurations related to insights.
void	setInsightsConfiguration(IResolvable value) The structure containing configurations related to insights.
void	setTags(java.util.List<java.lang.Object> value) 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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGroup

protected CfnGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnGroup

protected CfnGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGroup

public CfnGroup(Construct scope,
                java.lang.String id,
                CfnGroupProps props)

Create a new `AWS::XRay::Group`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnGroup

public CfnGroup(Construct scope,
                java.lang.String id)

Create a new `AWS::XRay::Group`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrGroupArn

public java.lang.String getAttrGroupArn()

The group ARN that was created or updated.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFilterExpression

public java.lang.String getFilterExpression()

The filter expression defining the parameters to include traces.

setFilterExpression

public void setFilterExpression(java.lang.String value)

The filter expression defining the parameters to include traces.

getGroupName

public java.lang.String getGroupName()

The unique case-sensitive name of the group.

setGroupName

public void setGroupName(java.lang.String value)

The unique case-sensitive name of the group.

getInsightsConfiguration

public java.lang.Object 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

public void setInsightsConfiguration(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

public void setInsightsConfiguration(IResolvable 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.

getTags

public java.util.List<java.lang.Object> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

setTags

public void setTags(java.util.List<java.lang.Object> value)

An array of key-value pairs to apply to this resource.

For more information, see Tag .