Skip to content

CreateWebAppRequest

Source code in docs_src/capo_transfer/types/create_web_app_request.py
class CreateWebAppRequest(TypedDict, closed=True):
    identity_provider_details: "capo_transfer.types.web_app_identity_provider_details.WebAppIdentityProviderDetails"
    """<p>You can provide a structure that contains the details for the identity provider to use with your web app.</p> <p>For more details about this parameter, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-identity-center.html">Configure your identity provider for Transfer Family web apps</a>.</p>"""
    access_endpoint: NotRequired[
        "capo_transfer.types.web_app_access_endpoint.WebAppAccessEndpoint"
    ]
    """<p>The <code>AccessEndpoint</code> 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.</p> <p>Before you enter a custom URL for this parameter, follow the steps described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-customize.html">Update your access endpoint with a custom URL</a>.</p>"""
    web_app_units: NotRequired["capo_transfer.types.web_app_units.WebAppUnits"]
    """<p>A union that contains the value for number of concurrent connections or the user sessions on your web app.</p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for web apps.</p>"""
    web_app_endpoint_policy: NotRequired[
        "capo_transfer.types.web_app_endpoint_policy.WebAppEndpointPolicy"
    ]
    """<p> Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>. </p> <p>If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to <code>FIPS</code>.</p>"""
    endpoint_details: NotRequired[
        "capo_transfer.types.web_app_endpoint_details.WebAppEndpointDetails"
    ]
    """<p>The endpoint configuration for the web app. You can specify whether the web app endpoint is publicly accessible or hosted within a VPC.</p>"""

access_endpoint instance-attribute

access_endpoint: NotRequired[WebAppAccessEndpoint]

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.

endpoint_details instance-attribute

endpoint_details: NotRequired[WebAppEndpointDetails]

The endpoint configuration for the web app. You can specify whether the web app endpoint is publicly accessible or hosted within a VPC.

identity_provider_details instance-attribute

identity_provider_details: WebAppIdentityProviderDetails

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.

tags instance-attribute

tags: NotRequired[Tags]

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

web_app_endpoint_policy instance-attribute

web_app_endpoint_policy: NotRequired[WebAppEndpointPolicy]

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

If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.

web_app_units instance-attribute

web_app_units: NotRequired[WebAppUnits]

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