Documentation
¶
Index ¶
- func CfnGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGroup_IsCfnElement(x interface{}) *bool
- func CfnGroup_IsCfnResource(x interface{}) *bool
- func CfnGroup_IsConstruct(x interface{}) *bool
- func CfnResourcePolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourcePolicy_IsCfnElement(x interface{}) *bool
- func CfnResourcePolicy_IsCfnResource(x interface{}) *bool
- func CfnResourcePolicy_IsConstruct(x interface{}) *bool
- func CfnSamplingRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSamplingRule_IsCfnElement(x interface{}) *bool
- func CfnSamplingRule_IsCfnResource(x interface{}) *bool
- func CfnSamplingRule_IsConstruct(x interface{}) *bool
- func CfnTransactionSearchConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransactionSearchConfig_IsCfnElement(x interface{}) *bool
- func CfnTransactionSearchConfig_IsCfnResource(x interface{}) *bool
- func CfnTransactionSearchConfig_IsConstruct(x interface{}) *bool
- func NewCfnGroup_Override(c CfnGroup, scope constructs.Construct, id *string, props *CfnGroupProps)
- func NewCfnResourcePolicy_Override(c CfnResourcePolicy, scope constructs.Construct, id *string, ...)
- func NewCfnSamplingRule_Override(c CfnSamplingRule, scope constructs.Construct, id *string, ...)
- func NewCfnTransactionSearchConfig_Override(c CfnTransactionSearchConfig, scope constructs.Construct, id *string, ...)
- type CfnGroup
- type CfnGroupProps
- type CfnGroup_InsightsConfigurationProperty
- type CfnResourcePolicy
- type CfnResourcePolicyProps
- type CfnSamplingRule
- type CfnSamplingRuleProps
- type CfnSamplingRule_SamplingRuleProperty
- type CfnSamplingRule_SamplingRuleRecordProperty
- type CfnSamplingRule_SamplingRuleUpdateProperty
- type CfnTransactionSearchConfig
- type CfnTransactionSearchConfigProps
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.
func CfnGroup_IsCfnResource ¶
func CfnGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGroup_IsConstruct ¶
func CfnGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnResourcePolicy_CFN_RESOURCE_TYPE_NAME ¶ added in v2.51.0
func CfnResourcePolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourcePolicy_IsCfnElement ¶ added in v2.51.0
func CfnResourcePolicy_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.
func CfnResourcePolicy_IsCfnResource ¶ added in v2.51.0
func CfnResourcePolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnResourcePolicy_IsConstruct ¶ added in v2.51.0
func CfnResourcePolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnSamplingRule_IsCfnResource ¶
func CfnSamplingRule_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSamplingRule_IsConstruct ¶
func CfnSamplingRule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTransactionSearchConfig_CFN_RESOURCE_TYPE_NAME ¶ added in v2.183.0
func CfnTransactionSearchConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransactionSearchConfig_IsCfnElement ¶ added in v2.183.0
func CfnTransactionSearchConfig_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.
func CfnTransactionSearchConfig_IsCfnResource ¶ added in v2.183.0
func CfnTransactionSearchConfig_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransactionSearchConfig_IsConstruct ¶ added in v2.183.0
func CfnTransactionSearchConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnGroup_Override ¶
func NewCfnGroup_Override(c CfnGroup, scope constructs.Construct, id *string, props *CfnGroupProps)
Create a new `AWS::XRay::Group`.
func NewCfnResourcePolicy_Override ¶ added in v2.51.0
func NewCfnResourcePolicy_Override(c CfnResourcePolicy, scope constructs.Construct, id *string, props *CfnResourcePolicyProps)
Create a new `AWS::XRay::ResourcePolicy`.
func NewCfnSamplingRule_Override ¶
func NewCfnSamplingRule_Override(c CfnSamplingRule, scope constructs.Construct, id *string, props *CfnSamplingRuleProps)
Create a new `AWS::XRay::SamplingRule`.
func NewCfnTransactionSearchConfig_Override ¶ added in v2.183.0
func NewCfnTransactionSearchConfig_Override(c CfnTransactionSearchConfig, scope constructs.Construct, id *string, props *CfnTransactionSearchConfigProps)
Create a new `AWS::XRay::TransactionSearchConfig`.
Types ¶
type CfnGroup ¶
type CfnGroup interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsxray.IGroupRef
awscdk.ITaggableV2
// The group ARN that was created or updated.
AttrGroupArn() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// 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)
// A reference to a Group resource.
GroupRef() *interfacesawsxray.GroupReference
// The structure containing configurations related to insights.
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.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// An array of key-value pairs to apply to this resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]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.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Use the `AWS::XRay::Group` resource to specify a group with a name and a filter expression.
Groups enable the collection of traces that match the filter expression, can be used to filter service graphs and traces, and to supply Amazon CloudWatch metrics.
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"
cfnGroup := awscdk.Aws_xray.NewCfnGroup(this, jsii.String("MyCfnGroup"), &CfnGroupProps{
GroupName: jsii.String("groupName"),
// the properties below are optional
FilterExpression: jsii.String("filterExpression"),
InsightsConfiguration: &InsightsConfigurationProperty{
InsightsEnabled: jsii.Boolean(false),
NotificationsEnabled: jsii.Boolean(false),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html
func NewCfnGroup ¶
func NewCfnGroup(scope constructs.Construct, id *string, props *CfnGroupProps) CfnGroup
Create a new `AWS::XRay::Group`.
type CfnGroupProps ¶
type CfnGroupProps struct {
// The unique case-sensitive name of the group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-groupname
//
GroupName *string `field:"required" json:"groupName" yaml:"groupName"`
// The filter expression defining the parameters to include traces.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-filterexpression
//
FilterExpression *string `field:"optional" json:"filterExpression" yaml:"filterExpression"`
// 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-insightsconfiguration
//
InsightsConfiguration interface{} `field:"optional" json:"insightsConfiguration" yaml:"insightsConfiguration"`
// An array of key-value pairs to apply to this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-tags
//
Tags *[]*awscdk.CfnTag `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"
cfnGroupProps := &CfnGroupProps{
GroupName: jsii.String("groupName"),
// the properties below are optional
FilterExpression: jsii.String("filterExpression"),
InsightsConfiguration: &InsightsConfigurationProperty{
InsightsEnabled: jsii.Boolean(false),
NotificationsEnabled: jsii.Boolean(false),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html
type CfnGroup_InsightsConfigurationProperty ¶
type CfnGroup_InsightsConfigurationProperty struct {
// Set the InsightsEnabled value to true to enable insights or false to disable insights.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-insightsconfiguration.html#cfn-xray-group-insightsconfiguration-insightsenabled
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-insightsconfiguration.html#cfn-xray-group-insightsconfiguration-notificationsenabled
//
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 CfnResourcePolicy ¶ added in v2.51.0
type CfnResourcePolicy interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsxray.IResourcePolicyRef
// A flag to indicate whether to bypass the resource-based policy lockout safety check.
BypassPolicyLockoutCheck() interface{}
SetBypassPolicyLockoutCheck(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// 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.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The resource-based policy document, which can be up to 5kb in size.
PolicyDocument() *string
SetPolicyDocument(val *string)
// The name of the resource-based policy.
PolicyName() *string
SetPolicyName(val *string)
// 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 })`.
Ref() *string
// A reference to a ResourcePolicy resource.
ResourcePolicyRef() *interfacesawsxray.ResourcePolicyReference
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]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.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Use `AWS::XRay::ResourcePolicy` to specify an X-Ray resource-based policy, which grants one or more AWS services and accounts permissions to access X-Ray .
Each resource-based policy is associated with a specific AWS account.
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"
cfnResourcePolicy := awscdk.Aws_xray.NewCfnResourcePolicy(this, jsii.String("MyCfnResourcePolicy"), &CfnResourcePolicyProps{
PolicyDocument: jsii.String("policyDocument"),
PolicyName: jsii.String("policyName"),
// the properties below are optional
BypassPolicyLockoutCheck: jsii.Boolean(false),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html
func NewCfnResourcePolicy ¶ added in v2.51.0
func NewCfnResourcePolicy(scope constructs.Construct, id *string, props *CfnResourcePolicyProps) CfnResourcePolicy
Create a new `AWS::XRay::ResourcePolicy`.
type CfnResourcePolicyProps ¶ added in v2.51.0
type CfnResourcePolicyProps struct {
// The resource-based policy document, which can be up to 5kb in size.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policydocument
//
PolicyDocument *string `field:"required" json:"policyDocument" yaml:"policyDocument"`
// The name of the resource-based policy.
//
// Must be unique within a specific AWS account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policyname
//
PolicyName *string `field:"required" json:"policyName" yaml:"policyName"`
// A flag to indicate whether to bypass the resource-based policy lockout safety check.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-bypasspolicylockoutcheck
//
BypassPolicyLockoutCheck interface{} `field:"optional" json:"bypassPolicyLockoutCheck" yaml:"bypassPolicyLockoutCheck"`
}
Properties for defining a `CfnResourcePolicy`.
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"
cfnResourcePolicyProps := &CfnResourcePolicyProps{
PolicyDocument: jsii.String("policyDocument"),
PolicyName: jsii.String("policyName"),
// the properties below are optional
BypassPolicyLockoutCheck: jsii.Boolean(false),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html
type CfnSamplingRule ¶
type CfnSamplingRule interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsxray.ISamplingRuleRef
awscdk.ITaggableV2
// The sampling rule ARN that was created or updated.
AttrRuleArn() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// 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.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The ARN of the sampling rule.
// Deprecated: this property has been deprecated.
RuleName() *string
// Deprecated: this property has been deprecated.
SetRuleName(val *string)
// The sampling rule to be created or updated.
SamplingRule() interface{}
SetSamplingRule(val interface{})
// Deprecated: this property has been deprecated.
SamplingRuleRecord() interface{}
// Deprecated: this property has been deprecated.
SetSamplingRuleRecord(val interface{})
// A reference to a SamplingRule resource.
SamplingRuleRef() *interfacesawsxray.SamplingRuleReference
// Deprecated: this property has been deprecated.
SamplingRuleUpdate() interface{}
// Deprecated: this property has been deprecated.
SetSamplingRuleUpdate(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// An array of key-value pairs to apply to this resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]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.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Use the `AWS::XRay::SamplingRule` resource to specify a sampling rule, which controls sampling behavior for instrumented applications.
Include a `SamplingRule` entity to create or update a sampling rule.
> `SamplingRule.Version` can only be set when creating a sampling rule. Updating the version will cause the update to fail.
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"
cfnSamplingRule := awscdk.Aws_xray.NewCfnSamplingRule(this, jsii.String("MyCfnSamplingRule"), &CfnSamplingRuleProps{
RuleName: jsii.String("ruleName"),
SamplingRule: &SamplingRuleProperty{
FixedRate: jsii.Number(123),
Host: jsii.String("host"),
HttpMethod: jsii.String("httpMethod"),
Priority: jsii.Number(123),
ReservoirSize: jsii.Number(123),
ResourceArn: jsii.String("resourceArn"),
ServiceName: jsii.String("serviceName"),
ServiceType: jsii.String("serviceType"),
UrlPath: jsii.String("urlPath"),
// the properties below are optional
Attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
RuleArn: jsii.String("ruleArn"),
RuleName: jsii.String("ruleName"),
Version: jsii.Number(123),
},
SamplingRuleRecord: &SamplingRuleRecordProperty{
CreatedAt: jsii.String("createdAt"),
ModifiedAt: jsii.String("modifiedAt"),
SamplingRule: &SamplingRuleProperty{
FixedRate: jsii.Number(123),
Host: jsii.String("host"),
HttpMethod: jsii.String("httpMethod"),
Priority: jsii.Number(123),
ReservoirSize: jsii.Number(123),
ResourceArn: jsii.String("resourceArn"),
ServiceName: jsii.String("serviceName"),
ServiceType: jsii.String("serviceType"),
UrlPath: jsii.String("urlPath"),
// the properties below are optional
Attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
RuleArn: jsii.String("ruleArn"),
RuleName: jsii.String("ruleName"),
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: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html
func NewCfnSamplingRule ¶
func NewCfnSamplingRule(scope constructs.Construct, id *string, props *CfnSamplingRuleProps) CfnSamplingRule
Create a new `AWS::XRay::SamplingRule`.
type CfnSamplingRuleProps ¶
type CfnSamplingRuleProps struct {
// The ARN of the sampling rule.
//
// Specify a rule by either name or ARN, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-rulename
//
// Deprecated: this property has been deprecated.
RuleName *string `field:"optional" json:"ruleName" yaml:"ruleName"`
// The sampling rule to be created or updated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-samplingrule
//
SamplingRule interface{} `field:"optional" json:"samplingRule" yaml:"samplingRule"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-samplingrulerecord
//
// Deprecated: this property has been deprecated.
SamplingRuleRecord interface{} `field:"optional" json:"samplingRuleRecord" yaml:"samplingRuleRecord"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-samplingruleupdate
//
// Deprecated: this property has been deprecated.
SamplingRuleUpdate interface{} `field:"optional" json:"samplingRuleUpdate" yaml:"samplingRuleUpdate"`
// An array of key-value pairs to apply to this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-tags
//
Tags *[]*awscdk.CfnTag `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"
cfnSamplingRuleProps := &CfnSamplingRuleProps{
RuleName: jsii.String("ruleName"),
SamplingRule: &SamplingRuleProperty{
FixedRate: jsii.Number(123),
Host: jsii.String("host"),
HttpMethod: jsii.String("httpMethod"),
Priority: jsii.Number(123),
ReservoirSize: jsii.Number(123),
ResourceArn: jsii.String("resourceArn"),
ServiceName: jsii.String("serviceName"),
ServiceType: jsii.String("serviceType"),
UrlPath: jsii.String("urlPath"),
// the properties below are optional
Attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
RuleArn: jsii.String("ruleArn"),
RuleName: jsii.String("ruleName"),
Version: jsii.Number(123),
},
SamplingRuleRecord: &SamplingRuleRecordProperty{
CreatedAt: jsii.String("createdAt"),
ModifiedAt: jsii.String("modifiedAt"),
SamplingRule: &SamplingRuleProperty{
FixedRate: jsii.Number(123),
Host: jsii.String("host"),
HttpMethod: jsii.String("httpMethod"),
Priority: jsii.Number(123),
ReservoirSize: jsii.Number(123),
ResourceArn: jsii.String("resourceArn"),
ServiceName: jsii.String("serviceName"),
ServiceType: jsii.String("serviceType"),
UrlPath: jsii.String("urlPath"),
// the properties below are optional
Attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
RuleArn: jsii.String("ruleArn"),
RuleName: jsii.String("ruleName"),
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: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html
type CfnSamplingRule_SamplingRuleProperty ¶
type CfnSamplingRule_SamplingRuleProperty struct {
// The percentage of matching requests to instrument, after the reservoir is exhausted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-fixedrate
//
FixedRate *float64 `field:"required" json:"fixedRate" yaml:"fixedRate"`
// Matches the hostname from a request URL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-host
//
Host *string `field:"required" json:"host" yaml:"host"`
// Matches the HTTP method of a request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-httpmethod
//
HttpMethod *string `field:"required" json:"httpMethod" yaml:"httpMethod"`
// The priority of the sampling rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-priority
//
Priority *float64 `field:"required" 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-reservoirsize
//
ReservoirSize *float64 `field:"required" json:"reservoirSize" yaml:"reservoirSize"`
// Matches the ARN of the AWS resource on which the service runs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-resourcearn
//
ResourceArn *string `field:"required" json:"resourceArn" yaml:"resourceArn"`
// Matches the `name` that the service uses to identify itself in segments.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-servicename
//
ServiceName *string `field:"required" json:"serviceName" yaml:"serviceName"`
// Matches the `origin` that the service uses to identify its type in segments.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-servicetype
//
ServiceType *string `field:"required" json:"serviceType" yaml:"serviceType"`
// Matches the path from a request URL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-urlpath
//
UrlPath *string `field:"required" json:"urlPath" yaml:"urlPath"`
// 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-attributes
//
Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"`
// The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
//
// > Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-rulearn
//
RuleArn *string `field:"optional" json:"ruleArn" yaml:"ruleArn"`
// The name of the sampling rule.
//
// Specify a rule by either name or ARN, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-rulename
//
RuleName *string `field:"optional" json:"ruleName" yaml:"ruleName"`
// The version of the sampling rule.
//
// `Version` can only be set when creating a new sampling rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-version
//
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{
FixedRate: jsii.Number(123),
Host: jsii.String("host"),
HttpMethod: jsii.String("httpMethod"),
Priority: jsii.Number(123),
ReservoirSize: jsii.Number(123),
ResourceArn: jsii.String("resourceArn"),
ServiceName: jsii.String("serviceName"),
ServiceType: jsii.String("serviceType"),
UrlPath: jsii.String("urlPath"),
// the properties below are optional
Attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
RuleArn: jsii.String("ruleArn"),
RuleName: jsii.String("ruleName"),
Version: jsii.Number(123),
}
type CfnSamplingRule_SamplingRuleRecordProperty ¶
type CfnSamplingRule_SamplingRuleRecordProperty struct {
// When the rule was created, in Unix time seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-createdat
//
CreatedAt *string `field:"optional" json:"createdAt" yaml:"createdAt"`
// When the rule was modified, in Unix time seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-modifiedat
//
ModifiedAt *string `field:"optional" json:"modifiedAt" yaml:"modifiedAt"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-samplingrule
//
SamplingRule interface{} `field:"optional" json:"samplingRule" yaml:"samplingRule"`
}
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{
FixedRate: jsii.Number(123),
Host: jsii.String("host"),
HttpMethod: jsii.String("httpMethod"),
Priority: jsii.Number(123),
ReservoirSize: jsii.Number(123),
ResourceArn: jsii.String("resourceArn"),
ServiceName: jsii.String("serviceName"),
ServiceType: jsii.String("serviceType"),
UrlPath: jsii.String("urlPath"),
// the properties below are optional
Attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
RuleArn: jsii.String("ruleArn"),
RuleName: jsii.String("ruleName"),
Version: jsii.Number(123),
},
}
type CfnSamplingRule_SamplingRuleUpdateProperty ¶
type CfnSamplingRule_SamplingRuleUpdateProperty struct {
// Matches attributes derived from the request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-attributes
//
Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"`
// The percentage of matching requests to instrument, after the reservoir is exhausted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-fixedrate
//
FixedRate *float64 `field:"optional" json:"fixedRate" yaml:"fixedRate"`
// Matches the hostname from a request URL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-host
//
Host *string `field:"optional" json:"host" yaml:"host"`
// Matches the HTTP method from a request URL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-httpmethod
//
HttpMethod *string `field:"optional" json:"httpMethod" yaml:"httpMethod"`
// The priority of the sampling rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-priority
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-reservoirsize
//
ReservoirSize *float64 `field:"optional" json:"reservoirSize" yaml:"reservoirSize"`
// Matches the ARN of the AWS resource on which the service runs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-resourcearn
//
ResourceArn *string `field:"optional" json:"resourceArn" yaml:"resourceArn"`
// The ARN of the sampling rule.
//
// Specify a rule by either name or ARN, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-rulearn
//
RuleArn *string `field:"optional" json:"ruleArn" yaml:"ruleArn"`
// The ARN of the sampling rule.
//
// Specify a rule by either name or ARN, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-rulename
//
RuleName *string `field:"optional" json:"ruleName" yaml:"ruleName"`
// Matches the name that the service uses to identify itself in segments.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-servicename
//
ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
// Matches the origin that the service uses to identify its type in segments.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-servicetype
//
ServiceType *string `field:"optional" json:"serviceType" yaml:"serviceType"`
// Matches the path from a request URL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html#cfn-xray-samplingrule-samplingruleupdate-urlpath
//
UrlPath *string `field:"optional" json:"urlPath" yaml:"urlPath"`
}
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"),
}
type CfnTransactionSearchConfig ¶ added in v2.183.0
type CfnTransactionSearchConfig interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsxray.ITransactionSearchConfigRef
// User account id, used as the primary identifier for the resource.
AttrAccountId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// Determines the percentage of traces indexed from CloudWatch Logs to X-Ray.
IndexingPercentage() *float64
SetIndexingPercentage(val *float64)
// 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.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A reference to a TransactionSearchConfig resource.
TransactionSearchConfigRef() *interfacesawsxray.TransactionSearchConfigReference
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]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.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
This schema provides construct and validation rules for AWS-XRay TransactionSearchConfig resource parameters.
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"
cfnTransactionSearchConfig := awscdk.Aws_xray.NewCfnTransactionSearchConfig(this, jsii.String("MyCfnTransactionSearchConfig"), &CfnTransactionSearchConfigProps{
IndexingPercentage: jsii.Number(123),
})
func NewCfnTransactionSearchConfig ¶ added in v2.183.0
func NewCfnTransactionSearchConfig(scope constructs.Construct, id *string, props *CfnTransactionSearchConfigProps) CfnTransactionSearchConfig
Create a new `AWS::XRay::TransactionSearchConfig`.
type CfnTransactionSearchConfigProps ¶ added in v2.183.0
type CfnTransactionSearchConfigProps struct {
// Determines the percentage of traces indexed from CloudWatch Logs to X-Ray.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-transactionsearchconfig.html#cfn-xray-transactionsearchconfig-indexingpercentage
//
IndexingPercentage *float64 `field:"optional" json:"indexingPercentage" yaml:"indexingPercentage"`
}
Properties for defining a `CfnTransactionSearchConfig`.
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"
cfnTransactionSearchConfigProps := &CfnTransactionSearchConfigProps{
IndexingPercentage: jsii.Number(123),
}
Source Files
¶
- CfnGroup.go
- CfnGroupProps.go
- CfnGroup_InsightsConfigurationProperty.go
- CfnGroup__checks.go
- CfnResourcePolicy.go
- CfnResourcePolicyProps.go
- CfnResourcePolicy__checks.go
- CfnSamplingRule.go
- CfnSamplingRuleProps.go
- CfnSamplingRule_SamplingRuleProperty.go
- CfnSamplingRule_SamplingRuleRecordProperty.go
- CfnSamplingRule_SamplingRuleUpdateProperty.go
- CfnSamplingRule__checks.go
- CfnTransactionSearchConfig.go
- CfnTransactionSearchConfigProps.go
- CfnTransactionSearchConfig__checks.go
- main.go