AWS::Transfer::WebApp

Filter View

All

Creates a web app based on specified parameters, and returns the ID for the new web app.

Syntax

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

JSON

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

YAML

Type: AWS::Transfer::WebApp
Properties:
  AccessEndpoint: String
  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

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 AWS 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.

WebAppId

The unique identifier for the web app.