Package software.amazon.awscdk.cfnpropertymixins.services.transfer

Interface CfnWebAppMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebAppMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.899Z")
@Stability(Stable)
public interface CfnWebAppMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnWebAppPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.transfer.*;
 CfnWebAppMixinProps cfnWebAppMixinProps = CfnWebAppMixinProps.builder()
         .accessEndpoint("accessEndpoint")
         .endpointDetails(EndpointDetailsProperty.builder()
                 .vpc(VpcProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnetIds(List.of("subnetIds"))
                         .vpcId("vpcId")
                         .build())
                 .build())
         .identityProviderDetails(IdentityProviderDetailsProperty.builder()
                 .applicationArn("applicationArn")
                 .instanceArn("instanceArn")
                 .role("role")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .webAppCustomization(WebAppCustomizationProperty.builder()
                 .faviconFile("faviconFile")
                 .logoFile("logoFile")
                 .title("title")
                 .build())
         .webAppEndpointPolicy("webAppEndpointPolicy")
         .webAppUnits(WebAppUnitsProperty.builder()
                 .provisioned(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebAppMixinProps.Builder	A builder for CfnWebAppMixinProps
static final class	CfnWebAppMixinProps.Jsii$Proxy	An implementation for CfnWebAppMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnWebAppMixinProps.Builder	builder()
default String	getAccessEndpoint()	The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.
default Object	getEndpointDetails()	Returns union: either IResolvable or CfnWebAppPropsMixin.EndpointDetailsProperty
default Object	getIdentityProviderDetails()	You can provide a structure that contains the details for the identity provider to use with your web app.
default List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for web apps.
default Object	getWebAppCustomization()	A structure that contains the customization fields for the web app.
default String	getWebAppEndpointPolicy()	Setting for the type of endpoint policy for the web app.
default Object	getWebAppUnits()	A union that contains the value for number of concurrent connections or the user sessions on your web app.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessEndpoint

@Stability(Stable)
@Nullable
default String getAccessEndpoint()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-accessendpoint

getEndpointDetails

@Stability(Stable)
@Nullable
default Object getEndpointDetails()

Returns union: either IResolvable or CfnWebAppPropsMixin.EndpointDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-endpointdetails

getIdentityProviderDetails

@Stability(Stable)
@Nullable
default Object getIdentityProviderDetails()

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 .

Returns union: either IResolvable or CfnWebAppPropsMixin.IdentityProviderDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-identityproviderdetails

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Key-value pairs that can be used to group and search for web apps.

Tags are metadata attached to web apps for any purpose.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-tags

getWebAppCustomization

@Stability(Stable)
@Nullable
default Object getWebAppCustomization()

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.

Returns union: either IResolvable or CfnWebAppPropsMixin.WebAppCustomizationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-webappcustomization

getWebAppEndpointPolicy

@Stability(Stable)
@Nullable
default String getWebAppEndpointPolicy()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-webappendpointpolicy

getWebAppUnits

@Stability(Stable)
@Nullable
default Object getWebAppUnits()

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

Returns union: either IResolvable or CfnWebAppPropsMixin.WebAppUnitsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-webappunits

builder

@Stability(Stable)
static CfnWebAppMixinProps.Builder builder()

Returns:

a CfnWebAppMixinProps.Builder of CfnWebAppMixinProps