Class: Aws::Transfer::Types::DescribedWebApp

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

Overview

A structure that describes the parameters for the web app, as identified by the WebAppId.

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.

Returns:

  • (String) 


3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3112

class DescribedWebApp < Struct.new(
  :arn,
  :web_app_id,
  :described_identity_provider_details,
  :access_endpoint,
  :web_app_endpoint,
  :web_app_units,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

  • (String) 


3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3112

class DescribedWebApp < Struct.new(
  :arn,
  :web_app_id,
  :described_identity_provider_details,
  :access_endpoint,
  :web_app_endpoint,
  :web_app_units,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#described_identity_provider_details ⇒ Types::DescribedWebAppIdentityProviderDetails

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

Returns:



3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3112

class DescribedWebApp < Struct.new(
  :arn,
  :web_app_id,
  :described_identity_provider_details,
  :access_endpoint,
  :web_app_endpoint,
  :web_app_units,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.

Returns:



3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3112

class DescribedWebApp < Struct.new(
  :arn,
  :web_app_id,
  :described_identity_provider_details,
  :access_endpoint,
  :web_app_endpoint,
  :web_app_units,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#web_app_endpoint ⇒ String

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.

Returns:

  • (String) 


3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3112

class DescribedWebApp < Struct.new(
  :arn,
  :web_app_id,
  :described_identity_provider_details,
  :access_endpoint,
  :web_app_endpoint,
  :web_app_units,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#web_app_id ⇒ String

The unique identifier for the web app.

Returns:

  • (String) 


3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3112

class DescribedWebApp < Struct.new(
  :arn,
  :web_app_id,
  :described_identity_provider_details,
  :access_endpoint,
  :web_app_endpoint,
  :web_app_units,
  :tags)
  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:



3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3112

class DescribedWebApp < Struct.new(
  :arn,
  :web_app_id,
  :described_identity_provider_details,
  :access_endpoint,
  :web_app_endpoint,
  :web_app_units,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end