awsxray

package
v1.168.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 9, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

AWS::XRay Construct Library

This module is part of the AWS Cloud Development Kit project.

import xray "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::XRay.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnGroup_CFN_RESOURCE_TYPE_NAME 

func CfnGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnGroup_IsCfnElement 

func CfnGroup_IsCfnElement(x interface{}) *bool

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.

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

func CfnGroup_IsCfnResource 

func CfnGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnGroup_IsConstruct 

func CfnGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnSamplingRule_CFN_RESOURCE_TYPE_NAME 

func CfnSamplingRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnSamplingRule_IsCfnElement 

func CfnSamplingRule_IsCfnElement(x interface{}) *bool

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.

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

func CfnSamplingRule_IsCfnResource 

func CfnSamplingRule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnSamplingRule_IsConstruct 

func CfnSamplingRule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnGroup_Override 

func NewCfnGroup_Override(c CfnGroup, scope awscdk.Construct, id *string, props *CfnGroupProps)

Create a new `AWS::XRay::Group`.

func NewCfnSamplingRule_Override 

func NewCfnSamplingRule_Override(c CfnSamplingRule, scope awscdk.Construct, id *string, props *CfnSamplingRuleProps)

Create a new `AWS::XRay::SamplingRule`.

Types

type CfnGroup 

type CfnGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The group ARN that was created or updated.
	AttrGroupArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: 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.
	// Experimental.
	CreationStack() *[]*string
	// The filter expression defining the parameters to include traces.
	FilterExpression() *string
	SetFilterExpression(val *string)
	// The unique case-sensitive name of the group.
	GroupName() *string
	SetGroupName(val *string)
	// The structure containing configurations related to insights.
	//
	// - The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
	// - The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
	InsightsConfiguration() interface{}
	SetInsightsConfiguration(val interface{})
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags() *[]interface{}
	SetTags(val *[]interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// 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.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// 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.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::XRay::Group`.

Use the `AWS::XRay::Group` resource to specify a group with a name and a filter expression.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var tags interface{}

cfnGroup := awscdk.Aws_xray.NewCfnGroup(this, jsii.String("MyCfnGroup"), &cfnGroupProps{
	filterExpression: jsii.String("filterExpression"),
	groupName: jsii.String("groupName"),
	insightsConfiguration: &insightsConfigurationProperty{
		insightsEnabled: jsii.Boolean(false),
		notificationsEnabled: jsii.Boolean(false),
	},
	tags: []interface{}{
		tags,
	},
})

func NewCfnGroup 

func NewCfnGroup(scope awscdk.Construct, id *string, props *CfnGroupProps) CfnGroup

Create a new `AWS::XRay::Group`.

type CfnGroupProps 

type CfnGroupProps struct {
	// The filter expression defining the parameters to include traces.
	FilterExpression *string `field:"optional" json:"filterExpression" yaml:"filterExpression"`
	// The unique case-sensitive name of the group.
	GroupName *string `field:"optional" json:"groupName" yaml:"groupName"`
	// The structure containing configurations related to insights.
	//
	// - The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
	// - The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
	InsightsConfiguration interface{} `field:"optional" json:"insightsConfiguration" yaml:"insightsConfiguration"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]interface{} `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnGroup`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var tags interface{}

cfnGroupProps := &cfnGroupProps{
	filterExpression: jsii.String("filterExpression"),
	groupName: jsii.String("groupName"),
	insightsConfiguration: &insightsConfigurationProperty{
		insightsEnabled: jsii.Boolean(false),
		notificationsEnabled: jsii.Boolean(false),
	},
	tags: []interface{}{
		tags,
	},
}

type CfnGroup_InsightsConfigurationProperty 

type CfnGroup_InsightsConfigurationProperty struct {
	// Set the InsightsEnabled value to true to enable insights or false to disable insights.
	InsightsEnabled interface{} `field:"optional" json:"insightsEnabled" yaml:"insightsEnabled"`
	// Set the NotificationsEnabled value to true to enable insights notifications.
	//
	// Notifications can only be enabled on a group with InsightsEnabled set to true.
	NotificationsEnabled interface{} `field:"optional" json:"notificationsEnabled" yaml:"notificationsEnabled"`
}

The structure containing configurations related to insights.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

insightsConfigurationProperty := &insightsConfigurationProperty{
	insightsEnabled: jsii.Boolean(false),
	notificationsEnabled: jsii.Boolean(false),
}

type CfnSamplingRule 

type CfnSamplingRule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The sampling rule ARN that was created or updated.
	AttrRuleArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: 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.
	// Experimental.
	CreationStack() *[]*string
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// 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` .
	RuleName() *string
	SetRuleName(val *string)
	// The sampling rule to be created.
	//
	// Must be provided if creating a new sampling rule. Not valid when updating an existing sampling rule.
	SamplingRule() interface{}
	SetSamplingRule(val interface{})
	// `AWS::XRay::SamplingRule.SamplingRuleRecord`.
	SamplingRuleRecord() interface{}
	SetSamplingRuleRecord(val interface{})
	// 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` .
	SamplingRuleUpdate() interface{}
	SetSamplingRuleUpdate(val interface{})
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags() *[]interface{}
	SetTags(val *[]interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// 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.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// 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.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

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](https://docs.aws.amazon.com//xray/latest/api/API_GetSamplingRules.html) , 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](https://docs.aws.amazon.com//xray/latest/api/API_GetSamplingTargets.html) 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.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var tags interface{}

cfnSamplingRule := awscdk.Aws_xray.NewCfnSamplingRule(this, jsii.String("MyCfnSamplingRule"), &cfnSamplingRuleProps{
	ruleName: jsii.String("ruleName"),
	samplingRule: &samplingRuleProperty{
		attributes: map[string]*string{
			"attributesKey": jsii.String("attributes"),
		},
		fixedRate: jsii.Number(123),
		host: jsii.String("host"),
		httpMethod: jsii.String("httpMethod"),
		priority: jsii.Number(123),
		reservoirSize: jsii.Number(123),
		resourceArn: jsii.String("resourceArn"),
		ruleArn: jsii.String("ruleArn"),
		ruleName: jsii.String("ruleName"),
		serviceName: jsii.String("serviceName"),
		serviceType: jsii.String("serviceType"),
		urlPath: jsii.String("urlPath"),
		version: jsii.Number(123),
	},
	samplingRuleRecord: &samplingRuleRecordProperty{
		createdAt: jsii.String("createdAt"),
		modifiedAt: jsii.String("modifiedAt"),
		samplingRule: &samplingRuleProperty{
			attributes: map[string]*string{
				"attributesKey": jsii.String("attributes"),
			},
			fixedRate: jsii.Number(123),
			host: jsii.String("host"),
			httpMethod: jsii.String("httpMethod"),
			priority: jsii.Number(123),
			reservoirSize: jsii.Number(123),
			resourceArn: jsii.String("resourceArn"),
			ruleArn: jsii.String("ruleArn"),
			ruleName: jsii.String("ruleName"),
			serviceName: jsii.String("serviceName"),
			serviceType: jsii.String("serviceType"),
			urlPath: jsii.String("urlPath"),
			version: jsii.Number(123),
		},
	},
	samplingRuleUpdate: &samplingRuleUpdateProperty{
		attributes: map[string]*string{
			"attributesKey": jsii.String("attributes"),
		},
		fixedRate: jsii.Number(123),
		host: jsii.String("host"),
		httpMethod: jsii.String("httpMethod"),
		priority: jsii.Number(123),
		reservoirSize: jsii.Number(123),
		resourceArn: jsii.String("resourceArn"),
		ruleArn: jsii.String("ruleArn"),
		ruleName: jsii.String("ruleName"),
		serviceName: jsii.String("serviceName"),
		serviceType: jsii.String("serviceType"),
		urlPath: jsii.String("urlPath"),
	},
	tags: []interface{}{
		tags,
	},
})

func NewCfnSamplingRule 

func NewCfnSamplingRule(scope awscdk.Construct, id *string, props *CfnSamplingRuleProps) CfnSamplingRule

Create a new `AWS::XRay::SamplingRule`.

type CfnSamplingRuleProps 

type CfnSamplingRuleProps struct {
	// 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` .
	RuleName *string `field:"optional" json:"ruleName" yaml:"ruleName"`
	// The sampling rule to be created.
	//
	// Must be provided if creating a new sampling rule. Not valid when updating an existing sampling rule.
	SamplingRule interface{} `field:"optional" json:"samplingRule" yaml:"samplingRule"`
	// `AWS::XRay::SamplingRule.SamplingRuleRecord`.
	SamplingRuleRecord interface{} `field:"optional" json:"samplingRuleRecord" yaml:"samplingRuleRecord"`
	// 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` .
	SamplingRuleUpdate interface{} `field:"optional" json:"samplingRuleUpdate" yaml:"samplingRuleUpdate"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]interface{} `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnSamplingRule`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var tags interface{}

cfnSamplingRuleProps := &cfnSamplingRuleProps{
	ruleName: jsii.String("ruleName"),
	samplingRule: &samplingRuleProperty{
		attributes: map[string]*string{
			"attributesKey": jsii.String("attributes"),
		},
		fixedRate: jsii.Number(123),
		host: jsii.String("host"),
		httpMethod: jsii.String("httpMethod"),
		priority: jsii.Number(123),
		reservoirSize: jsii.Number(123),
		resourceArn: jsii.String("resourceArn"),
		ruleArn: jsii.String("ruleArn"),
		ruleName: jsii.String("ruleName"),
		serviceName: jsii.String("serviceName"),
		serviceType: jsii.String("serviceType"),
		urlPath: jsii.String("urlPath"),
		version: jsii.Number(123),
	},
	samplingRuleRecord: &samplingRuleRecordProperty{
		createdAt: jsii.String("createdAt"),
		modifiedAt: jsii.String("modifiedAt"),
		samplingRule: &samplingRuleProperty{
			attributes: map[string]*string{
				"attributesKey": jsii.String("attributes"),
			},
			fixedRate: jsii.Number(123),
			host: jsii.String("host"),
			httpMethod: jsii.String("httpMethod"),
			priority: jsii.Number(123),
			reservoirSize: jsii.Number(123),
			resourceArn: jsii.String("resourceArn"),
			ruleArn: jsii.String("ruleArn"),
			ruleName: jsii.String("ruleName"),
			serviceName: jsii.String("serviceName"),
			serviceType: jsii.String("serviceType"),
			urlPath: jsii.String("urlPath"),
			version: jsii.Number(123),
		},
	},
	samplingRuleUpdate: &samplingRuleUpdateProperty{
		attributes: map[string]*string{
			"attributesKey": jsii.String("attributes"),
		},
		fixedRate: jsii.Number(123),
		host: jsii.String("host"),
		httpMethod: jsii.String("httpMethod"),
		priority: jsii.Number(123),
		reservoirSize: jsii.Number(123),
		resourceArn: jsii.String("resourceArn"),
		ruleArn: jsii.String("ruleArn"),
		ruleName: jsii.String("ruleName"),
		serviceName: jsii.String("serviceName"),
		serviceType: jsii.String("serviceType"),
		urlPath: jsii.String("urlPath"),
	},
	tags: []interface{}{
		tags,
	},
}

type CfnSamplingRule_SamplingRuleProperty 

type CfnSamplingRule_SamplingRuleProperty struct {
	// 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.
	Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"`
	// The percentage of matching requests to instrument, after the reservoir is exhausted.
	FixedRate *float64 `field:"optional" json:"fixedRate" yaml:"fixedRate"`
	// Matches the hostname from a request URL.
	Host *string `field:"optional" json:"host" yaml:"host"`
	// Matches the HTTP method of a request.
	HttpMethod *string `field:"optional" json:"httpMethod" yaml:"httpMethod"`
	// The priority of the sampling rule.
	Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
	// 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.
	ReservoirSize *float64 `field:"optional" json:"reservoirSize" yaml:"reservoirSize"`
	// Matches the ARN of the AWS resource on which the service runs.
	ResourceArn *string `field:"optional" json:"resourceArn" yaml:"resourceArn"`
	// The ARN of the sampling rule.
	//
	// You must specify either RuleARN or RuleName, but not both.
	RuleArn *string `field:"optional" json:"ruleArn" yaml:"ruleArn"`
	// The name of the sampling rule.
	//
	// You must specify either RuleARN or RuleName, but not both.
	RuleName *string `field:"optional" json:"ruleName" yaml:"ruleName"`
	// Matches the `name` that the service uses to identify itself in segments.
	ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
	// Matches the `origin` that the service uses to identify its type in segments.
	ServiceType *string `field:"optional" json:"serviceType" yaml:"serviceType"`
	// Matches the path from a request URL.
	UrlPath *string `field:"optional" json:"urlPath" yaml:"urlPath"`
	// The version of the sampling rule format ( `1` ).
	Version *float64 `field:"optional" json:"version" yaml:"version"`
}

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.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

samplingRuleProperty := &samplingRuleProperty{
	attributes: map[string]*string{
		"attributesKey": jsii.String("attributes"),
	},
	fixedRate: jsii.Number(123),
	host: jsii.String("host"),
	httpMethod: jsii.String("httpMethod"),
	priority: jsii.Number(123),
	reservoirSize: jsii.Number(123),
	resourceArn: jsii.String("resourceArn"),
	ruleArn: jsii.String("ruleArn"),
	ruleName: jsii.String("ruleName"),
	serviceName: jsii.String("serviceName"),
	serviceType: jsii.String("serviceType"),
	urlPath: jsii.String("urlPath"),
	version: jsii.Number(123),
}

type CfnSamplingRule_SamplingRuleRecordProperty 

type CfnSamplingRule_SamplingRuleRecordProperty struct {
	// When the rule was created, in Unix time seconds.
	CreatedAt *string `field:"optional" json:"createdAt" yaml:"createdAt"`
	// When the rule was last modified, in Unix time seconds.
	ModifiedAt *string `field:"optional" json:"modifiedAt" yaml:"modifiedAt"`
	// The sampling rule.
	SamplingRule interface{} `field:"optional" json:"samplingRule" yaml:"samplingRule"`
}

A [SamplingRule](https://docs.aws.amazon.com//xray/latest/api/API_SamplingRule.html) and its metadata.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

samplingRuleRecordProperty := &samplingRuleRecordProperty{
	createdAt: jsii.String("createdAt"),
	modifiedAt: jsii.String("modifiedAt"),
	samplingRule: &samplingRuleProperty{
		attributes: map[string]*string{
			"attributesKey": jsii.String("attributes"),
		},
		fixedRate: jsii.Number(123),
		host: jsii.String("host"),
		httpMethod: jsii.String("httpMethod"),
		priority: jsii.Number(123),
		reservoirSize: jsii.Number(123),
		resourceArn: jsii.String("resourceArn"),
		ruleArn: jsii.String("ruleArn"),
		ruleName: jsii.String("ruleName"),
		serviceName: jsii.String("serviceName"),
		serviceType: jsii.String("serviceType"),
		urlPath: jsii.String("urlPath"),
		version: jsii.Number(123),
	},
}

type CfnSamplingRule_SamplingRuleUpdateProperty 

type CfnSamplingRule_SamplingRuleUpdateProperty struct {
	// 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.
	Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"`
	// The percentage of matching requests to instrument, after the reservoir is exhausted.
	FixedRate *float64 `field:"optional" json:"fixedRate" yaml:"fixedRate"`
	// Matches the hostname from a request URL.
	Host *string `field:"optional" json:"host" yaml:"host"`
	// Matches the HTTP method of a request.
	HttpMethod *string `field:"optional" json:"httpMethod" yaml:"httpMethod"`
	// The priority of the sampling rule.
	Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
	// 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.
	ReservoirSize *float64 `field:"optional" json:"reservoirSize" yaml:"reservoirSize"`
	// Matches the ARN of the AWS resource on which the service runs.
	ResourceArn *string `field:"optional" json:"resourceArn" yaml:"resourceArn"`
	// The ARN of the sampling rule.
	//
	// You must specify either RuleARN or RuleName, but not both.
	RuleArn *string `field:"optional" json:"ruleArn" yaml:"ruleArn"`
	// The name of the sampling rule.
	//
	// You must specify either RuleARN or RuleName, but not both.
	RuleName *string `field:"optional" json:"ruleName" yaml:"ruleName"`
	// Matches the `name` that the service uses to identify itself in segments.
	ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
	// Matches the `origin` that the service uses to identify its type in segments.
	ServiceType *string `field:"optional" json:"serviceType" yaml:"serviceType"`
	// Matches the path from a request URL.
	UrlPath *string `field:"optional" json:"urlPath" yaml:"urlPath"`
}

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

samplingRuleUpdateProperty := &samplingRuleUpdateProperty{
	attributes: map[string]*string{
		"attributesKey": jsii.String("attributes"),
	},
	fixedRate: jsii.Number(123),
	host: jsii.String("host"),
	httpMethod: jsii.String("httpMethod"),
	priority: jsii.Number(123),
	reservoirSize: jsii.Number(123),
	resourceArn: jsii.String("resourceArn"),
	ruleArn: jsii.String("ruleArn"),
	ruleName: jsii.String("ruleName"),
	serviceName: jsii.String("serviceName"),
	serviceType: jsii.String("serviceType"),
	urlPath: jsii.String("urlPath"),
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.