software.amazon.awscdk.services.xray

Class CfnSamplingRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.xray.CfnSamplingRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.835Z")
 @Stability(value=Stable)
public class CfnSamplingRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::XRay::SamplingRule`.

Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications. A new sampling rule is created by specifying a SamplingRule . To change the configuration of an existing sampling rule, specify a SamplingRuleUpdate .

Services retrieve rules with GetSamplingRules , and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

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;
 CfnSamplingRule cfnSamplingRule = CfnSamplingRule.Builder.create(this, "MyCfnSamplingRule")
         .ruleName("ruleName")
         .samplingRule(SamplingRuleProperty.builder()
                 .attributes(Map.of(
                         "attributesKey", "attributes"))
                 .fixedRate(123)
                 .host("host")
                 .httpMethod("httpMethod")
                 .priority(123)
                 .reservoirSize(123)
                 .resourceArn("resourceArn")
                 .ruleArn("ruleArn")
                 .ruleName("ruleName")
                 .serviceName("serviceName")
                 .serviceType("serviceType")
                 .urlPath("urlPath")
                 .version(123)
                 .build())
         .samplingRuleRecord(SamplingRuleRecordProperty.builder()
                 .createdAt("createdAt")
                 .modifiedAt("modifiedAt")
                 .samplingRule(SamplingRuleProperty.builder()
                         .attributes(Map.of(
                                 "attributesKey", "attributes"))
                         .fixedRate(123)
                         .host("host")
                         .httpMethod("httpMethod")
                         .priority(123)
                         .reservoirSize(123)
                         .resourceArn("resourceArn")
                         .ruleArn("ruleArn")
                         .ruleName("ruleName")
                         .serviceName("serviceName")
                         .serviceType("serviceType")
                         .urlPath("urlPath")
                         .version(123)
                         .build())
                 .build())
         .samplingRuleUpdate(SamplingRuleUpdateProperty.builder()
                 .attributes(Map.of(
                         "attributesKey", "attributes"))
                 .fixedRate(123)
                 .host("host")
                 .httpMethod("httpMethod")
                 .priority(123)
                 .reservoirSize(123)
                 .resourceArn("resourceArn")
                 .ruleArn("ruleArn")
                 .ruleName("ruleName")
                 .serviceName("serviceName")
                 .serviceType("serviceType")
                 .urlPath("urlPath")
                 .build())
         .tags(List.of(tags))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSamplingRule.Builder A fluent builder for CfnSamplingRule.
static interface	CfnSamplingRule.SamplingRuleProperty A sampling rule that services use to decide whether to instrument a request.
static interface	CfnSamplingRule.SamplingRuleRecordProperty A [SamplingRule](https://docs.aws.amazon.com//xray/latest/api/API_SamplingRule.html) and its metadata.
static interface	CfnSamplingRule.SamplingRuleUpdateProperty A document specifying changes to a sampling rule's configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSamplingRule(software.constructs.Construct scope, String id) Create a new `AWS::XRay::SamplingRule`.
	CfnSamplingRule(software.constructs.Construct scope, String id, CfnSamplingRuleProps props) Create a new `AWS::XRay::SamplingRule`.
protected	CfnSamplingRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSamplingRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrRuleArn() The sampling rule ARN that was created or updated.
protected Map<String,Object>	getCfnProperties()
String	getRuleName() The name of the sampling rule.
Object	getSamplingRule() The sampling rule to be created.
Object	getSamplingRuleRecord() `AWS::XRay::SamplingRule.SamplingRuleRecord`.
Object	getSamplingRuleUpdate() A document specifying changes to a sampling rule's configuration.
List<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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setRuleName(String value) The name of the sampling rule.
void	setSamplingRule(CfnSamplingRule.SamplingRuleProperty value) The sampling rule to be created.
void	setSamplingRule(IResolvable value) The sampling rule to be created.
void	setSamplingRuleRecord(CfnSamplingRule.SamplingRuleRecordProperty value) `AWS::XRay::SamplingRule.SamplingRuleRecord`.
void	setSamplingRuleRecord(IResolvable value) `AWS::XRay::SamplingRule.SamplingRuleRecord`.
void	setSamplingRuleUpdate(CfnSamplingRule.SamplingRuleUpdateProperty value) A document specifying changes to a sampling rule's configuration.
void	setSamplingRuleUpdate(IResolvable value) A document specifying changes to a sampling rule's configuration.
void	setTags(List<Object> value) An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSamplingRule

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

CfnSamplingRule

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

CfnSamplingRule

@Stability(value=Stable)
public CfnSamplingRule(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @Nullable
                                                CfnSamplingRuleProps props)

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

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.

CfnSamplingRule

@Stability(value=Stable)
public CfnSamplingRule(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id)

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

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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrRuleArn

@Stability(value=Stable)
 @NotNull
public String getAttrRuleArn()

The sampling rule ARN that was created or updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRuleName

@Stability(value=Stable)
 @Nullable
public String getRuleName()

The name of the sampling rule.

Specify a rule by either name or ARN, but not both. Used only when deleting a sampling rule. When creating or updating a sampling rule, use the RuleName or RuleARN properties within SamplingRule or SamplingRuleUpdate .

setRuleName

@Stability(value=Stable)
public void setRuleName(@Nullable
                                                 String value)

The name of the sampling rule.

Specify a rule by either name or ARN, but not both. Used only when deleting a sampling rule. When creating or updating a sampling rule, use the RuleName or RuleARN properties within SamplingRule or SamplingRuleUpdate .

getSamplingRule

@Stability(value=Stable)
 @Nullable
public Object getSamplingRule()

The sampling rule to be created.

Must be provided if creating a new sampling rule. Not valid when updating an existing sampling rule.

setSamplingRule

@Stability(value=Stable)
public void setSamplingRule(@Nullable
                                                     CfnSamplingRule.SamplingRuleProperty value)

The sampling rule to be created.

Must be provided if creating a new sampling rule. Not valid when updating an existing sampling rule.

setSamplingRule

@Stability(value=Stable)
public void setSamplingRule(@Nullable
                                                     IResolvable value)

The sampling rule to be created.

Must be provided if creating a new sampling rule. Not valid when updating an existing sampling rule.

getSamplingRuleRecord

@Stability(value=Stable)
 @Nullable
public Object getSamplingRuleRecord()

`AWS::XRay::SamplingRule.SamplingRuleRecord`.

setSamplingRuleRecord

@Stability(value=Stable)
public void setSamplingRuleRecord(@Nullable
                                                           CfnSamplingRule.SamplingRuleRecordProperty value)

`AWS::XRay::SamplingRule.SamplingRuleRecord`.

setSamplingRuleRecord

@Stability(value=Stable)
public void setSamplingRuleRecord(@Nullable
                                                           IResolvable value)

`AWS::XRay::SamplingRule.SamplingRuleRecord`.

getSamplingRuleUpdate

@Stability(value=Stable)
 @Nullable
public Object getSamplingRuleUpdate()

A document specifying changes to a sampling rule's configuration.

Must be provided if updating an existing sampling rule. Not valid when creating a new sampling rule.

The Version of a sampling rule cannot be updated, and is not part of SamplingRuleUpdate .

setSamplingRuleUpdate

@Stability(value=Stable)
public void setSamplingRuleUpdate(@Nullable
                                                           CfnSamplingRule.SamplingRuleUpdateProperty value)

A document specifying changes to a sampling rule's configuration.

Must be provided if updating an existing sampling rule. Not valid when creating a new sampling rule.

The Version of a sampling rule cannot be updated, and is not part of SamplingRuleUpdate .

setSamplingRuleUpdate

@Stability(value=Stable)
public void setSamplingRuleUpdate(@Nullable
                                                           IResolvable value)

A document specifying changes to a sampling rule's configuration.

Must be provided if updating an existing sampling rule. Not valid when creating a new sampling rule.

The Version of a sampling rule cannot be updated, and is not part of SamplingRuleUpdate .

getTags

@Stability(value=Stable)
 @Nullable
public List<Object> getTags()

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

For more information, see Tag .

setTags

@Stability(value=Stable)
public void setTags(@Nullable
                                             List<Object> value)

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

For more information, see Tag .