Skip to main content

Aws/transfer

@swamp/aws/transferv2026.11.08.2· AGPL-3.0-or-later· 12d agoBEHAVIORS
01README

AWS TRANSFER infrastructure models

02Release Notes
  • Updated: agreement, certificate, connector, host_key, profile, server, user, web_app, workflow
03Behaviors9
@swamp/aws/transfer/agreementv2026.11.08.2agreement.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Description?stringA textual description for the agreement.
ServerId?stringA unique identifier for the server.
LocalProfileId?stringA unique identifier for the local profile.
PartnerProfileId?stringA unique identifier for the partner profile.
BaseDirectory?stringSpecifies the base directory for the agreement.
AccessRole?stringSpecifies the access role for the agreement.
Status?enumSpecifies the status of the agreement.
Tags?arrayKey-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
PreserveFilename?enumSpecifies whether to preserve the filename received for this agreement.
EnforceMessageSigning?enumSpecifies whether to enforce an AS2 message is signed for this agreement.
CustomDirectories?objectSpecifies 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
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Agreement
fn update()
Update a Transfer Agreement
fn delete(identifier: string)
Delete a Transfer Agreement
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Agreement
fn sync()
Sync Transfer Agreement state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer Agreement resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer Agreement resource state
@swamp/aws/transfer/certificatev2026.11.08.2certificate.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Usage?enumSpecifies the usage type for the certificate.
Certificate?stringSpecifies the certificate body to be imported.
CertificateChain?stringSpecifies the certificate chain to be imported.
PrivateKey?stringSpecifies the private key for the certificate.
ActiveDate?stringSpecifies the active date for the certificate.
InactiveDate?stringSpecifies the inactive date for the certificate.
Description?stringA textual description for the certificate.
Tags?arrayKey-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
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Certificate
fn update()
Update a Transfer Certificate
fn delete(identifier: string)
Delete a Transfer Certificate
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Certificate
fn sync()
Sync Transfer Certificate state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer Certificate resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer Certificate resource state
@swamp/aws/transfer/connectorv2026.11.08.2connector.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AccessRole?stringSpecifies the access role for the connector.
As2Config?objectConfiguration for an AS2 connector.
EgressType?enumSpecifies the egress type for the connector.
EgressConfig?objectEgress configuration for the connector.
SftpConfig?objectConfiguration for an SFTP connector.
LoggingRole?stringSpecifies the logging role for the connector.
Tags?arrayKey-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
Url?stringURL for Connector
SecurityPolicyName?stringSecurity policy for SFTP Connector
IpAddressType?enumIP address type for Connector
fn create()
Create a Transfer Connector
fn get(identifier: string)
Get a Transfer Connector
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Connector
fn update()
Update a Transfer Connector
fn delete(identifier: string)
Delete a Transfer Connector
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Connector
fn sync()
Sync Transfer Connector state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer Connector resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer Connector resource state
@swamp/aws/transfer/host-keyv2026.11.08.2host_key.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ServerId?stringThe identifier of the server that contains the host key.
HostKeyBody?stringThe private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
Description?stringThe text description for this host key.
StorageType?enumThe type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
KmsKey?stringThe Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
Tags?arrayKey-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
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer HostKey
fn update()
Update a Transfer HostKey
fn delete(identifier: string)
Delete a Transfer HostKey
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer HostKey
fn sync()
Sync Transfer HostKey state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer HostKey resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer HostKey resource state
@swamp/aws/transfer/profilev2026.11.08.2profile.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
As2Id?stringAS2 identifier agreed with a trading partner.
ProfileType?enumEnum specifying whether the profile is local or associated with a trading partner.
Tags?arrayAn array of key-value pairs to apply to this resource.
CertificateIds?arrayList 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
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Profile
fn update()
Update a Transfer Profile
fn delete(identifier: string)
Delete a Transfer Profile
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Profile
fn sync()
Sync Transfer Profile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer Profile resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer Profile resource state
@swamp/aws/transfer/serverv2026.11.08.1server.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Certificate?string
CreateWithHostKey?booleanWhen this property is `true`, AWS Transfer Family will generate an initial host key for your server, making it immediately available to SFTP clients. When set to `false`, clients will not be able to establish an SFTP session until you import one or more host keys (see AWS::Transfer::HostKey). This property cannot be changed after resource creation. Default: `true`.
Domain?enum
EndpointDetails?object
EndpointType?enum
IdentityProviderDetails?object
IdentityProviderType?enum
IpAddressType?enum
LoggingRole?string
PostAuthenticationLoginBanner?string
PreAuthenticationLoginBanner?string
ProtocolDetails?object
Protocols?array
S3StorageOptions?object
SecurityPolicyName?string
StructuredLogDestinations?array
Tags?array
WorkflowDetails?object
fn create()
Create a Transfer Server
fn get(identifier: string)
Get a Transfer Server
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Server
fn update()
Update a Transfer Server
fn delete(identifier: string)
Delete a Transfer Server
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Server
fn sync()
Sync Transfer Server state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer Server resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer Server resource state
@swamp/aws/transfer/userv2026.11.08.2user.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
HomeDirectory?string
HomeDirectoryMappings?array
HomeDirectoryType?enum
Policy?string
PosixProfile?object
Role?string
ServerId?string
SshPublicKeys?arrayThis represents the SSH User Public Keys for CloudFormation resource
Tags?array
UserName?string
fn create()
Create a Transfer User
fn get(identifier: string)
Get a Transfer User
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer User
fn update()
Update a Transfer User
fn delete(identifier: string)
Delete a Transfer User
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer User
fn sync()
Sync Transfer User state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer User resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer User resource state
@swamp/aws/transfer/web-appv2026.11.08.2web_app.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
IdentityProviderDetails?objectYou can provide a structure that contains the details for the identity provider to use with your web app.
EndpointDetails?object
AccessEndpoint?stringThe 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
WebAppCustomization?object
WebAppEndpointPolicy?enum
Tags?arrayKey-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
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer WebApp
fn update()
Update a Transfer WebApp
fn delete(identifier: string)
Delete a Transfer WebApp
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer WebApp
fn sync()
Sync Transfer WebApp state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer WebApp resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer WebApp resource state
@swamp/aws/transfer/workflowv2026.11.08.2workflow.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
OnExceptionSteps?arraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
Steps?arraySpecifies the details for the steps that are in the specified workflow.
Tags?arrayKey-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
Description?stringA textual description for the workflow.
StructuredLogDestinations?arraySpecifies the log destinations for the workflow.
fn create()
Create a Transfer Workflow
fn get(identifier: string)
Get a Transfer Workflow
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Workflow
fn update()
Update a Transfer Workflow
fn delete(identifier: string)
Delete a Transfer Workflow
ArgumentTypeDescription
identifierstringThe primary identifier of the Transfer Workflow
fn sync()
Sync Transfer Workflow state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Transfer Workflow resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Transfer Workflow resource state
04Previous Versions19
2026.11.08.1AGPL-3.0-or-later
  • Updated: agreement, certificate, connector, host_key, profile, user, web_app, workflow
2026.11.02.1AGPL-3.0-or-later
2026.10.31.1AGPL-3.0-or-later
  • Updated: server, workflow
2026.10.25.1AGPL-3.0-or-later
  • Updated: web_app
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
  • Updated: agreement, certificate, connector, host_key, profile, server, user, web_app, workflow
2026.10.20.1AGPL-3.0-or-later
  • Updated: host_key
2026.10.19.1AGPL-3.0-or-later(was none)
  • Updated: host_key
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
05Stats
A
100 / 100
Downloads
67
Archive size
1.8 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
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels