Aws/transfer

@swamp/aws/transferv2026.08.22.1· 1d agoMODELS

01README

AWS TRANSFER infrastructure models

02Models9

@swamp/aws/transfer/agreementv2026.08.17.2agreement.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.
Description?	string	no	A textual description for the agreement.
ServerId	string	yes	A unique identifier for the server.
LocalProfileId	string	yes	A unique identifier for the local profile.
PartnerProfileId	string	yes	A unique identifier for the partner profile.
BaseDirectory?	string	no	Specifies the base directory for the agreement.
AccessRole	string	yes	Specifies the access role for the agreement.
Status?	enum	no	Specifies the status of the agreement.
Tags?	array	no	Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
PreserveFilename?	enum	no	Specifies whether to preserve the filename received for this agreement.
EnforceMessageSigning?	enum	no	Specifies whether to enforce an AS2 message is signed for this agreement.
CustomDirectories?	object	no	Specifies a separate directory for each type of file to store for an AS2 message.

fn create()

Create a Transfer Agreement

fn get(identifier: string)

Get a Transfer Agreement

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Agreement

fn update()

Update a Transfer Agreement

fn delete(identifier: string)

Delete a Transfer Agreement

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Agreement

fn sync()

Sync Transfer Agreement state from AWS

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

List Transfer Agreement 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)— Transfer Agreement resource state

@swamp/aws/transfer/certificatev2026.08.17.2certificate.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.
Usage	enum	yes	Specifies the usage type for the certificate.
Certificate	string	yes	Specifies the certificate body to be imported.
CertificateChain?	string	no	Specifies the certificate chain to be imported.
PrivateKey?	string	no	Specifies the private key for the certificate.
ActiveDate?	string	no	Specifies the active date for the certificate.
InactiveDate?	string	no	Specifies the inactive date for the certificate.
Description?	string	no	A textual description for the certificate.
Tags?	array	no	Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.

fn create()

Create a Transfer Certificate

fn get(identifier: string)

Get a Transfer Certificate

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Certificate

fn update()

Update a Transfer Certificate

fn delete(identifier: string)

Delete a Transfer Certificate

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Certificate

fn sync()

Sync Transfer Certificate state from AWS

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

List Transfer Certificate 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)— Transfer Certificate resource state

@swamp/aws/transfer/connectorv2026.08.17.2connector.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.
AccessRole	string	yes	Specifies the access role for the connector.
As2Config?	object	no	Configuration for an AS2 connector.
EgressType?	enum	no	Specifies the egress type for the connector.
EgressConfig?	object	no	Egress configuration for the connector.
SftpConfig?	object	no	Configuration for an SFTP connector.
LoggingRole?	string	no	Specifies the logging role for the connector.
Tags?	array	no	Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
Url?	string	no	URL for Connector
SecurityPolicyName?	string	no	Security policy for SFTP Connector
IpAddressType?	enum	no	IP address type for Connector

fn create()

Create a Transfer Connector

fn get(identifier: string)

Get a Transfer Connector

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Connector

fn update()

Update a Transfer Connector

fn delete(identifier: string)

Delete a Transfer Connector

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Connector

fn sync()

Sync Transfer Connector state from AWS

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

List Transfer Connector 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)— Transfer Connector resource state

@swamp/aws/transfer/host-keyv2026.08.17.2host_key.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.
ServerId	string	yes	The identifier of the server that contains the host key.
HostKeyBody?	string	no	The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
Description?	string	no	The text description for this host key.
Tags?	array	no	Key-value pairs that can be used to group and search for host keys.

fn create()

Create a Transfer HostKey

fn get(identifier: string)

Get a Transfer HostKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer HostKey

fn update()

Update a Transfer HostKey

fn delete(identifier: string)

Delete a Transfer HostKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer HostKey

fn sync()

Sync Transfer HostKey state from AWS

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

List Transfer HostKey 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)— Transfer HostKey resource state

@swamp/aws/transfer/profilev2026.08.17.2profile.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.
As2Id	string	yes	AS2 identifier agreed with a trading partner.
ProfileType	enum	yes	Enum specifying whether the profile is local or associated with a trading partner.
Tags?	array	no	An array of key-value pairs to apply to this resource.
CertificateIds?	array	no	List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.

fn create()

Create a Transfer Profile

fn get(identifier: string)

Get a Transfer Profile

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Profile

fn update()

Update a Transfer Profile

fn delete(identifier: string)

Delete a Transfer Profile

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Profile

fn sync()

Sync Transfer Profile state from AWS

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

List Transfer Profile 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)— Transfer Profile resource state

@swamp/aws/transfer/serverv2026.08.17.2server.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.
Certificate?	string	no
Domain?	enum	no
EndpointDetails?	object	no
EndpointType?	enum	no
IdentityProviderDetails?	object	no
IdentityProviderType?	enum	no
IpAddressType?	enum	no
LoggingRole?	string	no
PostAuthenticationLoginBanner?	string	no
PreAuthenticationLoginBanner?	string	no
ProtocolDetails?	object	no
Protocols?	array	no
S3StorageOptions?	object	no
SecurityPolicyName?	string	no
StructuredLogDestinations?	array	no
Tags?	array	no
WorkflowDetails?	object	no

fn create()

Create a Transfer Server

fn get(identifier: string)

Get a Transfer Server

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Server

fn update()

Update a Transfer Server

fn delete(identifier: string)

Delete a Transfer Server

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Server

fn sync()

Sync Transfer Server state from AWS

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

List Transfer Server 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)— Transfer Server resource state

@swamp/aws/transfer/userv2026.08.17.2user.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.
HomeDirectory?	string	no
HomeDirectoryMappings?	array	no
HomeDirectoryType?	enum	no
Policy?	string	no
PosixProfile?	object	no
Role	string	yes
ServerId	string	yes
SshPublicKeys?	array	no	This represents the SSH User Public Keys for CloudFormation resource
Tags?	array	no
UserName	string	yes

fn create()

Create a Transfer User

fn get(identifier: string)

Get a Transfer User

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer User

fn update()

Update a Transfer User

fn delete(identifier: string)

Delete a Transfer User

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer User

fn sync()

Sync Transfer User state from AWS

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

List Transfer User 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)— Transfer User resource state

@swamp/aws/transfer/web-appv2026.08.17.2web_app.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.
IdentityProviderDetails	object	yes	You can provide a structure that contains the details for the identity provider to use with your web app.
EndpointDetails?	object	no
AccessEndpoint?	string	no	The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
WebAppUnits?	object	no
WebAppCustomization?	object	no
WebAppEndpointPolicy?	enum	no
Tags?	array	no	Key-value pairs that can be used to group and search for web apps.

fn create()

Create a Transfer WebApp

fn get(identifier: string)

Get a Transfer WebApp

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer WebApp

fn update()

Update a Transfer WebApp

fn delete(identifier: string)

Delete a Transfer WebApp

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer WebApp

fn sync()

Sync Transfer WebApp state from AWS

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

List Transfer WebApp 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)— Transfer WebApp resource state

@swamp/aws/transfer/workflowv2026.08.17.2workflow.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.
OnExceptionSteps?	array	no	Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
Steps	array	yes	Specifies the details for the steps that are in the specified workflow.
Tags?	array	no	Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
Description?	string	no	A textual description for the workflow.

fn create()

Create a Transfer Workflow

fn get(identifier: string)

Get a Transfer Workflow

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Workflow

fn update()

Update a Transfer Workflow

fn delete(identifier: string)

Delete a Transfer Workflow

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Transfer Workflow

fn sync()

Sync Transfer Workflow state from AWS

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

List Transfer Workflow 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)— Transfer Workflow resource state

03Previous Versions19

2026.08.21.1Aug 21, 2026

2026.08.20.1Aug 21, 2026

2026.08.19.1Aug 19, 2026

2026.08.18.1Aug 18, 2026

2026.08.17.5Aug 17, 2026

2026.08.17.4Aug 17, 2026

Modified 9 models

2026.08.16.1Aug 16, 2026

2026.08.15.1Aug 15, 2026

2026.08.14.1Aug 14, 2026

2026.08.11.1Aug 11, 2026

Added: host_key

Added 1 models

2026.08.07.1Aug 7, 2026

2026.08.06.1Aug 6, 2026

2026.08.05.1Aug 5, 2026

2026.08.04.1Aug 4, 2026

2026.08.03.1Aug 3, 2026

2026.08.02.1Aug 2, 2026

2026.08.01.1Aug 1, 2026

2026.07.31.1Jul 31, 2026

2026.07.30.1Jul 30, 2026

04Stats

100 / 100

Downloads

Archive size

2.0 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 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 #transfer #cloud #infrastructure