Class CfnSamplingRulePropsMixin

Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.

Inheritance

object

Mixin

CfnSamplingRulePropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.Mixins.Preview.AWS.XRay.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnSamplingRulePropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnSamplingRulePropsMixin Inherits Mixin Implements IMixin

Remarks

Include a SamplingRule entity to create or update a sampling rule.

<code>SamplingRule.Version</code> can only be set when creating a sampling rule. Updating the version will cause the update to fail.

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.

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

CloudformationResource: AWS::XRay::SamplingRule

Mixin: true

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.XRay.Mixins;

             var cfnSamplingRulePropsMixin = new CfnSamplingRulePropsMixin(new CfnSamplingRuleMixinProps {
                 RuleName = "ruleName",
                 SamplingRule = new SamplingRuleProperty {
                     Attributes = new Dictionary<string, string> {
                         { "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
                 },
                 SamplingRuleRecord = new SamplingRuleRecordProperty {
                     CreatedAt = "createdAt",
                     ModifiedAt = "modifiedAt",
                     SamplingRule = new SamplingRuleProperty {
                         Attributes = new Dictionary<string, string> {
                             { "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
                     }
                 },
                 SamplingRuleUpdate = new SamplingRuleUpdateProperty {
                     Attributes = new Dictionary<string, string> {
                         { "attributesKey", "attributes" }
                     },
                     FixedRate = 123,
                     Host = "host",
                     HttpMethod = "httpMethod",
                     Priority = 123,
                     ReservoirSize = 123,
                     ResourceArn = "resourceArn",
                     RuleArn = "ruleArn",
                     RuleName = "ruleName",
                     ServiceName = "serviceName",
                     ServiceType = "serviceType",
                     UrlPath = "urlPath"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnSamplingRulePropsMixin(ICfnSamplingRuleMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::XRay::SamplingRule.

Properties

CFN_PROPERTY_KEYS	Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.
Props	Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.
Strategy	Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnSamplingRulePropsMixin(ICfnSamplingRuleMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::XRay::SamplingRule.

public CfnSamplingRulePropsMixin(ICfnSamplingRuleMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnSamplingRuleMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

Include a SamplingRule entity to create or update a sampling rule.

<code>SamplingRule.Version</code> can only be set when creating a sampling rule. Updating the version will cause the update to fail.

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.

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

CloudformationResource: AWS::XRay::SamplingRule

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

Include a SamplingRule entity to create or update a sampling rule.

<code>SamplingRule.Version</code> can only be set when creating a sampling rule. Updating the version will cause the update to fail.

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.

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

CloudformationResource: AWS::XRay::SamplingRule

Mixin: true

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.XRay.Mixins;

             var cfnSamplingRulePropsMixin = new CfnSamplingRulePropsMixin(new CfnSamplingRuleMixinProps {
                 RuleName = "ruleName",
                 SamplingRule = new SamplingRuleProperty {
                     Attributes = new Dictionary<string, string> {
                         { "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
                 },
                 SamplingRuleRecord = new SamplingRuleRecordProperty {
                     CreatedAt = "createdAt",
                     ModifiedAt = "modifiedAt",
                     SamplingRule = new SamplingRuleProperty {
                         Attributes = new Dictionary<string, string> {
                             { "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
                     }
                 },
                 SamplingRuleUpdate = new SamplingRuleUpdateProperty {
                     Attributes = new Dictionary<string, string> {
                         { "attributesKey", "attributes" }
                     },
                     FixedRate = 123,
                     Host = "host",
                     HttpMethod = "httpMethod",
                     Priority = 123,
                     ReservoirSize = 123,
                     ResourceArn = "resourceArn",
                     RuleArn = "ruleArn",
                     RuleName = "ruleName",
                     ServiceName = "serviceName",
                     ServiceType = "serviceType",
                     UrlPath = "urlPath"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.

protected virtual ICfnSamplingRuleMixinProps Props { get; }

Property Value

ICfnSamplingRuleMixinProps

Remarks

Include a SamplingRule entity to create or update a sampling rule.

<code>SamplingRule.Version</code> can only be set when creating a sampling rule. Updating the version will cause the update to fail.

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.

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

CloudformationResource: AWS::XRay::SamplingRule

Mixin: true

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.XRay.Mixins;

             var cfnSamplingRulePropsMixin = new CfnSamplingRulePropsMixin(new CfnSamplingRuleMixinProps {
                 RuleName = "ruleName",
                 SamplingRule = new SamplingRuleProperty {
                     Attributes = new Dictionary<string, string> {
                         { "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
                 },
                 SamplingRuleRecord = new SamplingRuleRecordProperty {
                     CreatedAt = "createdAt",
                     ModifiedAt = "modifiedAt",
                     SamplingRule = new SamplingRuleProperty {
                         Attributes = new Dictionary<string, string> {
                             { "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
                     }
                 },
                 SamplingRuleUpdate = new SamplingRuleUpdateProperty {
                     Attributes = new Dictionary<string, string> {
                         { "attributesKey", "attributes" }
                     },
                     FixedRate = 123,
                     Host = "host",
                     HttpMethod = "httpMethod",
                     Priority = 123,
                     ReservoirSize = 123,
                     ResourceArn = "resourceArn",
                     RuleArn = "ruleArn",
                     RuleName = "ruleName",
                     ServiceName = "serviceName",
                     ServiceType = "serviceType",
                     UrlPath = "urlPath"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.

protected virtual PropertyMergeStrategy Strategy { get; }

Property Value

PropertyMergeStrategy

Remarks

Include a SamplingRule entity to create or update a sampling rule.

<code>SamplingRule.Version</code> can only be set when creating a sampling rule. Updating the version will cause the update to fail.

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.

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

CloudformationResource: AWS::XRay::SamplingRule

Mixin: true

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.XRay.Mixins;

             var cfnSamplingRulePropsMixin = new CfnSamplingRulePropsMixin(new CfnSamplingRuleMixinProps {
                 RuleName = "ruleName",
                 SamplingRule = new SamplingRuleProperty {
                     Attributes = new Dictionary<string, string> {
                         { "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
                 },
                 SamplingRuleRecord = new SamplingRuleRecordProperty {
                     CreatedAt = "createdAt",
                     ModifiedAt = "modifiedAt",
                     SamplingRule = new SamplingRuleProperty {
                         Attributes = new Dictionary<string, string> {
                             { "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
                     }
                 },
                 SamplingRuleUpdate = new SamplingRuleUpdateProperty {
                     Attributes = new Dictionary<string, string> {
                         { "attributesKey", "attributes" }
                     },
                     FixedRate = 123,
                     Host = "host",
                     HttpMethod = "httpMethod",
                     Priority = 123,
                     ReservoirSize = 123,
                     ResourceArn = "resourceArn",
                     RuleArn = "ruleArn",
                     RuleName = "ruleName",
                     ServiceName = "serviceName",
                     ServiceType = "serviceType",
                     UrlPath = "urlPath"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Returns

IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

Include a SamplingRule entity to create or update a sampling rule.

<code>SamplingRule.Version</code> can only be set when creating a sampling rule. Updating the version will cause the update to fail.

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.

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

CloudformationResource: AWS::XRay::SamplingRule

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

Include a SamplingRule entity to create or update a sampling rule.

<code>SamplingRule.Version</code> can only be set when creating a sampling rule. Updating the version will cause the update to fail.

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.

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

CloudformationResource: AWS::XRay::SamplingRule

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin