Package software.amazon.awscdk.services.xray

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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrGroupArn

      @Stability(Stable) @NotNull public String getAttrGroupArn()
      The group ARN that was created or updated.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGroupName

      @Stability(Stable) @NotNull public String getGroupName()
      The unique case-sensitive name of the group.

    • setGroupName

      @Stability(Stable) public void setGroupName(@NotNull String value)
      The unique case-sensitive name of the group.

    • getFilterExpression

      @Stability(Stable) @Nullable public String getFilterExpression()
      The filter expression defining the parameters to include traces.

    • setFilterExpression

      @Stability(Stable) public void setFilterExpression(@Nullable String value)
      The filter expression defining the parameters to include traces.

    • getInsightsConfiguration

      @Stability(Stable) @Nullable public 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

      @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

      @Stability(Stable) public void setInsightsConfiguration(@Nullable 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

      @Stability(Stable) @Nullable public List<Object> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<Object> value)
      An array of key-value pairs to apply to this resource.