Aws/events

@swamp/aws/eventsv2026.06.15.1· 1d agoMODELS

01README

AWS EVENTS infrastructure models

02Release Notes

Updated: api_destination, archive, connection, endpoint, event_bus, event_bus_policy, rule

03Models7

@swamp/aws/events/api-destinationv2026.06.15.1api_destination.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.
Name?	string	no	Name of the apiDestination.
Description?	string	no
ConnectionArn	string	yes	The arn of the connection.
InvocationRateLimitPerSecond?	number	no
InvocationEndpoint	string	yes
HttpMethod	enum	yes

fn create()

Create a Events ApiDestination

fn get(identifier: string)

Get a Events ApiDestination

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events ApiDestination

fn update()

Update a Events ApiDestination

fn delete(identifier: string)

Delete a Events ApiDestination

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events ApiDestination

fn sync()

Sync Events ApiDestination state from AWS

Resources

state(infinite)— Events ApiDestination resource state

@swamp/aws/events/archivev2026.06.15.1archive.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.
ArchiveName?	string	no
SourceArn	string	yes
Description?	string	no
EventPattern?	record	no
RetentionDays?	number	no
KmsKeyIdentifier?	string	no

fn create()

Create a Events Archive

fn get(identifier: string)

Get a Events Archive

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Archive

fn update()

Update a Events Archive

fn delete(identifier: string)

Delete a Events Archive

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Archive

fn sync()

Sync Events Archive state from AWS

Resources

state(infinite)— Events Archive resource state

@swamp/aws/events/connectionv2026.06.15.1connection.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.
Name?	string	no	Name of the connection.
Description?	string	no	Description of the connection.
AuthorizationType?	enum	no
AuthParameters?	object	no
InvocationConnectivityParameters?	object	no	The private resource the HTTP request will be sent to.
KmsKeyIdentifier?	string	no

fn create()

Create a Events Connection

fn get(identifier: string)

Get a Events Connection

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Connection

fn update()

Update a Events Connection

fn delete(identifier: string)

Delete a Events Connection

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Connection

fn sync()

Sync Events Connection state from AWS

Resources

state(infinite)— Events Connection resource state

@swamp/aws/events/endpointv2026.06.15.1endpoint.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.
Name?	string	no
RoleArn?	string	no
Description?	string	no
RoutingConfig	object	yes
EventBuses	array	yes

fn create()

Create a Events Endpoint

fn get(identifier: string)

Get a Events Endpoint

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Endpoint

fn update()

Update a Events Endpoint

fn delete(identifier: string)

Delete a Events Endpoint

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Endpoint

fn sync()

Sync Events Endpoint state from AWS

Resources

state(infinite)— Events Endpoint resource state

@swamp/aws/events/event-busv2026.06.15.1event_bus.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.
EventSourceName?	string	no	If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
Name	string	yes	The name of the event bus.
Tags?	array	no	Any tags assigned to the event bus.
Description?	string	no	The description of the event bus.
KmsKeyIdentifier?	string	no	Kms Key Identifier used to encrypt events at rest in the event bus.
Policy?	record	no	A JSON string that describes the permission policy statement for the event bus.
LogConfig?	object	no	The logging configuration settings for vended logs.

fn create()

Create a Events EventBus

fn get(identifier: string)

Get a Events EventBus

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events EventBus

fn update()

Update a Events EventBus

fn delete(identifier: string)

Delete a Events EventBus

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events EventBus

fn sync()

Sync Events EventBus state from AWS

Resources

state(infinite)— Events EventBus resource state

@swamp/aws/events/event-bus-policyv2026.06.15.1event_bus_policy.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.
EventBusName?	string	no	The name of the event bus associated with the rule. If you omit this, the default event bus is used.
Condition?	object	no	This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization.
Action?	string	no	The action that you are enabling the other account to perform.
StatementId	string	yes	An identifier string for the external account that you are granting permissions to
Statement?	record	no	A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.
Principal?	string	no	The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

fn create()

Create a Events EventBusPolicy

fn get(identifier: string)

Get a Events EventBusPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events EventBusPolicy

fn update()

Update a Events EventBusPolicy

fn delete(identifier: string)

Delete a Events EventBusPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events EventBusPolicy

fn sync()

Sync Events EventBusPolicy state from AWS

Resources

state(infinite)— Events EventBusPolicy resource state

@swamp/aws/events/rulev2026.06.15.1rule.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.
EventBusName?	string	no	The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
EventPattern?	record	no	The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
ScheduleExpression?	string	no	The scheduling expression. For example, "cron(0 20 * ? )", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
Description?	string	no	The description of the rule.
State?	enum	no	The state of the rule.
Targets?	array	no	Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.
RoleArn?	string	no	The Amazon Resource Name (ARN) of the role that is used for target invocation.
Tags?	array	no	Any tags assigned to the event rule.
Name?	string	no	The name of the rule.

fn create()

Create a Events Rule

fn get(identifier: string)

Get a Events Rule

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Rule

fn update()

Update a Events Rule

fn delete(identifier: string)

Delete a Events Rule

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Events Rule

fn sync()

Sync Events Rule state from AWS

Resources

state(infinite)— Events Rule resource state

04Previous Versions9

2026.06.08.2Jun 8, 2026

Updated: api_destination, archive, connection, endpoint, event_bus, event_bus_policy, rule

2026.06.06.1Jun 6, 2026

Updated: api_destination, archive, connection, endpoint, event_bus, event_bus_policy, rule

2026.05.27.1May 27, 2026

Updated: archive, event_bus, event_bus_policy, rule

2026.05.19.1May 18, 2026

2026.04.23.3Apr 23, 2026

2026.04.03.2Apr 3, 2026

Updated: api_destination, archive, connection, endpoint, event_bus, event_bus_policy, rule

2026.03.19.1Mar 19, 2026

Updated: api_destination, archive, connection, endpoint, event_bus, event_bus_policy, rule

2026.03.16.1Mar 16, 2026

Updated: api_destination, archive, connection, endpoint, event_bus, event_bus_policy, rule

2026.03.10.5Mar 10, 2026

05Stats

85 / 100

Downloads

Archive size

1.6 MB

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

Repository

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

06Platforms

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

07Labels

#aws #events #cloud #infrastructure