Class: Aws::Transfer::Types::CreateWebAppRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transfer/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_endpoint ⇒ String

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].

[1]: docs.aws.amazon.com/transfer/latest/userguide/webapp-customize.html

Returns:

  • (String) 


1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/aws-sdk-transfer/types.rb', line 1275

class CreateWebAppRequest < Struct.new(
  :identity_provider_details,
  :access_endpoint,
  :web_app_units,
  :tags,
  :web_app_endpoint_policy)
  SENSITIVE = []
  include Aws::Structure
end

#identity_provider_details ⇒ Types::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].

[1]: docs.aws.amazon.com/transfer/latest/userguide/webapp-identity-center.html

Returns:



1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/aws-sdk-transfer/types.rb', line 1275

class CreateWebAppRequest < Struct.new(
  :identity_provider_details,
  :access_endpoint,
  :web_app_units,
  :tags,
  :web_app_endpoint_policy)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/aws-sdk-transfer/types.rb', line 1275

class CreateWebAppRequest < Struct.new(
  :identity_provider_details,
  :access_endpoint,
  :web_app_units,
  :tags,
  :web_app_endpoint_policy)
  SENSITIVE = []
  include Aws::Structure
end

#web_app_endpoint_policy ⇒ String

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`.

Returns:

  • (String) 


1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/aws-sdk-transfer/types.rb', line 1275

class CreateWebAppRequest < Struct.new(
  :identity_provider_details,
  :access_endpoint,
  :web_app_units,
  :tags,
  :web_app_endpoint_policy)
  SENSITIVE = []
  include Aws::Structure
end

#web_app_units ⇒ Types::WebAppUnits

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

Returns:



1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/aws-sdk-transfer/types.rb', line 1275

class CreateWebAppRequest < Struct.new(
  :identity_provider_details,
  :access_endpoint,
  :web_app_units,
  :tags,
  :web_app_endpoint_policy)
  SENSITIVE = []
  include Aws::Structure
end