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

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::DescribedWebApp

Includes:

Structure

Defined in:

lib/aws-sdk-transfer/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_endpoint ⇒ String

  The ‘AccessEndpoint` is the URL that you provide to your users for them to interact with the Transfer Family web app.

• #arn ⇒ String

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

• #described_endpoint_details ⇒ Types::DescribedWebAppEndpointDetails

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

• #described_identity_provider_details ⇒ Types::DescribedWebAppIdentityProviderDetails

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

• #endpoint_type ⇒ String

  The type of endpoint hosting the web app.

• #tags ⇒ Array<Types::Tag>

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

• #web_app_endpoint ⇒ String

  The ‘WebAppEndpoint` is the unique URL for your Transfer Family web app.

• #web_app_endpoint_policy ⇒ String

  Setting for the type of endpoint policy for the web app.

• #web_app_id ⇒ String

  The unique identifier for the web app.

• #web_app_units ⇒ Types::WebAppUnits

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

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)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

#arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

#described_endpoint_details ⇒ Types::DescribedWebAppEndpointDetails

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

Returns:

• (Types::DescribedWebAppEndpointDetails)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

• (Types::DescribedWebAppIdentityProviderDetails)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

#endpoint_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

• (Array<Types::Tag>)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

#web_app_id ⇒ String

The unique identifier for the web app.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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

• (Types::WebAppUnits)

# File 'lib/aws-sdk-transfer/types.rb', line 3553

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