Package software.amazon.awscdk.services.transfer

Class CfnWebApp

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transfer.CfnWebApp
All Implemented Interfaces:
IInspectable, ITaggableV2, IWebAppRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:48.571Z") @Stability(Stable) public class CfnWebApp extends CfnResource implements IInspectable, IWebAppRef, ITaggableV2
Creates a web app based on specified parameters, and returns the ID for the new web app.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CfnWebApp cfnWebApp = CfnWebApp.Builder.create(this, "MyCfnWebApp")
         .identityProviderDetails(IdentityProviderDetailsProperty.builder()
                 .applicationArn("applicationArn")
                 .instanceArn("instanceArn")
                 .role("role")
                 .build())
         // the properties below are optional
         .accessEndpoint("accessEndpoint")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWebApp

      protected CfnWebApp(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWebApp

      protected CfnWebApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWebApp

      @Stability(Stable) public CfnWebApp(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWebAppProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the web app.

    • getAttrIdentityProviderDetailsApplicationArn

      @Stability(Stable) @NotNull public String getAttrIdentityProviderDetailsApplicationArn()
      The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.

    • getAttrWebAppId

      @Stability(Stable) @NotNull public String getAttrWebAppId()
      The unique identifier for the web app.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getWebAppRef

      @Stability(Stable) @NotNull public WebAppReference getWebAppRef()
      A reference to a WebApp resource.
      Specified by:
      getWebAppRef in interface IWebAppRef

    • getIdentityProviderDetails

      @Stability(Stable) @NotNull public Object getIdentityProviderDetails()
      You can provide a structure that contains the details for the identity provider to use with your web app.

      Returns union: either IResolvable or CfnWebApp.IdentityProviderDetailsProperty

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@NotNull IResolvable value)
      You can provide a structure that contains the details for the identity provider to use with your web app.

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@NotNull CfnWebApp.IdentityProviderDetailsProperty value)
      You can provide a structure that contains the details for the identity provider to use with your web app.

    • getAccessEndpoint

      @Stability(Stable) @Nullable public String getAccessEndpoint()
      The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.

    • setAccessEndpoint

      @Stability(Stable) public void setAccessEndpoint(@Nullable String value)
      The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Key-value pairs that can be used to group and search for web apps.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Key-value pairs that can be used to group and search for web apps.

    • getWebAppCustomization

      @Stability(Stable) @Nullable public Object getWebAppCustomization()
      A structure that contains the customization fields for the web app.

      Returns union: either IResolvable or CfnWebApp.WebAppCustomizationProperty

    • setWebAppCustomization

      @Stability(Stable) public void setWebAppCustomization(@Nullable IResolvable value)
      A structure that contains the customization fields for the web app.

    • setWebAppCustomization

      @Stability(Stable) public void setWebAppCustomization(@Nullable CfnWebApp.WebAppCustomizationProperty value)
      A structure that contains the customization fields for the web app.

    • getWebAppEndpointPolicy

      @Stability(Stable) @Nullable public String getWebAppEndpointPolicy()
      Setting for the type of endpoint policy for the web app.

      The default value is STANDARD .

    • setWebAppEndpointPolicy

      @Stability(Stable) public void setWebAppEndpointPolicy(@Nullable String value)
      Setting for the type of endpoint policy for the web app.

      The default value is STANDARD .

    • getWebAppUnits

      @Stability(Stable) @Nullable public 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 CfnWebApp.WebAppUnitsProperty

    • setWebAppUnits

      @Stability(Stable) public void setWebAppUnits(@Nullable IResolvable value)
      A union that contains the value for number of concurrent connections or the user sessions on your web app.

    • setWebAppUnits

      @Stability(Stable) public void setWebAppUnits(@Nullable CfnWebApp.WebAppUnitsProperty value)
      A union that contains the value for number of concurrent connections or the user sessions on your web app.