software.amazon.awscdk.services.xray

Class CfnSamplingRule.Builder

java.lang.Object

software.amazon.awscdk.services.xray.CfnSamplingRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSamplingRule>

Enclosing class:

CfnSamplingRule

@Stability(value=Stable)
public static final class CfnSamplingRule.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSamplingRule>

A fluent builder for CfnSamplingRule.

Method Summary

Modifier and Type	Method and Description
CfnSamplingRule	build()
static CfnSamplingRule.Builder	create(software.constructs.Construct scope, String id)
CfnSamplingRule.Builder	ruleName(String ruleName) The name of the sampling rule.
CfnSamplingRule.Builder	samplingRule(CfnSamplingRule.SamplingRuleProperty samplingRule) The sampling rule to be created.
CfnSamplingRule.Builder	samplingRule(IResolvable samplingRule) The sampling rule to be created.
CfnSamplingRule.Builder	samplingRuleRecord(CfnSamplingRule.SamplingRuleRecordProperty samplingRuleRecord) `AWS::XRay::SamplingRule.SamplingRuleRecord`.
CfnSamplingRule.Builder	samplingRuleRecord(IResolvable samplingRuleRecord) `AWS::XRay::SamplingRule.SamplingRuleRecord`.
CfnSamplingRule.Builder	samplingRuleUpdate(CfnSamplingRule.SamplingRuleUpdateProperty samplingRuleUpdate) A document specifying changes to a sampling rule's configuration.
CfnSamplingRule.Builder	samplingRuleUpdate(IResolvable samplingRuleUpdate) A document specifying changes to a sampling rule's configuration.
CfnSamplingRule.Builder	tags(List<? extends Object> tags) An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

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

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

Returns:

a new instance of CfnSamplingRule.SamplingRuleProperty.Builder.

ruleName

@Stability(value=Stable)
public CfnSamplingRule.Builder ruleName(String ruleName)

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 .

Parameters:

ruleName - The name of the sampling rule. This parameter is required.

Returns:

this

samplingRule

@Stability(value=Stable)
public CfnSamplingRule.Builder samplingRule(CfnSamplingRule.SamplingRuleProperty samplingRule)

The sampling rule to be created.

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

Parameters:

samplingRule - The sampling rule to be created. This parameter is required.

Returns:

this

samplingRule

@Stability(value=Stable)
public CfnSamplingRule.Builder samplingRule(IResolvable samplingRule)

The sampling rule to be created.

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

Parameters:

samplingRule - The sampling rule to be created. This parameter is required.

Returns:

this

samplingRuleRecord

@Stability(value=Stable)
public CfnSamplingRule.Builder samplingRuleRecord(CfnSamplingRule.SamplingRuleRecordProperty samplingRuleRecord)

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

Parameters:

samplingRuleRecord - `AWS::XRay::SamplingRule.SamplingRuleRecord`. This parameter is required.

Returns:

this

samplingRuleRecord

@Stability(value=Stable)
public CfnSamplingRule.Builder samplingRuleRecord(IResolvable samplingRuleRecord)

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

Parameters:

samplingRuleRecord - `AWS::XRay::SamplingRule.SamplingRuleRecord`. This parameter is required.

Returns:

this

samplingRuleUpdate

@Stability(value=Stable)
public CfnSamplingRule.Builder samplingRuleUpdate(CfnSamplingRule.SamplingRuleUpdateProperty samplingRuleUpdate)

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 .

Parameters:

samplingRuleUpdate - A document specifying changes to a sampling rule's configuration. This parameter is required.

Returns:

this

samplingRuleUpdate

@Stability(value=Stable)
public CfnSamplingRule.Builder samplingRuleUpdate(IResolvable samplingRuleUpdate)

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 .

Parameters:

samplingRuleUpdate - A document specifying changes to a sampling rule's configuration. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnSamplingRule.Builder tags(List<? extends Object> tags)

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

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnSamplingRule build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSamplingRule>