@swamp/aws/transfer
v2026.04.03.2
AWS TRANSFER infrastructure models
Labels
awstransfercloudinfrastructure
Contents
Install
$ swamp extension pull @swamp/aws/transferRelease Notes
- Updated: agreement, certificate, connector, profile, server, user, web_app, workflow
@swamp/aws/transfer/agreementv2026.04.03.2agreement.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| Description? | string | A textual description for the agreement. |
| ServerId | string | A unique identifier for the server. |
| LocalProfileId | string | A unique identifier for the local profile. |
| PartnerProfileId | string | A unique identifier for the partner profile. |
| BaseDirectory? | string | Specifies the base directory for the agreement. |
| AccessRole | string | Specifies the access role for the agreement. |
| Status? | enum | Specifies the status of the agreement. |
| Tags? | array | Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose. |
| PreserveFilename? | enum | Specifies whether to preserve the filename received for this agreement. |
| EnforceMessageSigning? | enum | Specifies whether to enforce an AS2 message is signed for this agreement. |
| CustomDirectories? | object | Specifies a separate directory for each type of file to store for an AS2 message. |
createCreate a Transfer Agreement
getGet a Transfer Agreement
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Agreement |
updateUpdate a Transfer Agreement
deleteDelete a Transfer Agreement
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Agreement |
syncSync Transfer Agreement state from AWS
Resources
state(infinite)— Transfer Agreement resource state
@swamp/aws/transfer/certificatev2026.04.03.2certificate.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| Usage | enum | Specifies the usage type for the certificate. |
| Certificate | string | Specifies the certificate body to be imported. |
| CertificateChain? | string | Specifies the certificate chain to be imported. |
| PrivateKey? | string | Specifies the private key for the certificate. |
| ActiveDate? | string | Specifies the active date for the certificate. |
| InactiveDate? | string | Specifies the inactive date for the certificate. |
| Description? | string | A textual description for the certificate. |
| Tags? | array | Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose. |
createCreate a Transfer Certificate
getGet a Transfer Certificate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Certificate |
updateUpdate a Transfer Certificate
deleteDelete a Transfer Certificate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Certificate |
syncSync Transfer Certificate state from AWS
Resources
state(infinite)— Transfer Certificate resource state
@swamp/aws/transfer/connectorv2026.04.03.2connector.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| AccessRole | string | Specifies the access role for the connector. |
| As2Config? | object | Configuration for an AS2 connector. |
| EgressType? | enum | Specifies the egress type for the connector. |
| EgressConfig? | object | Egress configuration for the connector. |
| SftpConfig? | object | Configuration for an SFTP connector. |
| LoggingRole? | string | Specifies the logging role for the connector. |
| Tags? | array | Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. |
| Url? | string | URL for Connector |
| SecurityPolicyName? | string | Security policy for SFTP Connector |
createCreate a Transfer Connector
getGet a Transfer Connector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Connector |
updateUpdate a Transfer Connector
deleteDelete a Transfer Connector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Connector |
syncSync Transfer Connector state from AWS
Resources
state(infinite)— Transfer Connector resource state
@swamp/aws/transfer/profilev2026.04.03.2profile.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| As2Id | string | AS2 identifier agreed with a trading partner. |
| ProfileType | enum | Enum specifying whether the profile is local or associated with a trading partner. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| CertificateIds? | array | List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. |
createCreate a Transfer Profile
getGet a Transfer Profile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Profile |
updateUpdate a Transfer Profile
deleteDelete a Transfer Profile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Profile |
syncSync Transfer Profile state from AWS
Resources
state(infinite)— Transfer Profile resource state
@swamp/aws/transfer/serverv2026.04.03.2server.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| Certificate? | string | |
| 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 |
createCreate a Transfer Server
getGet a Transfer Server
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Server |
updateUpdate a Transfer Server
deleteDelete a Transfer Server
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Server |
syncSync Transfer Server state from AWS
Resources
state(infinite)— Transfer Server resource state
@swamp/aws/transfer/userv2026.04.03.2user.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| HomeDirectory? | string | |
| HomeDirectoryMappings? | array | |
| HomeDirectoryType? | enum | |
| Policy? | string | |
| PosixProfile? | object | |
| Role | string | |
| ServerId | string | |
| SshPublicKeys? | array | This represents the SSH User Public Keys for CloudFormation resource |
| Tags? | array | |
| UserName | string |
createCreate a Transfer User
getGet a Transfer User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer User |
updateUpdate a Transfer User
deleteDelete a Transfer User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer User |
syncSync Transfer User state from AWS
Resources
state(infinite)— Transfer User resource state
@swamp/aws/transfer/web-appv2026.04.03.2web_app.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| IdentityProviderDetails | object | You can provide a structure that contains the details for the identity provider to use with your web app. |
| EndpointDetails? | object | |
| AccessEndpoint? | string | 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 | |
| WebAppCustomization? | object | |
| WebAppEndpointPolicy? | enum | |
| Tags? | array | Key-value pairs that can be used to group and search for web apps. |
createCreate a Transfer WebApp
getGet a Transfer WebApp
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer WebApp |
updateUpdate a Transfer WebApp
deleteDelete a Transfer WebApp
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer WebApp |
syncSync Transfer WebApp state from AWS
Resources
state(infinite)— Transfer WebApp resource state
@swamp/aws/transfer/workflowv2026.04.03.2workflow.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| OnExceptionSteps? | array | Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. |
| Steps | array | Specifies the details for the steps that are in the specified workflow. |
| Tags? | array | Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. |
| Description? | string | A textual description for the workflow. |
createCreate a Transfer Workflow
getGet a Transfer Workflow
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Workflow |
updateUpdate a Transfer Workflow
deleteDelete a Transfer Workflow
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Transfer Workflow |
syncSync Transfer Workflow state from AWS
Resources
state(infinite)— Transfer Workflow resource state
2026.03.19.11.6 MBMar 19, 2026
AWS TRANSFER infrastructure models
Release Notes
- Updated: agreement, certificate, connector, profile, server, user, web_app, workflow
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awstransfercloudinfrastructure
2026.03.16.11.6 MBMar 16, 2026
AWS TRANSFER infrastructure models
Release Notes
- Updated: agreement, certificate, connector, profile, server, user, web_app, workflow
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awstransfercloudinfrastructure
2026.03.10.51.6 MBMar 10, 2026
AWS TRANSFER infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awstransfercloudinfrastructure