Aws/xray
@swamp/aws/xrayv2026.06.08.2
01README
AWS XRAY infrastructure models
02Release Notes
- Updated: group, resource_policy, sampling_rule, transaction_search_config
03Models
@swamp/aws/xray/groupv2026.06.08.1group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1. |
| FilterExpression? | string | The filter expression defining criteria by which to group traces. |
| GroupName | string | The case-sensitive name of the new group. Names must be unique. |
| InsightsConfiguration? | object | |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a XRay Group
fn get(identifier: string)
Get a XRay Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay Group |
fn update()
Update a XRay Group
fn delete(identifier: string)
Delete a XRay Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay Group |
fn sync()
Sync XRay Group state from AWS
Resources
state(infinite)— XRay Group resource state
@swamp/aws/xray/resource-policyv2026.06.08.1resource_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1. |
| PolicyName | string | The name of the resource policy. Must be unique within a specific AWS account. |
| PolicyDocument | string | The resource policy document, which can be up to 5kb in size. |
| BypassPolicyLockoutCheck? | boolean | A flag to indicate whether to bypass the resource policy lockout safety check |
fn create()
Create a XRay ResourcePolicy
fn get(identifier: string)
Get a XRay ResourcePolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay ResourcePolicy |
fn update()
Update a XRay ResourcePolicy
fn delete(identifier: string)
Delete a XRay ResourcePolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay ResourcePolicy |
fn sync()
Sync XRay ResourcePolicy state from AWS
Resources
state(infinite)— XRay ResourcePolicy resource state
@swamp/aws/xray/sampling-rulev2026.06.08.1sampling_rule.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1. |
| SamplingRule? | object | |
| SamplingRuleRecord? | object | |
| SamplingRuleUpdate? | object | |
| RuleName? | 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. |
fn create()
Create a XRay SamplingRule
fn get(identifier: string)
Get a XRay SamplingRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay SamplingRule |
fn update()
Update a XRay SamplingRule
fn delete(identifier: string)
Delete a XRay SamplingRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay SamplingRule |
fn sync()
Sync XRay SamplingRule state from AWS
Resources
state(infinite)— XRay SamplingRule resource state
@swamp/aws/xray/transaction-search-configv2026.06.08.1transaction_search_config.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1. |
| IndexingPercentage? | number | Determines the percentage of traces indexed from CloudWatch Logs to X-Ray |
fn create()
Create a XRay TransactionSearchConfig
fn get(identifier: string)
Get a XRay TransactionSearchConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay TransactionSearchConfig |
fn update()
Update a XRay TransactionSearchConfig
fn delete(identifier: string)
Delete a XRay TransactionSearchConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the XRay TransactionSearchConfig |
fn sync()
Sync XRay TransactionSearchConfig state from AWS
Resources
state(infinite)— XRay TransactionSearchConfig resource state
04Previous Versions
2026.06.06.1Jun 6, 2026
- Updated: group, resource_policy, sampling_rule, transaction_search_config
2026.04.23.3Apr 23, 2026
2026.04.23.2Apr 23, 2026
- Updated: group, resource_policy, sampling_rule, transaction_search_config
2026.04.03.2Apr 3, 2026
- Updated: group, resource_policy, sampling_rule, transaction_search_config
2026.03.19.1Mar 19, 2026
- Updated: group, resource_policy, sampling_rule, transaction_search_config
2026.03.16.1Mar 16, 2026
- Updated: group, resource_policy, sampling_rule, transaction_search_config
2026.03.10.5Mar 10, 2026
05Stats
B
85 / 100
Downloads
0
Archive size
947.7 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit0/2missing
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels