Aws/xray

@swamp/aws/xrayv2026.09.11.1· 1d agoMODELS

01README

AWS XRAY infrastructure models

02Models4

@swamp/aws/xray/groupv2026.08.17.2group.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
FilterExpression?	string	no	The filter expression defining criteria by which to group traces.
GroupName	string	yes	The case-sensitive name of the new group. Names must be unique.
InsightsConfiguration?	object	no
Tags?	array	no	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	Required	Description
identifier	string	yes	The primary identifier of the XRay Group

fn update()

Update a XRay Group

fn delete(identifier: string)

Delete a XRay Group

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the XRay Group

fn sync()

Sync XRay Group state from AWS

fn list(maxPages?: number, resourceModel?: string)

List XRay Group resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— XRay Group resource state

@swamp/aws/xray/resource-policyv2026.08.17.2resource_policy.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
PolicyName	string	yes	The name of the resource policy. Must be unique within a specific AWS account.
PolicyDocument	string	yes	The resource policy document, which can be up to 5kb in size.
BypassPolicyLockoutCheck?	boolean	no	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	Required	Description
identifier	string	yes	The primary identifier of the XRay ResourcePolicy

fn update()

Update a XRay ResourcePolicy

fn delete(identifier: string)

Delete a XRay ResourcePolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the XRay ResourcePolicy

fn sync()

Sync XRay ResourcePolicy state from AWS

fn list(maxPages?: number, resourceModel?: string)

List XRay ResourcePolicy resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— XRay ResourcePolicy resource state

@swamp/aws/xray/sampling-rulev2026.08.17.2sampling_rule.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
SamplingRule?	object	no
SamplingRuleRecord?	object	no
SamplingRuleUpdate?	object	no
RuleName?	string	no	The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
Tags?	array	no	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	Required	Description
identifier	string	yes	The primary identifier of the XRay SamplingRule

fn update()

Update a XRay SamplingRule

fn delete(identifier: string)

Delete a XRay SamplingRule

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the XRay SamplingRule

fn sync()

Sync XRay SamplingRule state from AWS

fn list(maxPages?: number, resourceModel?: string)

List XRay SamplingRule resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— XRay SamplingRule resource state

@swamp/aws/xray/transaction-search-configv2026.08.17.2transaction_search_config.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
IndexingPercentage?	number	no	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	Required	Description
identifier	string	yes	The primary identifier of the XRay TransactionSearchConfig

fn update()

Update a XRay TransactionSearchConfig

fn delete(identifier: string)

Delete a XRay TransactionSearchConfig

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the XRay TransactionSearchConfig

fn sync()

Sync XRay TransactionSearchConfig state from AWS

fn list(maxPages?: number, resourceModel?: string)

List XRay TransactionSearchConfig resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— XRay TransactionSearchConfig resource state

03Previous Versions19

2026.09.10.1Sep 10, 2026

2026.09.09.1Sep 9, 2026

2026.09.08.1Sep 8, 2026

2026.09.07.1Sep 7, 2026

2026.09.06.3Sep 7, 2026

2026.09.06.1Sep 6, 2026

2026.09.05.1Sep 5, 2026

2026.09.04.1Sep 4, 2026

2026.09.03.1Sep 3, 2026

2026.09.02.1Sep 2, 2026

2026.09.01.1Sep 1, 2026

2026.08.31.1Aug 31, 2026

2026.08.30.1Aug 30, 2026

2026.08.29.1Aug 29, 2026

2026.08.28.1Aug 28, 2026

2026.08.27.1Aug 27, 2026

2026.08.26.1Aug 26, 2026

2026.08.25.6Aug 25, 2026

2026.08.25.5Aug 25, 2026

04Stats

100 / 100

Downloads

Archive size

991.5 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 audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#aws #xray #cloud #infrastructure