Class: Aws::ApiGatewayV2::Types::CreatePortalResponseContent

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::CreatePortalResponseContent

Includes:

Structure

Defined in:

lib/aws-sdk-apigatewayv2/types.rb

Overview

Creates a portal.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authorization ⇒ Types::Authorization

  The authorization for the portal.

• #endpoint_configuration ⇒ Types::EndpointConfigurationResponse

  The endpoint configuration.

• #included_portal_product_arns ⇒ Array<String>

  The ARNs of the portal products included in the portal.

• #last_modified ⇒ Time

  The timestamp when the portal configuration was last modified.

• #last_published ⇒ Time

  The timestamp when the portal was last published.

• #last_published_description ⇒ String

  A user-written description of the changes made in the last published version of the portal.

• #portal_arn ⇒ String

  The ARN of the portal.

• #portal_content ⇒ Types::PortalContent

  The name, description, and theme for the portal.

• #portal_id ⇒ String

  The portal identifier.

• #publish_status ⇒ String

  The current publishing status of the portal.

• #rum_app_monitor_name ⇒ String

  The name of the Amazon CloudWatch RUM app monitor.

• #status_exception ⇒ Types::StatusException

  Error information for failed portal operations.

• #tags ⇒ Hash<String,String>

  The collection of tags.

Instance Attribute Details

#authorization ⇒ Types::Authorization

The authorization for the portal. Supports Cognito-based user authentication or no authentication.

Returns:

• (Types::Authorization)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_configuration ⇒ Types::EndpointConfigurationResponse

The endpoint configuration.

Returns:

• (Types::EndpointConfigurationResponse)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#included_portal_product_arns ⇒ Array<String>

The ARNs of the portal products included in the portal.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ Time

The timestamp when the portal configuration was last modified.

Returns:

• (Time)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_published ⇒ Time

The timestamp when the portal was last published.

Returns:

• (Time)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_published_description ⇒ String

A user-written description of the changes made in the last published version of the portal.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portal_arn ⇒ String

The ARN of the portal.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portal_content ⇒ Types::PortalContent

The name, description, and theme for the portal.

Returns:

• (Types::PortalContent)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portal_id ⇒ String

The portal identifier.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#publish_status ⇒ String

The current publishing status of the portal.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rum_app_monitor_name ⇒ String

The name of the Amazon CloudWatch RUM app monitor.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_exception ⇒ Types::StatusException

Error information for failed portal operations. Contains details about any issues encountered during portal creation or publishing.

Returns:

• (Types::StatusException)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 2538

class CreatePortalResponseContent < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end