CfnSamplingRule

class aws_cdk.aws_xray.CfnSamplingRule(scope, id, *, rule_name=None, sampling_rule=None, sampling_rule_record=None, sampling_rule_update=None, tags=None)

Bases: aws_cdk.core.CfnResource

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.

CloudformationResource

AWS::XRay::SamplingRule

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_xray as xray

# tags: Any

cfn_sampling_rule = xray.CfnSamplingRule(self, "MyCfnSamplingRule",
    rule_name="ruleName",
    sampling_rule=xray.CfnSamplingRule.SamplingRuleProperty(
        attributes={
            "attributes_key": "attributes"
        },
        fixed_rate=123,
        host="host",
        http_method="httpMethod",
        priority=123,
        reservoir_size=123,
        resource_arn="resourceArn",
        rule_arn="ruleArn",
        rule_name="ruleName",
        service_name="serviceName",
        service_type="serviceType",
        url_path="urlPath",
        version=123
    ),
    sampling_rule_record=xray.CfnSamplingRule.SamplingRuleRecordProperty(
        created_at="createdAt",
        modified_at="modifiedAt",
        sampling_rule=xray.CfnSamplingRule.SamplingRuleProperty(
            attributes={
                "attributes_key": "attributes"
            },
            fixed_rate=123,
            host="host",
            http_method="httpMethod",
            priority=123,
            reservoir_size=123,
            resource_arn="resourceArn",
            rule_arn="ruleArn",
            rule_name="ruleName",
            service_name="serviceName",
            service_type="serviceType",
            url_path="urlPath",
            version=123
        )
    ),
    sampling_rule_update=xray.CfnSamplingRule.SamplingRuleUpdateProperty(
        attributes={
            "attributes_key": "attributes"
        },
        fixed_rate=123,
        host="host",
        http_method="httpMethod",
        priority=123,
        reservoir_size=123,
        resource_arn="resourceArn",
        rule_arn="ruleArn",
        rule_name="ruleName",
        service_name="serviceName",
        service_type="serviceType",
        url_path="urlPath"
    ),
    tags=[tags]
)

Create a new AWS::XRay::SamplingRule.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • rule_name (Optional[str]) – 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 .

  • sampling_rule (Union[IResolvable, SamplingRuleProperty, Dict[str, Any], None]) – The sampling rule to be created. Must be provided if creating a new sampling rule. Not valid when updating an existing sampling rule.

  • sampling_rule_record (Union[IResolvable, SamplingRuleRecordProperty, Dict[str, Any], None]) – AWS::XRay::SamplingRule.SamplingRuleRecord.

  • sampling_rule_update (Union[IResolvable, SamplingRuleUpdateProperty, Dict[str, Any], None]) – 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. .. epigraph:: The Version of a sampling rule cannot be updated, and is not part of SamplingRuleUpdate .

  • tags (Optional[Sequence[Any]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::XRay::SamplingRule'
attr_rule_arn

The sampling rule ARN that was created or updated.

CloudformationAttribute

RuleARN

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

rule_name

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-rulename

Return type

Optional[str]

sampling_rule

The sampling rule to be created.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-samplingrule

Return type

Union[IResolvable, SamplingRuleProperty, None]

sampling_rule_record

AWS::XRay::SamplingRule.SamplingRuleRecord.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-samplingrulerecord

Return type

Union[IResolvable, SamplingRuleRecordProperty, None]

sampling_rule_update

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. .. epigraph:

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-samplingruleupdate

Return type

Union[IResolvable, SamplingRuleUpdateProperty, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

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

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-tags

Return type

Optional[List[Any]]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

SamplingRuleProperty

class CfnSamplingRule.SamplingRuleProperty(*, attributes=None, fixed_rate=None, host=None, http_method=None, priority=None, reservoir_size=None, resource_arn=None, rule_arn=None, rule_name=None, service_name=None, service_type=None, url_path=None, version=None)

Bases: object

A sampling rule that services use to decide whether to instrument a request.

Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don’t match its properties.

Parameters
  • attributes (Union[IResolvable, Mapping[str, str], None]) – 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.

  • fixed_rate (Union[int, float, None]) – The percentage of matching requests to instrument, after the reservoir is exhausted.

  • host (Optional[str]) – Matches the hostname from a request URL.

  • http_method (Optional[str]) – Matches the HTTP method of a request.

  • priority (Union[int, float, None]) – The priority of the sampling rule.

  • reservoir_size (Union[int, float, None]) – 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.

  • resource_arn (Optional[str]) – Matches the ARN of the AWS resource on which the service runs.

  • rule_arn (Optional[str]) – The ARN of the sampling rule. You must specify either RuleARN or RuleName, but not both.

  • rule_name (Optional[str]) – The name of the sampling rule. You must specify either RuleARN or RuleName, but not both.

  • service_name (Optional[str]) – Matches the name that the service uses to identify itself in segments.

  • service_type (Optional[str]) – Matches the origin that the service uses to identify its type in segments.

  • url_path (Optional[str]) – Matches the path from a request URL.

  • version (Union[int, float, None]) – The version of the sampling rule format ( 1 ).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_xray as xray

sampling_rule_property = xray.CfnSamplingRule.SamplingRuleProperty(
    attributes={
        "attributes_key": "attributes"
    },
    fixed_rate=123,
    host="host",
    http_method="httpMethod",
    priority=123,
    reservoir_size=123,
    resource_arn="resourceArn",
    rule_arn="ruleArn",
    rule_name="ruleName",
    service_name="serviceName",
    service_type="serviceType",
    url_path="urlPath",
    version=123
)

Attributes

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-attributes

Return type

Union[IResolvable, Mapping[str, str], None]

fixed_rate

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-fixedrate

Return type

Union[int, float, None]

host

Matches the hostname from a request URL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-host

Return type

Optional[str]

http_method

Matches the HTTP method of a request.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-httpmethod

Return type

Optional[str]

priority

The priority of the sampling rule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-priority

Return type

Union[int, float, None]

reservoir_size

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-reservoirsize

Return type

Union[int, float, None]

resource_arn

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-resourcearn

Return type

Optional[str]

rule_arn

The ARN of the sampling rule.

You must specify either RuleARN or RuleName, but not both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-rulearn

Return type

Optional[str]

rule_name

The name of the sampling rule.

You must specify either RuleARN or RuleName, but not both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-rulename

Return type

Optional[str]

service_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-servicename

Return type

Optional[str]

service_type

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-servicetype

Return type

Optional[str]

url_path

Matches the path from a request URL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-urlpath

Return type

Optional[str]

version

The version of the sampling rule format ( 1 ).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-version

Return type

Union[int, float, None]

SamplingRuleRecordProperty

class CfnSamplingRule.SamplingRuleRecordProperty(*, created_at=None, modified_at=None, sampling_rule=None)

Bases: object

A SamplingRule and its metadata.

Parameters
  • created_at (Optional[str]) – When the rule was created, in Unix time seconds.

  • modified_at (Optional[str]) – When the rule was last modified, in Unix time seconds.

  • sampling_rule (Union[IResolvable, SamplingRuleProperty, Dict[str, Any], None]) – The sampling rule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_xray as xray

sampling_rule_record_property = xray.CfnSamplingRule.SamplingRuleRecordProperty(
    created_at="createdAt",
    modified_at="modifiedAt",
    sampling_rule=xray.CfnSamplingRule.SamplingRuleProperty(
        attributes={
            "attributes_key": "attributes"
        },
        fixed_rate=123,
        host="host",
        http_method="httpMethod",
        priority=123,
        reservoir_size=123,
        resource_arn="resourceArn",
        rule_arn="ruleArn",
        rule_name="ruleName",
        service_name="serviceName",
        service_type="serviceType",
        url_path="urlPath",
        version=123
    )
)

Attributes

created_at

When the rule was created, in Unix time seconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-createdat

Return type

Optional[str]

modified_at

When the rule was last modified, in Unix time seconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-modifiedat

Return type

Optional[str]

sampling_rule

The sampling rule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-samplingrule

Return type

Union[IResolvable, SamplingRuleProperty, None]

SamplingRuleUpdateProperty

class CfnSamplingRule.SamplingRuleUpdateProperty(*, attributes=None, fixed_rate=None, host=None, http_method=None, priority=None, reservoir_size=None, resource_arn=None, rule_arn=None, rule_name=None, service_name=None, service_type=None, url_path=None)

Bases: object

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

Parameters
  • attributes (Union[IResolvable, Mapping[str, str], None]) – 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.

  • fixed_rate (Union[int, float, None]) – The percentage of matching requests to instrument, after the reservoir is exhausted.

  • host (Optional[str]) – Matches the hostname from a request URL.

  • http_method (Optional[str]) – Matches the HTTP method of a request.

  • priority (Union[int, float, None]) – The priority of the sampling rule.

  • reservoir_size (Union[int, float, None]) – 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.

  • resource_arn (Optional[str]) – Matches the ARN of the AWS resource on which the service runs.

  • rule_arn (Optional[str]) – The ARN of the sampling rule. You must specify either RuleARN or RuleName, but not both.

  • rule_name (Optional[str]) – The name of the sampling rule. You must specify either RuleARN or RuleName, but not both.

  • service_name (Optional[str]) – Matches the name that the service uses to identify itself in segments.

  • service_type (Optional[str]) – Matches the origin that the service uses to identify its type in segments.

  • url_path (Optional[str]) – Matches the path from a request URL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_xray as xray

sampling_rule_update_property = xray.CfnSamplingRule.SamplingRuleUpdateProperty(
    attributes={
        "attributes_key": "attributes"
    },
    fixed_rate=123,
    host="host",
    http_method="httpMethod",
    priority=123,
    reservoir_size=123,
    resource_arn="resourceArn",
    rule_arn="ruleArn",
    rule_name="ruleName",
    service_name="serviceName",
    service_type="serviceType",
    url_path="urlPath"
)

Attributes

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-attributes

Return type

Union[IResolvable, Mapping[str, str], None]

fixed_rate

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-fixedrate

Return type

Union[int, float, None]

host

Matches the hostname from a request URL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-host

Return type

Optional[str]

http_method

Matches the HTTP method of a request.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-httpmethod

Return type

Optional[str]

priority

The priority of the sampling rule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-priority

Return type

Union[int, float, None]

reservoir_size

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-reservoirsize

Return type

Union[int, float, None]

resource_arn

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-resourcearn

Return type

Optional[str]

rule_arn

The ARN of the sampling rule.

You must specify either RuleARN or RuleName, but not both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-rulearn

Return type

Optional[str]

rule_name

The name of the sampling rule.

You must specify either RuleARN or RuleName, but not both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-rulename

Return type

Optional[str]

service_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-servicename

Return type

Optional[str]

service_type

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-servicetype

Return type

Optional[str]

url_path

Matches the path from a request URL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-urlpath

Return type

Optional[str]