AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Transfer::WebApp

CfnWebApp

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 AWS Transfer Family , see [Create a Transfer Family web app in a VPC](https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html) .

Import

import { CfnWebApp } from 'aws-cdk-lib/aws-transfer';

Or use the module namespace:

import * as transfer from 'aws-cdk-lib/aws-transfer';
// transfer.CfnWebApp

Properties

Configuration passed to the constructor as CfnWebAppProps.

identityProviderDetailsRequired
IResolvable | IdentityProviderDetailsProperty

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](https://docs.aws.amazon.com//transfer/latest/userguide/webapp-identity-center.html) .

accessEndpointOptional
string

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](https://docs.aws.amazon.com//transfer/latest/userguide/webapp-customize.html) .

endpointDetailsOptional
IResolvable | EndpointDetailsProperty
tagsOptional
CfnTag[]

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

webAppCustomizationOptional
IResolvable | WebAppCustomizationProperty

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.

webAppEndpointPolicyOptional
string

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.

webAppUnitsOptional
IResolvable | WebAppUnitsProperty

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Transfer::WebAppView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-transfer
CFN TypeAWS::Transfer::WebApp
Properties7

Related Constructs

Explore This Service

External Links