aws-cdk-lib.aws_transfer

AWS Transfer for SFTP Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as transfer from 'aws-cdk-lib/aws-transfer';

import aws_cdk.aws_transfer as transfer

import software.amazon.awscdk.services.transfer.*;

using Amazon.CDK.AWS.Transfer;

import transfer "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for Transfer construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Transfer resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Transfer.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnAgreement	Construct (L1)	Creates an agreement.
CfnCertificate	Construct (L1)	Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
CfnConnector	Construct (L1)	Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
CfnHostKey	Construct (L1)	Resource type definition for AWS::Transfer::HostKey.
CfnProfile	Construct (L1)	Creates the local or partner profile to use for AS2 transfers.
CfnServer	Construct (L1)	Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS .
CfnUser	Construct (L1)	The AWS::Transfer::User resource creates a user and associates them with an existing server.
CfnWebApp	Construct (L1)	Creates a web app based on specified parameters, and returns the ID for the new web app.
CfnWorkflow	Construct (L1)	Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
CfnAgreement.CustomDirectoriesProperty	Struct	Specifies a separate directory for each type of file to store for an AS2 message.
CfnAgreementProps	Struct	Properties for defining a CfnAgreement.
CfnCertificateProps	Struct	Properties for defining a CfnCertificate.
CfnConnector.As2ConfigProperty	Struct	A structure that contains the parameters for an AS2 connector object.
CfnConnector.ConnectorAsyncMdnConfigProperty	Struct
CfnConnector.ConnectorEgressConfigProperty	Struct	Configuration structure that defines how traffic is routed from the connector to the SFTP server.
CfnConnector.ConnectorVpcLatticeEgressConfigProperty	Struct	VPC_LATTICE egress configuration that specifies the Resource Configuration ARN and port for connecting to SFTP servers through customer VPCs.
CfnConnector.SftpConfigProperty	Struct	A structure that contains the parameters for an SFTP connector object.
CfnConnectorProps	Struct	Properties for defining a CfnConnector.
CfnHostKeyProps	Struct	Properties for defining a CfnHostKey.
CfnProfileProps	Struct	Properties for defining a CfnProfile.
CfnServer.EndpointDetailsProperty	Struct	The virtual private cloud (VPC) endpoint settings that are configured for your server.
CfnServer.IdentityProviderDetailsProperty	Struct	Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .
CfnServer.ProtocolDetailsProperty	Struct	The protocol settings that are configured for your server.
CfnServer.ProxyConfigProperty	Struct
CfnServer.S3StorageOptionsProperty	Struct	The Amazon S3 storage options that are configured for your server.
CfnServer.WorkflowDetailProperty	Struct	Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
CfnServer.WorkflowDetailsProperty	Struct	Container for the WorkflowDetail data type.
CfnServerProps	Struct	Properties for defining a CfnServer.
CfnUser.HomeDirectoryMapEntryProperty	Struct	Represents an object that contains entries and targets for HomeDirectoryMappings .
CfnUser.PosixProfileProperty	Struct	The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any secondary groups IDs ( SecondaryGids ), that controls your users' access to your Amazon EFS file systems.
CfnUserProps	Struct	Properties for defining a CfnUser.
CfnWebApp.EndpointDetailsProperty	Struct
CfnWebApp.IdentityProviderDetailsProperty	Struct	A structure that describes the values to use for the SSO settings when you create or update a web app.
CfnWebApp.VpcProperty	Struct	You can provide a structure that contains the details for the VPC endpoint to use with your web app.
CfnWebApp.WebAppCustomizationProperty	Struct	A structure that contains the customization fields for the web app.
CfnWebApp.WebAppUnitsProperty	Struct	Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.
CfnWebAppProps	Struct	Properties for defining a CfnWebApp.
CfnWorkflow.CopyStepDetailsProperty	Struct	Details for a step that performs a file copy.
CfnWorkflow.CustomStepDetailsProperty	Struct	Details for a step that invokes an AWS Lambda function.
CfnWorkflow.DecryptStepDetailsProperty	Struct	Details for a step that decrypts an encrypted file.
CfnWorkflow.DeleteStepDetailsProperty	Struct	An object that contains the name and file location for a file being deleted by a workflow.
CfnWorkflow.EfsInputFileLocationProperty	Struct	Specifies the Amazon EFS identifier and the path for the file being used.
CfnWorkflow.InputFileLocationProperty	Struct	Specifies the location for the file that's being processed.
CfnWorkflow.S3FileLocationProperty	Struct	Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.
CfnWorkflow.S3InputFileLocationProperty	Struct	Specifies the details for the Amazon S3 location for an input file to a workflow.
CfnWorkflow.S3TagProperty	Struct	Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
CfnWorkflow.TagStepDetailsProperty	Struct	Details for a step that creates one or more tags.
CfnWorkflow.WorkflowStepProperty	Struct	The basic building block of a workflow.
CfnWorkflowProps	Struct	Properties for defining a CfnWorkflow.