Package software.amazon.awscdk.services.xray

Class CfnSamplingRule.SamplingRuleProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnSamplingRule.SamplingRuleProperty

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

A builder for CfnSamplingRule.SamplingRuleProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

fixedRate

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getFixedRate()

Parameters:

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

Returns:

this

host

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getHost()

Parameters:

host - Matches the hostname from a request URL. This parameter is required.

Returns:

this

httpMethod

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getHttpMethod()

Parameters:

httpMethod - Matches the HTTP method of a request. This parameter is required.

Returns:

this

priority

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getPriority()

Parameters:

priority - The priority of the sampling rule. This parameter is required.

Returns:

this

reservoirSize

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getReservoirSize()

Parameters:

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

Returns:

this

resourceArn

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getResourceArn()

Parameters:

resourceArn - Matches the ARN of the AWS resource on which the service runs. This parameter is required.

Returns:

this

serviceName

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getServiceName()

Parameters:

serviceName - Matches the name that the service uses to identify itself in segments. This parameter is required.

Returns:

this

serviceType

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getServiceType()

Parameters:

serviceType - Matches the origin that the service uses to identify its type in segments. This parameter is required.

Returns:

this

urlPath

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

Sets the value of CfnSamplingRule.SamplingRuleProperty.getUrlPath()

Parameters:

urlPath - Matches the path from a request URL. This parameter is required.

Returns:

this

attributes

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

Sets the value of CfnSamplingRule.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 CfnSamplingRule.SamplingRuleProperty.Builder attributes(Map<String,String> attributes)

Sets the value of CfnSamplingRule.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

ruleArn

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

Sets the value of CfnSamplingRule.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 CfnSamplingRule.SamplingRuleProperty.Builder ruleName(String ruleName)

Sets the value of CfnSamplingRule.SamplingRuleProperty.getRuleName()

Parameters:

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

Returns:

this

version

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

Sets the value of CfnSamplingRule.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 CfnSamplingRule.SamplingRuleProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnSamplingRule.SamplingRuleProperty

Throws:

NullPointerException - if any required attribute was not provided