Skip to content

DescribedWebApp

Source code in docs_src/capo_transfer/types/described_web_app.py
class DescribedWebApp(TypedDict, closed=True):
    arn: "capo_transfer.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the web app.</p>"""
    web_app_id: "capo_transfer.types.web_app_id.WebAppId"
    """<p>The unique identifier for the web app.</p>"""
    described_identity_provider_details: NotRequired[
        "capo_transfer.types.described_web_app_identity_provider_details.DescribedWebAppIdentityProviderDetails"
    ]
    """<p>A structure that contains the details for the identity provider used by the web app.</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>"""
    web_app_endpoint: NotRequired["capo_transfer.types.web_app_endpoint.WebAppEndpoint"]
    """<p>The <code>WebAppEndpoint</code> is the unique URL for your Transfer Family web app. This is the value that you use when you configure <b>Origins</b> on CloudFront.</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. Tags are metadata attached to web apps for any purpose.</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 your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be <code>FIPS</code>, which indicates the web app endpoint is FIPS-compliant.</p>"""
    endpoint_type: NotRequired[
        "capo_transfer.types.web_app_endpoint_type.WebAppEndpointType"
    ]
    """<p>The type of endpoint hosting the web app. Valid values are <code>PUBLIC</code> for publicly accessible endpoints and <code>VPC</code> for VPC-hosted endpoints that provide network isolation.</p>"""
    described_endpoint_details: NotRequired[
        "capo_transfer.types.described_web_app_endpoint_details.DescribedWebAppEndpointDetails"
    ]
    """<p>The endpoint configuration details for the web app, including VPC settings if the endpoint is 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.

arn instance-attribute

arn: Arn

The Amazon Resource Name (ARN) of the web app.

described_endpoint_details instance-attribute

described_endpoint_details: NotRequired[DescribedWebAppEndpointDetails]

The endpoint configuration details for the web app, including VPC settings if the endpoint is hosted within a VPC.

described_identity_provider_details instance-attribute

described_identity_provider_details: NotRequired[DescribedWebAppIdentityProviderDetails]

A structure that contains the details for the identity provider used by the web app.

endpoint_type instance-attribute

endpoint_type: NotRequired[WebAppEndpointType]

The type of endpoint hosting the web app. Valid values are PUBLIC for publicly accessible endpoints and VPC for VPC-hosted endpoints that provide network isolation.

tags instance-attribute

tags: NotRequired[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.

web_app_endpoint instance-attribute

web_app_endpoint: NotRequired[WebAppEndpoint]

The WebAppEndpoint is the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.

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 your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be FIPS, which indicates the web app endpoint is FIPS-compliant.

web_app_id instance-attribute

web_app_id: WebAppId

The unique identifier for the web app.

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.