Package software.amazon.awscdk.cfnpropertymixins.services.xray

Class CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.xray.CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSamplingRulePropsMixin.SamplingRuleProperty>

Enclosing interface:

CfnSamplingRulePropsMixin.SamplingRuleProperty

@Stability(Stable)
public static final class CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSamplingRulePropsMixin.SamplingRuleProperty>

A builder for CfnSamplingRulePropsMixin.SamplingRuleProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	attributes(Map<String,String> attributes)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getAttributes()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	attributes(IResolvable attributes)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getAttributes()
CfnSamplingRulePropsMixin.SamplingRuleProperty	build()	Builds the configured instance.
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	fixedRate(Number fixedRate)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getFixedRate()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	host(String host)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getHost()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	httpMethod(String httpMethod)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getHttpMethod()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	priority(Number priority)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getPriority()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	reservoirSize(Number reservoirSize)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getReservoirSize()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	resourceArn(String resourceArn)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getResourceArn()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	ruleArn(String ruleArn)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getRuleArn()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	ruleName(String ruleName)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getRuleName()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	serviceName(String serviceName)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getServiceName()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	serviceType(String serviceType)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getServiceType()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	urlPath(String urlPath)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getUrlPath()
CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder	version(Number version)	Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getVersion()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

attributes

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder attributes(Map<String,String> attributes)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getAttributes()

Parameters:

attributes - Matches attributes derived from the request. Map Entries: Maximum number of 5 items.

Key Length Constraints: Minimum length of 1. Maximum length of 32.

Value Length Constraints: Minimum length of 1. Maximum length of 32.

Returns:

this

attributes

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder attributes(IResolvable attributes)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getAttributes()

Parameters:

attributes - Matches attributes derived from the request. Map Entries: Maximum number of 5 items.

Key Length Constraints: Minimum length of 1. Maximum length of 32.

Value Length Constraints: Minimum length of 1. Maximum length of 32.

Returns:

this

fixedRate

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder fixedRate(Number fixedRate)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getFixedRate()

Parameters:

fixedRate - The percentage of matching requests to instrument, after the reservoir is exhausted.

Returns:

this

host

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder host(String host)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getHost()

Parameters:

host - Matches the hostname from a request URL.

Returns:

this

httpMethod

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder httpMethod(String httpMethod)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getHttpMethod()

Parameters:

httpMethod - Matches the HTTP method of a request.

Returns:

this

priority

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder priority(Number priority)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getPriority()

Parameters:

priority - The priority of the sampling rule.

Returns:

this

reservoirSize

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder reservoirSize(Number reservoirSize)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getReservoirSize()

Parameters:

reservoirSize - A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

Returns:

this

resourceArn

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder resourceArn(String resourceArn)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getResourceArn()

Parameters:

resourceArn - Matches the ARN of the AWS resource on which the service runs.

Returns:

this

ruleArn

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder ruleArn(String ruleArn)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getRuleArn()

Parameters:

ruleArn - The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

Returns:

this

ruleName

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder ruleName(String ruleName)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getRuleName()

Parameters:

ruleName - The name of the sampling rule. Specify a rule by either name or ARN, but not both.

Returns:

this

serviceName

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder serviceName(String serviceName)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getServiceName()

Parameters:

serviceName - Matches the name that the service uses to identify itself in segments.

Returns:

this

serviceType

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder serviceType(String serviceType)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getServiceType()

Parameters:

serviceType - Matches the origin that the service uses to identify its type in segments.

Returns:

this

urlPath

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder urlPath(String urlPath)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getUrlPath()

Parameters:

urlPath - Matches the path from a request URL.

Returns:

this

version

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder version(Number version)

Sets the value of CfnSamplingRulePropsMixin.SamplingRuleProperty.getVersion()

Parameters:

version - The version of the sampling rule. Version can only be set when creating a new sampling rule.

Returns:

this

build

@Stability(Stable)
public CfnSamplingRulePropsMixin.SamplingRuleProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnSamplingRulePropsMixin.SamplingRuleProperty>

Returns:

a new instance of CfnSamplingRulePropsMixin.SamplingRuleProperty

Throws:

NullPointerException - if any required attribute was not provided