Documentation
¶
Index ¶
- func CfnGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGroup_IsCfnElement(x interface{}) *bool
- func CfnGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGroup_IsConstruct(x interface{}) *bool
- func CfnSamplingRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSamplingRule_IsCfnElement(x interface{}) *bool
- func CfnSamplingRule_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSamplingRule_IsConstruct(x interface{}) *bool
- func NewCfnGroup_Override(c CfnGroup, scope awscdk.Construct, id *string, props *CfnGroupProps)
- func NewCfnSamplingRule_Override(c CfnSamplingRule, scope awscdk.Construct, id *string, ...)
- type CfnGroup
- type CfnGroupProps
- type CfnGroup_InsightsConfigurationProperty
- type CfnSamplingRule
- type CfnSamplingRuleProps
- type CfnSamplingRule_SamplingRuleProperty
- type CfnSamplingRule_SamplingRuleRecordProperty
- type CfnSamplingRule_SamplingRuleUpdateProperty
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
AttrGroupArn() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
FilterExpression() *string
SetFilterExpression(val *string)
GroupName() *string
SetGroupName(val *string)
InsightsConfiguration() interface{}
SetInsightsConfiguration(val interface{})
LogicalId() *string
Node() awscdk.ConstructNode
Ref() *string
Stack() awscdk.Stack
Tags() *[]interface{}
SetTags(val *[]interface{})
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
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.
TODO: EXAMPLE
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 `json:"filterExpression" yaml:"filterExpression"`
// The unique case-sensitive name of the group.
GroupName *string `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{} `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{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnGroup`.
TODO: EXAMPLE
type CfnGroup_InsightsConfigurationProperty ¶
type CfnGroup_InsightsConfigurationProperty struct {
// Set the InsightsEnabled value to true to enable insights or false to disable insights.
InsightsEnabled interface{} `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{} `json:"notificationsEnabled" yaml:"notificationsEnabled"`
}
The structure containing configurations related to insights.
TODO: EXAMPLE
type CfnSamplingRule ¶
type CfnSamplingRule interface {
awscdk.CfnResource
awscdk.IInspectable
AttrRuleArn() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
Node() awscdk.ConstructNode
Ref() *string
RuleName() *string
SetRuleName(val *string)
SamplingRule() interface{}
SetSamplingRule(val interface{})
SamplingRuleRecord() interface{}
SetSamplingRuleRecord(val interface{})
SamplingRuleUpdate() interface{}
SetSamplingRuleUpdate(val interface{})
Stack() awscdk.Stack
Tags() *[]interface{}
SetTags(val *[]interface{})
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
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.
TODO: EXAMPLE
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 `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{} `json:"samplingRule" yaml:"samplingRule"`
// `AWS::XRay::SamplingRule.SamplingRuleRecord`.
SamplingRuleRecord interface{} `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{} `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{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSamplingRule`.
TODO: EXAMPLE
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{} `json:"attributes" yaml:"attributes"`
// The percentage of matching requests to instrument, after the reservoir is exhausted.
FixedRate *float64 `json:"fixedRate" yaml:"fixedRate"`
// Matches the hostname from a request URL.
Host *string `json:"host" yaml:"host"`
// Matches the HTTP method of a request.
HttpMethod *string `json:"httpMethod" yaml:"httpMethod"`
// The priority of the sampling rule.
Priority *float64 `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 `json:"reservoirSize" yaml:"reservoirSize"`
// Matches the ARN of the AWS resource on which the service runs.
ResourceArn *string `json:"resourceArn" yaml:"resourceArn"`
// The ARN of the sampling rule.
//
// You must specify either RuleARN or RuleName, but not both.
RuleArn *string `json:"ruleArn" yaml:"ruleArn"`
// The name of the sampling rule.
//
// You must specify either RuleARN or RuleName, but not both.
RuleName *string `json:"ruleName" yaml:"ruleName"`
// Matches the `name` that the service uses to identify itself in segments.
ServiceName *string `json:"serviceName" yaml:"serviceName"`
// Matches the `origin` that the service uses to identify its type in segments.
ServiceType *string `json:"serviceType" yaml:"serviceType"`
// Matches the path from a request URL.
UrlPath *string `json:"urlPath" yaml:"urlPath"`
// The version of the sampling rule format ( `1` ).
Version *float64 `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.
TODO: EXAMPLE
type CfnSamplingRule_SamplingRuleRecordProperty ¶
type CfnSamplingRule_SamplingRuleRecordProperty struct {
// When the rule was created, in Unix time seconds.
CreatedAt *string `json:"createdAt" yaml:"createdAt"`
// When the rule was last modified, in Unix time seconds.
ModifiedAt *string `json:"modifiedAt" yaml:"modifiedAt"`
// The sampling rule.
SamplingRule interface{} `json:"samplingRule" yaml:"samplingRule"`
}
A [SamplingRule](https://docs.aws.amazon.com//xray/latest/api/API_SamplingRule.html) and its metadata.
TODO: EXAMPLE
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{} `json:"attributes" yaml:"attributes"`
// The percentage of matching requests to instrument, after the reservoir is exhausted.
FixedRate *float64 `json:"fixedRate" yaml:"fixedRate"`
// Matches the hostname from a request URL.
Host *string `json:"host" yaml:"host"`
// Matches the HTTP method of a request.
HttpMethod *string `json:"httpMethod" yaml:"httpMethod"`
// The priority of the sampling rule.
Priority *float64 `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 `json:"reservoirSize" yaml:"reservoirSize"`
// Matches the ARN of the AWS resource on which the service runs.
ResourceArn *string `json:"resourceArn" yaml:"resourceArn"`
// The ARN of the sampling rule.
//
// You must specify either RuleARN or RuleName, but not both.
RuleArn *string `json:"ruleArn" yaml:"ruleArn"`
// The name of the sampling rule.
//
// You must specify either RuleARN or RuleName, but not both.
RuleName *string `json:"ruleName" yaml:"ruleName"`
// Matches the `name` that the service uses to identify itself in segments.
ServiceName *string `json:"serviceName" yaml:"serviceName"`
// Matches the `origin` that the service uses to identify its type in segments.
ServiceType *string `json:"serviceType" yaml:"serviceType"`
// Matches the path from a request URL.
UrlPath *string `json:"urlPath" yaml:"urlPath"`
}
A document specifying changes to a sampling rule's configuration.
TODO: EXAMPLE