AWS::Transfer::WebApp - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Transfer::WebApp

Creates a web app based on specified parameters, and returns the ID for the new web app. You can configure the web app to be publicly accessible or hosted within a VPC.

For more information about using VPC endpoints with Amazon Transfer Family, see Create a Transfer Family web app in a VPC.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Transfer::WebApp",
  "Properties" : {
      "AccessEndpoint" : String,
      "EndpointDetails" : EndpointDetails,
      "IdentityProviderDetails" : IdentityProviderDetails,
      "Tags" : [ Tag, ... ],
      "WebAppCustomization" : WebAppCustomization,
      "WebAppEndpointPolicy" : String,
      "WebAppUnits" : WebAppUnits
    }
}

Properties

AccessEndpoint

The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

EndpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.

Note

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services 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 Amazon Web Services 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.

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.

Required: No

Type: EndpointDetails

Update requires: No interruption

IdentityProviderDetails

You can provide a structure that contains the details for the identity provider to use with your web app.

For more details about this parameter, see Configure your identity provider for Transfer Family web apps.

Required: Yes

Type: IdentityProviderDetails

Update requires: No interruption

Tags

Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

WebAppCustomization

A structure that contains the customization fields for the web app. You can provide a title, logo, and icon to customize the appearance of your web app.

Required: No

Type: WebAppCustomization

Update requires: No interruption

WebAppEndpointPolicy

Setting for the type of endpoint policy for the web app. The default value is STANDARD.

If your web app was created in an Amazon GovCloud (US) Region, the value of this parameter can be FIPS, which indicates the web app endpoint is FIPS-compliant.

Required: No

Type: String

Allowed values: STANDARD | FIPS

Update requires: Replacement

WebAppUnits

A union that contains the value for number of concurrent connections or the user sessions on your web app.

Required: No

Type: WebAppUnits

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the web app ARN, such as arn:aws:transfer:us-east-2:123456789012:webapp/webapp-01234567890abcdef .

For more information about using the Ref function, see Ref.

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the web app.

IdentityProviderDetails.ApplicationArn

Property description not available.

VpcEndpointId

The identifier of the VPC endpoint created for the web app.

WebAppId

The unique identifier for the web app.