@propulsionworks/cloudformation 0.1.0 → 0.1.2

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

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html}
  */
 export type TransferServerProps = {
     /**
@@ -24,14 +29,17 @@ export type TransferServerProps = {
      * > 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-certificate}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-domain}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointdetails}
      */
     EndpointDetails?: EndpointDetails | undefined;
     /**
@@ -42,10 +50,12 @@ export type TransferServerProps = {
      * > 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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointtype}
      */
     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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityproviderdetails}
      */
     IdentityProviderDetails?: IdentityProviderDetails | undefined;
     /**
@@ -56,6 +66,7 @@ export type TransferServerProps = {
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityprovidertype}
      */
     IdentityProviderType?: IdentityProviderType | undefined;
     /**
@@ -63,6 +74,7 @@ export type TransferServerProps = {
      * @minLength 0
      * @maxLength 2048
      * @pattern ^(|arn:.*role/\S+)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-loggingrole}
      */
     LoggingRole?: string | undefined;
     /**
@@ -72,6 +84,7 @@ export type TransferServerProps = {
      * @minLength 0
      * @maxLength 4096
      * @pattern ^[\x09-\x0D\x20-\x7E]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-postauthenticationloginbanner}
      */
     PostAuthenticationLoginBanner?: string | undefined;
     /**
@@ -81,6 +94,7 @@ export type TransferServerProps = {
      * @minLength 0
      * @maxLength 4096
      * @pattern ^[\x09-\x0D\x20-\x7E]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-preauthenticationloginbanner}
      */
     PreAuthenticationLoginBanner?: string | undefined;
     /**
@@ -94,6 +108,7 @@ export type TransferServerProps = {
      * The `Protocols` parameter is an array of strings.
      *
      * *Allowed values* : One or more of `SFTP` , `FTPS` , `FTP` , `AS2`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-protocoldetails}
      */
     ProtocolDetails?: ProtocolDetails | undefined;
     /**
@@ -113,12 +128,14 @@ export type TransferServerProps = {
      * The `Protocols` parameter is an array of strings.
      *
      * *Allowed values* : One or more of `SFTP` , `FTPS` , `FTP` , `AS2`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-protocols}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-s3storageoptions}
      */
     S3StorageOptions?: S3StorageOptions | undefined;
     /**
@@ -126,6 +143,7 @@ export type TransferServerProps = {
      * @minLength 0
      * @maxLength 100
      * @pattern ^TransferSecurityPolicy-.+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-securitypolicyname}
      */
     SecurityPolicyName?: string | undefined;
     /**
@@ -140,31 +158,39 @@ export type TransferServerProps = {
      * 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`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-structuredlogdestinations}
      */
     StructuredLogDestinations?: string[] | undefined;
     /**
      * Key-value pairs that can be used to group and search for servers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-tags}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-workflowdetails}
      */
     WorkflowDetails?: WorkflowDetails | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#aws-resource-transfer-server-return-values}
+ */
 export type TransferServerAttribs = {
     /**
      * Specifies the unique Amazon Resource Name (ARN) of the server.
      * @minLength 20
      * @maxLength 1600
      * @pattern ^arn:\S+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-arn}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-as2servicemanagedegressipaddresses}
      */
     As2ServiceManagedEgressIpAddresses: string[];
     /**
@@ -172,23 +198,33 @@ export type TransferServerAttribs = {
      * @minLength 19
      * @maxLength 19
      * @pattern ^s-([0-9a-f]{17})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-serverid}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-state}
      */
     State: State;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-as2transport.html}
+ */
 export type As2Transport = "HTTP";
 /**
  * Indicates whether optimization to directory listing on S3 servers is used. Disabled by default for compatibility.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-directorylistingoptimization.html}
  */
 export type DirectoryListingOptimization = "ENABLED" | "DISABLED";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-domain.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html}
  */
 export type EndpointDetails = {
     /**
@@ -206,6 +242,7 @@ export type EndpointDetails = {
      * > - 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-addressallocationids}
      */
     AddressAllocationIds?: string[] | undefined;
     /**
@@ -214,12 +251,14 @@ export type EndpointDetails = {
      * > 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-securitygroupids}
      */
     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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-subnetids}
      */
     SubnetIds?: string[] | undefined;
     /**
@@ -229,18 +268,24 @@ export type EndpointDetails = {
      * @minLength 22
      * @maxLength 22
      * @pattern ^vpce-[0-9a-f]{17}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcendpointid}
      */
     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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcid}
      */
     VpcId?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointtype.html}
+ */
 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` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html}
  */
 export type IdentityProviderDetails = {
     /**
@@ -248,6 +293,7 @@ export type IdentityProviderDetails = {
      * @minLength 12
      * @maxLength 12
      * @pattern ^d-[0-9a-f]{10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-directoryid}
      */
     DirectoryId?: string | undefined;
     /**
@@ -255,6 +301,7 @@ export type IdentityProviderDetails = {
      * @minLength 1
      * @maxLength 170
      * @pattern ^arn:[a-z-]+:lambda:.*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-function}
      */
     Function?: string | undefined;
     /**
@@ -262,6 +309,7 @@ export type IdentityProviderDetails = {
      * @minLength 20
      * @maxLength 2048
      * @pattern ^arn:.*role/\S+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-invocationrole}
      */
     InvocationRole?: string | undefined;
     /**
@@ -271,16 +319,24 @@ export type IdentityProviderDetails = {
      * - `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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-sftpauthenticationmethods}
      */
     SftpAuthenticationMethods?: SftpAuthenticationMethods | undefined;
     /**
      * Provides the location of the service endpoint used to authenticate users.
      * @minLength 0
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-url}
      */
     Url?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityprovidertype.html}
+ */
 export type IdentityProviderType = "SERVICE_MANAGED" | "API_GATEWAY" | "AWS_DIRECTORY_SERVICE" | "AWS_LAMBDA";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocol.html}
+ */
 export type Protocol = "SFTP" | "FTP" | "FTPS" | "AS2";
 /**
  * The protocol settings that are configured for your server.
@@ -289,10 +345,12 @@ export type Protocol = "SFTP" | "FTP" | "FTPS" | "AS2";
  * - 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html}
  */
 export type ProtocolDetails = {
     /**
      * List of `As2Transport` objects.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-as2transports}
      */
     As2Transports?: As2Transport[] | undefined;
     /**
@@ -309,6 +367,7 @@ export type ProtocolDetails = {
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-passiveip}
      */
     PassiveIp?: string | undefined;
     /**
@@ -319,6 +378,7 @@ export type ProtocolDetails = {
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-setstatoption}
      */
     SetStatOption?: SetStatOption | undefined;
     /**
@@ -329,28 +389,44 @@ export type ProtocolDetails = {
      * - `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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-tlssessionresumptionmode}
      */
     TlsSessionResumptionMode?: TlsSessionResumptionMode | undefined;
 };
 /**
  * The Amazon S3 storage options that are configured for your server.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-s3storageoptions.html}
  */
 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-s3storageoptions.html#cfn-transfer-server-s3storageoptions-directorylistingoptimization}
      */
     DirectoryListingOptimization?: DirectoryListingOptimization | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-setstatoption.html}
+ */
 export type SetStatOption = "DEFAULT" | "ENABLE_NO_OP";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-sftpauthenticationmethods.html}
+ */
 export type SftpAuthenticationMethods = "PASSWORD" | "PUBLIC_KEY" | "PUBLIC_KEY_OR_PASSWORD" | "PUBLIC_KEY_AND_PASSWORD";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-state.html}
+ */
 export type State = "OFFLINE" | "ONLINE" | "STARTING" | "STOPPING" | "START_FAILED" | "STOP_FAILED";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-tlssessionresumptionmode.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html}
  */
 export type WorkflowDetail = {
     /**
@@ -358,6 +434,7 @@ export type WorkflowDetail = {
      * @minLength 20
      * @maxLength 2048
      * @pattern ^arn:.*role/\S+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html#cfn-transfer-server-workflowdetail-executionrole}
      */
     ExecutionRole: string;
     /**
@@ -365,11 +442,13 @@ export type WorkflowDetail = {
      * @minLength 19
      * @maxLength 19
      * @pattern ^w-([a-z0-9]{17})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html#cfn-transfer-server-workflowdetail-workflowid}
      */
     WorkflowId: string;
 };
 /**
  * Container for the `WorkflowDetail` data type. It is used by actions that trigger a workflow to begin execution.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html}
  */
 export type WorkflowDetails = {
     /**
@@ -378,6 +457,7 @@ export type WorkflowDetails = {
      * A *partial upload* occurs when a file is open when the session disconnects.
      *
      * > `OnPartialUpload` can contain a maximum of one `WorkflowDetail` object.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html#cfn-transfer-server-workflowdetails-onpartialupload}
      */
     OnPartialUpload?: WorkflowDetail[] | undefined;
     /**
@@ -388,6 +468,7 @@ export type WorkflowDetails = {
      * `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'`
      *
      * > `OnUpload` can contain a maximum of one `WorkflowDetail` object.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html#cfn-transfer-server-workflowdetails-onupload}
      */
     OnUpload?: WorkflowDetail[] | undefined;
 };

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

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html}
  */
 export type TransferUserProps = {
     /**
@@ -13,6 +18,7 @@ export type TransferUserProps = {
      * @minLength 0
      * @maxLength 1024
      * @pattern ^(|/.*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectory}
      */
     HomeDirectory?: string | undefined;
     /**
@@ -27,12 +33,14 @@ export type TransferUserProps = {
      * The following is an `Entry` and `Target` pair example for `chroot` .
      *
      * `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorymappings}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorytype}
      */
     HomeDirectoryType?: HomeDirectoryType | undefined;
     /**
@@ -45,10 +53,12 @@ export type TransferUserProps = {
      * > 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-policy}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-posixprofile}
      */
     PosixProfile?: PosixProfile | undefined;
     /**
@@ -56,6 +66,7 @@ export type TransferUserProps = {
      * @minLength 20
      * @maxLength 2048
      * @pattern ^arn:.*role/\S+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-role}
      */
     Role: string;
     /**
@@ -63,6 +74,7 @@ export type TransferUserProps = {
      * @minLength 19
      * @maxLength 19
      * @pattern ^s-([0-9a-f]{17})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-serverid}
      */
     ServerId: string;
     /**
@@ -71,10 +83,12 @@ export type TransferUserProps = {
      * > To delete the public key body, set its value to zero keys, as shown here:
      * >
      * > `SshPublicKeys: []`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -82,9 +96,13 @@ export type TransferUserProps = {
      * @minLength 3
      * @maxLength 100
      * @pattern ^[\w][\w@.-]{2,99}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-username}
      */
     UserName: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#aws-resource-transfer-user-return-values}
+ */
 export type TransferUserAttribs = {
     /**
      * The Amazon Resource Name associated with the user, in the form `arn:aws:transfer:region: *account-id* :user/ *server-id* / *username*` .
@@ -93,6 +111,7 @@ export type TransferUserAttribs = {
      * @minLength 20
      * @maxLength 1600
      * @pattern ^arn:\S+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-arn}
      */
     Arn: string;
     /**
@@ -102,6 +121,7 @@ export type TransferUserAttribs = {
      * @minLength 19
      * @maxLength 19
      * @pattern ^s-([0-9a-f]{17})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-serverid}
      */
     ServerId: string;
     /**
@@ -111,11 +131,13 @@ export type TransferUserAttribs = {
      * @minLength 3
      * @maxLength 100
      * @pattern ^[\w][\w@.-]{2,99}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-username}
      */
     UserName: string;
 };
 /**
  * Represents an object that contains entries and targets for `HomeDirectoryMappings` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html}
  */
 export type HomeDirectoryMapEntry = {
     /**
@@ -123,6 +145,7 @@ export type HomeDirectoryMapEntry = {
      * @minLength 0
      * @maxLength 1024
      * @pattern ^/.*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-entry}
      */
     Entry: string;
     /**
@@ -130,35 +153,47 @@ export type HomeDirectoryMapEntry = {
      * @minLength 0
      * @maxLength 1024
      * @pattern ^/.*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-target}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-type}
      */
     Type?: MapType | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorytype.html}
+ */
 export type HomeDirectoryType = "PATH" | "LOGICAL";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-maptype.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html}
  */
 export type PosixProfile = {
     /**
      * The POSIX group ID used for all EFS operations by this user.
      * @min 0
      * @max 4294967295
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html#cfn-transfer-user-posixprofile-gid}
      */
     Gid: number;
     /**
      * The secondary POSIX group IDs used for all EFS operations by this user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html#cfn-transfer-user-posixprofile-secondarygids}
      */
     SecondaryGids?: number[] | undefined;
     /**
      * The POSIX user ID used for all EFS operations by this user.
      * @min 0
      * @max 4294967295
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html#cfn-transfer-user-posixprofile-uid}
      */
     Uid: number;
 };