DescribedWebApp
A structure that describes the parameters for the web app, as identified by the WebAppId.
Contents
- Arn
-
The Amazon Resource Name (ARN) of the web app.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1600.
Pattern:
arn:\S+Required: Yes
- WebAppId
-
The unique identifier for the web app.
Type: String
Length Constraints: Fixed length of 24.
Pattern:
webapp-[0-9a-f]{17}Required: Yes
- AccessEndpoint
-
The
AccessEndpointis 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- DescribedIdentityProviderDetails
-
A structure that contains the details for the identity provider used by the web app.
Type: DescribedWebAppIdentityProviderDetails object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- 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.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
- WebAppEndpoint
-
The
WebAppEndpointis the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- WebAppUnits
-
A union that contains the value for number of concurrent connections or the user sessions on your web app.
Type: WebAppUnits object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
