sampling_rules

Creates, updates, deletes or gets a sampling_rule resource or lists sampling_rules in a region

Overview

Name	sampling_rules
Type	Resource
Description	This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Id	awscc.xray.sampling_rules

Fields

get (all properties)

Name	Datatype	Description
▶sampling_rule	object	This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
▶sampling_rule_record	object
▶sampling_rule_update	object
rule_arn	string	The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
rule_name	string	The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
rule_arn	string	The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
region	string	AWS region.

For more information, see AWS::XRay::SamplingRule.

Methods

Name	Resource	Accessible by	Required Params
create_resource	sampling_rules	INSERT	region
delete_resource	sampling_rules	DELETE	Identifier, region
update_resource	sampling_rules	UPDATE	Identifier, PatchDocument, region
list_resources	sampling_rules_list_only	SELECT	region
get_resource	sampling_rules	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual sampling_rule.

SELECT
  region,
  sampling_rule,
  sampling_rule_record,
  sampling_rule_update,
  rule_arn,
  rule_name,
  tags
FROM awscc.xray.sampling_rules
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ rule_arn }}';

list (identifiers only)

Lists all sampling_rules in a region.

SELECT
  region,
  rule_arn
FROM awscc.xray.sampling_rules_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new sampling_rule resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.xray.sampling_rules (
  SamplingRule,
  SamplingRuleRecord,
  SamplingRuleUpdate,
  RuleName,
  Tags,
  region
)
SELECT
  '{{ sampling_rule }}',
  '{{ sampling_rule_record }}',
  '{{ sampling_rule_update }}',
  '{{ rule_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.xray.sampling_rules (
  SamplingRule,
  SamplingRuleRecord,
  SamplingRuleUpdate,
  RuleName,
  Tags,
  region
)
SELECT
  '{{ sampling_rule }}',
  '{{ sampling_rule_record }}',
  '{{ sampling_rule_update }}',
  '{{ rule_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: sampling_rule
  props:
    - name: sampling_rule
      value:
        sampling_rule: null
        sampling_rule_record:
          created_at: '{{ created_at }}'
          modified_at: '{{ modified_at }}'
          sampling_rule: null
        sampling_rule_update:
          attributes: {}
          fixed_rate: null
          host: '{{ host }}'
          h_tt_pmethod: '{{ h_tt_pmethod }}'
          priority: '{{ priority }}'
          reservoir_size: '{{ reservoir_size }}'
          resource_arn: '{{ resource_arn }}'
          rule_arn: '{{ rule_arn }}'
          rule_name: '{{ rule_name }}'
          service_name: '{{ service_name }}'
          service_type: '{{ service_type }}'
          url_path: '{{ url_path }}'
        rule_name: null
        tags:
          - key: '{{ key }}'
            value: '{{ value }}'
    - name: sampling_rule_record
      value: null
    - name: sampling_rule_update
      value: null
    - name: rule_name
      value: null
    - name: tags
      value: null

UPDATE example

Use the following StackQL query and manifest file to update a sampling_rule resource, using stack-deploy.

/*+ update */
UPDATE awscc.xray.sampling_rules
SET PatchDocument = string('{{ {
    "SamplingRuleRecord": sampling_rule_record,
    "SamplingRuleUpdate": sampling_rule_update,
    "RuleName": rule_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ rule_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.xray.sampling_rules
WHERE
  Identifier = '{{ rule_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the sampling_rules resource, the following permissions are required:

Create

xray:CreateSamplingRule,
xray:TagResource,
xray:ListTagsForResource

Read

xray:GetSamplingRules,
xray:ListTagsForResource

Update

xray:UpdateSamplingRule,
xray:TagResource,
xray:UntagResource,
xray:ListTagsForResource

Delete

xray:DeleteSamplingRule

List

xray:GetSamplingRules,
xray:ListTagsForResource