Package software.amazon.awscdk.services.transfer
package software.amazon.awscdk.services.transfer
AWS Transfer for SFTP Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.transfer.*;
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.)
-
ClassDescriptionA reference to a Agreement resource.A builder for
AgreementReferenceAn implementation forAgreementReferenceA reference to a Certificate resource.A builder forCertificateReferenceAn implementation forCertificateReferenceCreates an agreement.A fluent builder forCfnAgreement.Specifies a separate directory for each type of file to store for an AS2 message.A builder forCfnAgreement.CustomDirectoriesPropertyAn implementation forCfnAgreement.CustomDirectoriesPropertyProperties for defining aCfnAgreement.A builder forCfnAgreementPropsAn implementation forCfnAgreementPropsImports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.A fluent builder forCfnCertificate.Properties for defining aCfnCertificate.A builder forCfnCertificatePropsAn implementation forCfnCertificatePropsCreates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.A structure that contains the parameters for an AS2 connector object.A builder forCfnConnector.As2ConfigPropertyAn implementation forCfnConnector.As2ConfigPropertyA fluent builder forCfnConnector.A structure that contains the parameters for an SFTP connector object.A builder forCfnConnector.SftpConfigPropertyAn implementation forCfnConnector.SftpConfigPropertyProperties for defining aCfnConnector.A builder forCfnConnectorPropsAn implementation forCfnConnectorPropsCreates the local or partner profile to use for AS2 transfers.A fluent builder forCfnProfile.Properties for defining aCfnProfile.A builder forCfnProfilePropsAn implementation forCfnProfilePropsInstantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS .A fluent builder forCfnServer.The virtual private cloud (VPC) endpoint settings that are configured for your server.A builder forCfnServer.EndpointDetailsPropertyAn implementation forCfnServer.EndpointDetailsPropertyRequired whenIdentityProviderTypeis set toAWS_DIRECTORY_SERVICE,AWS _LAMBDAorAPI_GATEWAY.A builder forCfnServer.IdentityProviderDetailsPropertyAn implementation forCfnServer.IdentityProviderDetailsPropertyThe protocol settings that are configured for your server.A builder forCfnServer.ProtocolDetailsPropertyAn implementation forCfnServer.ProtocolDetailsPropertyThe Amazon S3 storage options that are configured for your server.A builder forCfnServer.S3StorageOptionsPropertyAn implementation forCfnServer.S3StorageOptionsPropertySpecifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.A builder forCfnServer.WorkflowDetailPropertyAn implementation forCfnServer.WorkflowDetailPropertyContainer for theWorkflowDetaildata type.A builder forCfnServer.WorkflowDetailsPropertyAn implementation forCfnServer.WorkflowDetailsPropertyProperties for defining aCfnServer.A builder forCfnServerPropsAn implementation forCfnServerPropsTheAWS::Transfer::Userresource creates a user and associates them with an existing server.A fluent builder forCfnUser.Represents an object that contains entries and targets forHomeDirectoryMappings.A builder forCfnUser.HomeDirectoryMapEntryPropertyAn implementation forCfnUser.HomeDirectoryMapEntryPropertyThe 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.A builder forCfnUser.PosixProfilePropertyAn implementation forCfnUser.PosixProfilePropertyProperties for defining aCfnUser.A builder forCfnUserPropsAn implementation forCfnUserPropsCreates a web app based on specified parameters, and returns the ID for the new web app.A fluent builder forCfnWebApp.A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.A builder forCfnWebApp.IdentityProviderDetailsPropertyAn implementation forCfnWebApp.IdentityProviderDetailsPropertyA structure that contains the customization fields for the web app.A builder forCfnWebApp.WebAppCustomizationPropertyAn implementation forCfnWebApp.WebAppCustomizationPropertyContains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.A builder forCfnWebApp.WebAppUnitsPropertyAn implementation forCfnWebApp.WebAppUnitsPropertyProperties for defining aCfnWebApp.A builder forCfnWebAppPropsAn implementation forCfnWebAppPropsAllows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.A fluent builder forCfnWorkflow.Details for a step that performs a file copy.A builder forCfnWorkflow.CopyStepDetailsPropertyAn implementation forCfnWorkflow.CopyStepDetailsPropertyDetails for a step that invokes an AWS Lambda function.A builder forCfnWorkflow.CustomStepDetailsPropertyAn implementation forCfnWorkflow.CustomStepDetailsPropertyDetails for a step that decrypts an encrypted file.A builder forCfnWorkflow.DecryptStepDetailsPropertyAn implementation forCfnWorkflow.DecryptStepDetailsPropertyAn object that contains the name and file location for a file being deleted by a workflow.A builder forCfnWorkflow.DeleteStepDetailsPropertyAn implementation forCfnWorkflow.DeleteStepDetailsPropertySpecifies the Amazon EFS identifier and the path for the file being used.A builder forCfnWorkflow.EfsInputFileLocationPropertyAn implementation forCfnWorkflow.EfsInputFileLocationPropertySpecifies the location for the file that's being processed.A builder forCfnWorkflow.InputFileLocationPropertyAn implementation forCfnWorkflow.InputFileLocationPropertySpecifies the S3 details for the file being used, such as bucket, ETag, and so forth.A builder forCfnWorkflow.S3FileLocationPropertyAn implementation forCfnWorkflow.S3FileLocationPropertySpecifies the details for the Amazon S3 location for an input file to a workflow.A builder forCfnWorkflow.S3InputFileLocationPropertyAn implementation forCfnWorkflow.S3InputFileLocationPropertySpecifies the key-value pair that are assigned to a file during the execution of a Tagging step.A builder forCfnWorkflow.S3TagPropertyAn implementation forCfnWorkflow.S3TagPropertyDetails for a step that creates one or more tags.A builder forCfnWorkflow.TagStepDetailsPropertyAn implementation forCfnWorkflow.TagStepDetailsPropertyThe basic building block of a workflow.A builder forCfnWorkflow.WorkflowStepPropertyAn implementation forCfnWorkflow.WorkflowStepPropertyProperties for defining aCfnWorkflow.A builder forCfnWorkflowPropsAn implementation forCfnWorkflowPropsA reference to a Connector resource.A builder forConnectorReferenceAn implementation forConnectorReference(experimental) Indicates that this resource can be referenced as a Agreement.Internal default implementation forIAgreementRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Certificate.Internal default implementation forICertificateRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Connector.Internal default implementation forIConnectorRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Profile.Internal default implementation forIProfileRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Server.Internal default implementation forIServerRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a User.Internal default implementation forIUserRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a WebApp.Internal default implementation forIWebAppRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Workflow.Internal default implementation forIWorkflowRef.A proxy class which represents a concrete javascript instance of this type.A reference to a Profile resource.A builder forProfileReferenceAn implementation forProfileReferenceA reference to a Server resource.A builder forServerReferenceAn implementation forServerReferenceA reference to a User resource.A builder forUserReferenceAn implementation forUserReferenceA reference to a WebApp resource.A builder forWebAppReferenceAn implementation forWebAppReferenceA reference to a Workflow resource.A builder forWorkflowReferenceAn implementation forWorkflowReference