@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-transfer-server.d.ts

@@ -0,0 +1,394 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type TransferServer = ResourceDefinitionWithAttributes<"AWS::Transfer::Server", TransferServerProps, TransferServerAttribs>;
+/**
+ * Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS . When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated `ServerId` property that is assigned to the newly created server.
+ */
+export type TransferServerProps = {
+    /**
+     * The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when `Protocols` is set to `FTPS` .
+     *
+     * To request a new public certificate, see [Request a public certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) in the *AWS Certificate Manager User Guide* .
+     *
+     * To import an existing certificate into ACM, see [Importing certificates into ACM](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *AWS Certificate Manager User Guide* .
+     *
+     * To request a private certificate to use FTPS through private IP addresses, see [Request a private certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html) in the *AWS Certificate Manager User Guide* .
+     *
+     * Certificates with the following cryptographic algorithms and key sizes are supported:
+     *
+     * - 2048-bit RSA (RSA_2048)
+     * - 4096-bit RSA (RSA_4096)
+     * - Elliptic Prime Curve 256 bit (EC_prime256v1)
+     * - Elliptic Prime Curve 384 bit (EC_secp384r1)
+     * - Elliptic Prime Curve 521 bit (EC_secp521r1)
+     *
+     * > The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
+     * @minLength 0
+     * @maxLength 1600
+     */
+    Certificate?: string | undefined;
+    /**
+     * Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
+     */
+    Domain?: Domain | undefined;
+    /**
+     * The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
+     */
+    EndpointDetails?: EndpointDetails | undefined;
+    /**
+     * The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
+     *
+     * > After May 19, 2021, you won't be able to create a server using `EndpointType=VPC_ENDPOINT` in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with `EndpointType=VPC_ENDPOINT` in your AWS account on or before May 19, 2021, you will not be affected. After this date, use `EndpointType` = `VPC` .
+     * >
+     * > For more information, see [Discontinuing the use of VPC_ENDPOINT](https://docs.aws.amazon.com//transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint) .
+     * >
+     * > It is recommended that you use `VPC` as the `EndpointType` . With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with `EndpointType` set to `VPC_ENDPOINT` .
+     */
+    EndpointType?: EndpointType | undefined;
+    /**
+     * Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` , `AWS _LAMBDA` or `API_GATEWAY` . Accepts an array containing all of the information required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when `IdentityProviderType` is set to `SERVICE_MANAGED` .
+     */
+    IdentityProviderDetails?: IdentityProviderDetails | undefined;
+    /**
+     * The mode of authentication for a server. The default value is `SERVICE_MANAGED` , which allows you to store and access user credentials within the AWS Transfer Family service.
+     *
+     * Use `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using the `IdentityProviderDetails` parameter.
+     *
+     * Use the `API_GATEWAY` value to integrate with an identity provider of your choosing. The `API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter.
+     *
+     * Use the `AWS_LAMBDA` value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter for the `IdentityProviderDetails` data type.
+     */
+    IdentityProviderType?: IdentityProviderType | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.
+     * @minLength 0
+     * @maxLength 2048
+     * @pattern ^(|arn:.*role/\S+)$
+     */
+    LoggingRole?: string | undefined;
+    /**
+     * Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
+     *
+     * > The SFTP protocol does not support post-authentication display banners.
+     * @minLength 0
+     * @maxLength 4096
+     * @pattern ^[\x09-\x0D\x20-\x7E]*$
+     */
+    PostAuthenticationLoginBanner?: string | undefined;
+    /**
+     * Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
+     *
+     * `This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.`
+     * @minLength 0
+     * @maxLength 4096
+     * @pattern ^[\x09-\x0D\x20-\x7E]*$
+     */
+    PreAuthenticationLoginBanner?: string | undefined;
+    /**
+     * The protocol settings that are configured for your server.
+     *
+     * - To indicate passive mode (for FTP and FTPS protocols), use the `PassiveIp` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
+     * - To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP` . If you set the `SetStatOption` parameter to `ENABLE_NO_OP` , Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call.
+     * - To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter.
+     * - `As2Transports` indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
+     *
+     * The `Protocols` parameter is an array of strings.
+     *
+     * *Allowed values* : One or more of `SFTP` , `FTPS` , `FTP` , `AS2`
+     */
+    ProtocolDetails?: ProtocolDetails | undefined;
+    /**
+     * Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
+     *
+     * - `SFTP` (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
+     * - `FTPS` (File Transfer Protocol Secure): File transfer with TLS encryption
+     * - `FTP` (File Transfer Protocol): Unencrypted file transfer
+     * - `AS2` (Applicability Statement 2): used for transporting structured business-to-business data
+     *
+     * > - If you select `FTPS` , you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.
+     * > - If `Protocol` includes either `FTP` or `FTPS` , then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be either `AWS_DIRECTORY_SERVICE` , `AWS_LAMBDA` , or `API_GATEWAY` .
+     * > - If `Protocol` includes `FTP` , then `AddressAllocationIds` cannot be associated.
+     * > - If `Protocol` is set only to `SFTP` , the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set any of the supported identity types: `SERVICE_MANAGED` , `AWS_DIRECTORY_SERVICE` , `AWS_LAMBDA` , or `API_GATEWAY` .
+     * > - If `Protocol` includes `AS2` , then the `EndpointType` must be `VPC` , and domain must be Amazon S3.
+     *
+     * The `Protocols` parameter is an array of strings.
+     *
+     * *Allowed values* : One or more of `SFTP` , `FTPS` , `FTP` , `AS2`
+     */
+    Protocols?: Protocol[] | undefined;
+    /**
+     * Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
+     *
+     * By default, home directory mappings have a `TYPE` of `DIRECTORY` . If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry` `Type` to `FILE` if you want a mapping to have a file target.
+     */
+    S3StorageOptions?: S3StorageOptions | undefined;
+    /**
+     * Specifies the name of the security policy for the server.
+     * @minLength 0
+     * @maxLength 100
+     * @pattern ^TransferSecurityPolicy-.+$
+     */
+    SecurityPolicyName?: string | undefined;
+    /**
+     * Specifies the log groups to which your server logs are sent.
+     *
+     * To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
+     *
+     * `arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*`
+     *
+     * For example, `arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*`
+     *
+     * If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an `update-server` call. For example:
+     *
+     * `update-server --server-id s-1234567890abcdef0 --structured-log-destinations`
+     */
+    StructuredLogDestinations?: string[] | undefined;
+    /**
+     * Key-value pairs that can be used to group and search for servers.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
+     *
+     * In addition to a workflow to execute when a file is uploaded completely, `WorkflowDetails` can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.
+     */
+    WorkflowDetails?: WorkflowDetails | undefined;
+};
+export type TransferServerAttribs = {
+    /**
+     * Specifies the unique Amazon Resource Name (ARN) of the server.
+     * @minLength 20
+     * @maxLength 1600
+     * @pattern ^arn:\S+$
+     */
+    Arn: string;
+    /**
+     * The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.
+     *
+     * These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
+     */
+    As2ServiceManagedEgressIpAddresses: string[];
+    /**
+     * Specifies the unique system-assigned identifier for a server that you instantiate.
+     * @minLength 19
+     * @maxLength 19
+     * @pattern ^s-([0-9a-f]{17})$
+     */
+    ServerId: string;
+    /**
+     * The condition of the server that was described. A value of `ONLINE` indicates that the server can accept jobs and transfer files. A `State` value of `OFFLINE` means that the server cannot perform file transfer operations.
+     *
+     * The states of `STARTING` and `STOPPING` indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of `START_FAILED` or `STOP_FAILED` can indicate an error condition.
+     */
+    State: State;
+};
+export type As2Transport = "HTTP";
+/**
+ * Indicates whether optimization to directory listing on S3 servers is used. Disabled by default for compatibility.
+ */
+export type DirectoryListingOptimization = "ENABLED" | "DISABLED";
+export type Domain = "S3" | "EFS";
+/**
+ * The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
+ */
+export type EndpointDetails = {
+    /**
+     * A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
+     *
+     * An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the `allocationId` field from the Amazon EC2 [Address](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html) data type. One way to retrieve this value is by calling the EC2 [DescribeAddresses](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html) API.
+     *
+     * This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see [Create an internet-facing endpoint for your server](https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint) .
+     *
+     * > This property can only be set as follows:
+     * >
+     * > - `EndpointType` must be set to `VPC`
+     * > - The Transfer Family server must be offline.
+     * > - You cannot set this parameter for Transfer Family servers that use the FTP protocol.
+     * > - The server must already have `SubnetIds` populated ( `SubnetIds` and `AddressAllocationIds` cannot be updated simultaneously).
+     * > - `AddressAllocationIds` can't contain duplicates, and must be equal in length to `SubnetIds` . For example, if you have three subnet IDs, you must also specify three address allocation IDs.
+     * > - Call the `UpdateServer` API to set or change this parameter.
+     */
+    AddressAllocationIds?: string[] | undefined;
+    /**
+     * A list of security groups IDs that are available to attach to your server's endpoint.
+     *
+     * > This property can only be set when `EndpointType` is set to `VPC` .
+     * >
+     * > You can edit the `SecurityGroupIds` property in the [UpdateServer](https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) API only if you are changing the `EndpointType` from `PUBLIC` or `VPC_ENDPOINT` to `VPC` . To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 [ModifyVpcEndpoint](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) API.
+     */
+    SecurityGroupIds?: string[] | undefined;
+    /**
+     * A list of subnet IDs that are required to host your server endpoint in your VPC.
+     *
+     * > This property can only be set when `EndpointType` is set to `VPC` .
+     */
+    SubnetIds?: string[] | undefined;
+    /**
+     * The ID of the VPC endpoint.
+     *
+     * > This property can only be set when `EndpointType` is set to `VPC_ENDPOINT` .
+     * @minLength 22
+     * @maxLength 22
+     * @pattern ^vpce-[0-9a-f]{17}$
+     */
+    VpcEndpointId?: string | undefined;
+    /**
+     * The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.
+     *
+     * > This property can only be set when `EndpointType` is set to `VPC` .
+     */
+    VpcId?: string | undefined;
+};
+export type EndpointType = "PUBLIC" | "VPC" | "VPC_ENDPOINT";
+/**
+ * Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` , `AWS _LAMBDA` or `API_GATEWAY` . Accepts an array containing all of the information required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when `IdentityProviderType` is set to `SERVICE_MANAGED` .
+ */
+export type IdentityProviderDetails = {
+    /**
+     * The identifier of the AWS Directory Service directory that you want to use as your identity provider.
+     * @minLength 12
+     * @maxLength 12
+     * @pattern ^d-[0-9a-f]{10}$
+     */
+    DirectoryId?: string | undefined;
+    /**
+     * The ARN for a Lambda function to use for the Identity provider.
+     * @minLength 1
+     * @maxLength 170
+     * @pattern ^arn:[a-z-]+:lambda:.*$
+     */
+    Function?: string | undefined;
+    /**
+     * This parameter is only applicable if your `IdentityProviderType` is `API_GATEWAY` . Provides the type of `InvocationRole` used to authenticate the user account.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:.*role/\S+$
+     */
+    InvocationRole?: string | undefined;
+    /**
+     * For SFTP-enabled servers, and for custom identity providers *only* , you can specify whether to authenticate using a password, SSH key pair, or both.
+     *
+     * - `PASSWORD` - users must provide their password to connect.
+     * - `PUBLIC_KEY` - users must provide their private key to connect.
+     * - `PUBLIC_KEY_OR_PASSWORD` - users can authenticate with either their password or their key. This is the default value.
+     * - `PUBLIC_KEY_AND_PASSWORD` - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.
+     */
+    SftpAuthenticationMethods?: SftpAuthenticationMethods | undefined;
+    /**
+     * Provides the location of the service endpoint used to authenticate users.
+     * @minLength 0
+     * @maxLength 255
+     */
+    Url?: string | undefined;
+};
+export type IdentityProviderType = "SERVICE_MANAGED" | "API_GATEWAY" | "AWS_DIRECTORY_SERVICE" | "AWS_LAMBDA";
+export type Protocol = "SFTP" | "FTP" | "FTPS" | "AS2";
+/**
+ * The protocol settings that are configured for your server.
+ *
+ * - To indicate passive mode (for FTP and FTPS protocols), use the `PassiveIp` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
+ * - To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP` . If you set the `SetStatOption` parameter to `ENABLE_NO_OP` , Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call.
+ * - To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter.
+ * - `As2Transports` indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
+ */
+export type ProtocolDetails = {
+    /**
+     * List of `As2Transport` objects.
+     */
+    As2Transports?: As2Transport[] | undefined;
+    /**
+     * Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:
+     *
+     * `aws transfer update-server --protocol-details PassiveIp=0.0.0.0`
+     *
+     * Replace `0.0.0.0` in the example above with the actual IP address you want to use.
+     *
+     * > If you change the `PassiveIp` value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see [Configuring your FTPS server behind a firewall or NAT with AWS Transfer Family](https://docs.aws.amazon.com/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/) .
+     *
+     * *Special values*
+     *
+     * The `AUTO` and `0.0.0.0` are special values for the `PassiveIp` parameter. The value `PassiveIp=AUTO` is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. `PassiveIp=0.0.0.0` has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the `PassiveIp` parameter. This reduces the effectiveness of having High Availability. In this case, you can specify `PassiveIp=0.0.0.0` . This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the `PassiveIp=0.0.0.0` response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the `PassiveIp=0.0.0.0` response.
+     * @minLength 0
+     * @maxLength 15
+     */
+    PassiveIp?: string | undefined;
+    /**
+     * Use the `SetStatOption` to ignore the error that is generated when the client attempts to use `SETSTAT` on a file you are uploading to an S3 bucket.
+     *
+     * Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as `SETSTAT` when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.
+     *
+     * Set the value to `ENABLE_NO_OP` to have the Transfer Family server ignore the `SETSTAT` command, and upload files without needing to make any changes to your SFTP client. While the `SetStatOption` `ENABLE_NO_OP` setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a `SETSTAT` call.
+     *
+     * > If you want to preserve the original timestamp for your file, and modify other file attributes using `SETSTAT` , you can use Amazon EFS as backend storage with Transfer Family.
+     */
+    SetStatOption?: SetStatOption | undefined;
+    /**
+     * A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. `TlsSessionResumptionMode` determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during `CreateServer` and `UpdateServer` calls. If a `TlsSessionResumptionMode` value is not specified during `CreateServer` , it is set to `ENFORCED` by default.
+     *
+     * - `DISABLED` : the server does not process TLS session resumption client requests and creates a new TLS session for each request.
+     * - `ENABLED` : the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.
+     * - `ENFORCED` : the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to `ENFORCED` , test your clients.
+     *
+     * > Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the `ENFORCED` value, you need to test your clients.
+     */
+    TlsSessionResumptionMode?: TlsSessionResumptionMode | undefined;
+};
+/**
+ * The Amazon S3 storage options that are configured for your server.
+ */
+export type S3StorageOptions = {
+    /**
+     * Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
+     *
+     * By default, home directory mappings have a `TYPE` of `DIRECTORY` . If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry` `Type` to `FILE` if you want a mapping to have a file target.
+     */
+    DirectoryListingOptimization?: DirectoryListingOptimization | undefined;
+};
+export type SetStatOption = "DEFAULT" | "ENABLE_NO_OP";
+export type SftpAuthenticationMethods = "PASSWORD" | "PUBLIC_KEY" | "PUBLIC_KEY_OR_PASSWORD" | "PUBLIC_KEY_AND_PASSWORD";
+export type State = "OFFLINE" | "ONLINE" | "STARTING" | "STOPPING" | "START_FAILED" | "STOP_FAILED";
+export type TlsSessionResumptionMode = "DISABLED" | "ENABLED" | "ENFORCED";
+/**
+ * Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
+ *
+ * In addition to a workflow to execute when a file is uploaded completely, `WorkflowDetails` can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.
+ */
+export type WorkflowDetail = {
+    /**
+     * Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:.*role/\S+$
+     */
+    ExecutionRole: string;
+    /**
+     * A unique identifier for the workflow.
+     * @minLength 19
+     * @maxLength 19
+     * @pattern ^w-([a-z0-9]{17})$
+     */
+    WorkflowId: string;
+};
+/**
+ * Container for the `WorkflowDetail` data type. It is used by actions that trigger a workflow to begin execution.
+ */
+export type WorkflowDetails = {
+    /**
+     * A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.
+     *
+     * A *partial upload* occurs when a file is open when the session disconnects.
+     *
+     * > `OnPartialUpload` can contain a maximum of one `WorkflowDetail` object.
+     */
+    OnPartialUpload?: WorkflowDetail[] | undefined;
+    /**
+     * A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
+     *
+     * To remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example.
+     *
+     * `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'`
+     *
+     * > `OnUpload` can contain a maximum of one `WorkflowDetail` object.
+     */
+    OnUpload?: WorkflowDetail[] | undefined;
+};
+//# sourceMappingURL=aws-transfer-server.d.ts.map

package/out/exports/resources.generated/aws-transfer-user.d.ts

@@ -0,0 +1,165 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type TransferUser = ResourceDefinitionWithAttributes<"AWS::Transfer::User", TransferUserProps, TransferUserAttribs>;
+/**
+ * The `AWS::Transfer::User` resource creates a user and associates them with an existing server. You can only create and associate users with servers that have the `IdentityProviderType` set to `SERVICE_MANAGED` . Using parameters for `CreateUser` , you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
+ */
+export type TransferUserProps = {
+    /**
+     * The landing directory (folder) for a user when they log in to the server using the client.
+     *
+     * A `HomeDirectory` example is `/bucket_name/home/mydirectory` .
+     *
+     * > The `HomeDirectory` parameter is only used if `HomeDirectoryType` is set to `PATH` .
+     * @minLength 0
+     * @maxLength 1024
+     * @pattern ^(|/.*)$
+     */
+    HomeDirectory?: string | undefined;
+    /**
+     * Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the `Entry` and `Target` pair, where `Entry` shows how the path is made visible and `Target` is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in `Target` . This value can be set only when `HomeDirectoryType` is set to *LOGICAL* .
+     *
+     * The following is an `Entry` and `Target` pair example.
+     *
+     * `[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]`
+     *
+     * In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory (" `chroot` "). To do this, you can set `Entry` to `/` and set `Target` to the value the user should see for their home directory when they log in.
+     *
+     * The following is an `Entry` and `Target` pair example for `chroot` .
+     *
+     * `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
+     */
+    HomeDirectoryMappings?: HomeDirectoryMapEntry[] | undefined;
+    /**
+     * The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to `PATH` , the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to `LOGICAL` , you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
+     *
+     * > If `HomeDirectoryType` is `LOGICAL` , you must provide mappings, using the `HomeDirectoryMappings` parameter. If, on the other hand, `HomeDirectoryType` is `PATH` , you provide an absolute path using the `HomeDirectory` parameter. You cannot have both `HomeDirectory` and `HomeDirectoryMappings` in your template.
+     */
+    HomeDirectoryType?: HomeDirectoryType | undefined;
+    /**
+     * A session policy for your user so you can use the same IAM role across multiple users. This policy restricts user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include `${Transfer:UserName}` , `${Transfer:HomeDirectory}` , and `${Transfer:HomeBucket}` .
+     *
+     * > For session policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the `Policy` argument.
+     * >
+     * > For an example of a session policy, see [Example session policy](https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html) .
+     * >
+     * > For more information, see [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the *AWS Security Token Service API Reference* .
+     * @minLength 0
+     * @maxLength 2048
+     */
+    Policy?: string | undefined;
+    /**
+     * Specifies 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 Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
+     */
+    PosixProfile?: PosixProfile | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:.*role/\S+$
+     */
+    Role: string;
+    /**
+     * A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
+     * @minLength 19
+     * @maxLength 19
+     * @pattern ^s-([0-9a-f]{17})$
+     */
+    ServerId: string;
+    /**
+     * Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
+     *
+     * > To delete the public key body, set its value to zero keys, as shown here:
+     * >
+     * > `SshPublicKeys: []`
+     */
+    SshPublicKeys?: string[] | undefined;
+    /**
+     * Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * A unique string that identifies a user and is associated with a `ServerId` . This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
+     * @minLength 3
+     * @maxLength 100
+     * @pattern ^[\w][\w@.-]{2,99}$
+     */
+    UserName: string;
+};
+export type TransferUserAttribs = {
+    /**
+     * The Amazon Resource Name associated with the user, in the form `arn:aws:transfer:region: *account-id* :user/ *server-id* / *username*` .
+     *
+     * An example of a user ARN is: `arn:aws:transfer:us-east-1:123456789012:user/user1` .
+     * @minLength 20
+     * @maxLength 1600
+     * @pattern ^arn:\S+$
+     */
+    Arn: string;
+    /**
+     * The ID of the server to which the user is attached.
+     *
+     * An example `ServerId` is `s-01234567890abcdef` .
+     * @minLength 19
+     * @maxLength 19
+     * @pattern ^s-([0-9a-f]{17})$
+     */
+    ServerId: string;
+    /**
+     * A unique string that identifies a Transfer Family user account associated with a server.
+     *
+     * An example `UserName` is `transfer-user-1` .
+     * @minLength 3
+     * @maxLength 100
+     * @pattern ^[\w][\w@.-]{2,99}$
+     */
+    UserName: string;
+};
+/**
+ * Represents an object that contains entries and targets for `HomeDirectoryMappings` .
+ */
+export type HomeDirectoryMapEntry = {
+    /**
+     * Represents an entry for `HomeDirectoryMappings` .
+     * @minLength 0
+     * @maxLength 1024
+     * @pattern ^/.*$
+     */
+    Entry: string;
+    /**
+     * Represents the map target that is used in a `HomeDirectoryMapEntry` .
+     * @minLength 0
+     * @maxLength 1024
+     * @pattern ^/.*$
+     */
+    Target: string;
+    /**
+     * Specifies the type of mapping. Set the type to `FILE` if you want the mapping to point to a file, or `DIRECTORY` for the directory to point to a directory.
+     *
+     * > By default, home directory mappings have a `Type` of `DIRECTORY` when you create a Transfer Family server. You would need to explicitly set `Type` to `FILE` if you want a mapping to have a file target.
+     */
+    Type?: MapType | undefined;
+};
+export type HomeDirectoryType = "PATH" | "LOGICAL";
+export type MapType = "FILE" | "DIRECTORY";
+/**
+ * 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. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
+ */
+export type PosixProfile = {
+    /**
+     * The POSIX group ID used for all EFS operations by this user.
+     * @min 0
+     * @max 4294967295
+     */
+    Gid: number;
+    /**
+     * The secondary POSIX group IDs used for all EFS operations by this user.
+     */
+    SecondaryGids?: number[] | undefined;
+    /**
+     * The POSIX user ID used for all EFS operations by this user.
+     * @min 0
+     * @max 4294967295
+     */
+    Uid: number;
+};
+//# sourceMappingURL=aws-transfer-user.d.ts.map