Class: Aws::LambdaWeb::Types::GetWebFunctionEndpointResponse

Inherits:

Struct

• Object
• Struct
• Aws::LambdaWeb::Types::GetWebFunctionEndpointResponse

Defined in:

gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb

Overview

Contains details about the web function endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auth_type ⇒ String

  The authorization type for a web function endpoint.

• #auto_deployment_mode ⇒ String

  The auto-deployment mode for a web function endpoint.

• #created_at ⇒ Time

  The date and time the endpoint was created.

• #description ⇒ String

  The description of the endpoint.

• #domain_name ⇒ String

  The domain name assigned to the endpoint.

• #endpoint_arn ⇒ String

  The Amazon Resource Name (ARN) of the endpoint.

• #endpoint_name ⇒ String

  The name of the endpoint.

• #endpoint_type ⇒ String

  The type of a web function endpoint.

• #function_arn ⇒ String

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

• #regional_endpoints ⇒ Hash<String,Types::RegionalEndpoint>

  The list of regional endpoint configurations.

• #regions ⇒ Array<String>

  The Regions configured for the endpoint.

• #revision_weights ⇒ Array<Types::RevisionWeight>

  The traffic distribution across revisions for the endpoint.

• #scaling_config ⇒ Types::ScalingConfig

  The scaling configuration for a web function endpoint.

• #state ⇒ String

  The current state of the endpoint.

• #state_reason ⇒ String

  The reason for the current state of the endpoint.

• #throttle_config ⇒ Types::ThrottleConfig

  The throttling configuration for a web function endpoint.

• #update_status ⇒ String

  The status of the most recent update to an endpoint.

• #update_status_reason ⇒ String

  The reason for the endpoint's most recent update status.

• #updated_at ⇒ Time

  The date and time the endpoint was last updated.

Instance Attribute Details

#auth_type ⇒ String

The authorization type for a web function endpoint.

Valid values:

• ApplicationManaged – Your application handles authorization.

• IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deployment_mode ⇒ String

The auto-deployment mode for a web function endpoint.

Valid values:

• LatestRevision – The endpoint automatically serves the newest revision.

• Disabled – Revision routing stays fixed until you change it.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time the endpoint was created.

Returns:

• (Time)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The domain name assigned to the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_arn ⇒ String

The Amazon Resource Name (ARN) of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_name ⇒ String

The name of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_type ⇒ String

The type of a web function endpoint.

Valid values:

• HomeRegion – Serves traffic from the Region where you created the web function.

• MultiRegion – Replicates across the Regions that you choose and routes each request to the nearest one.

• PerRegion – Creates a separate endpoint in each Region that you choose.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#function_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#regional_endpoints ⇒ Hash<String,Types::RegionalEndpoint>

The list of regional endpoint configurations.

Returns:

• (Hash<String,Types::RegionalEndpoint>)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

The Regions configured for the endpoint.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#revision_weights ⇒ Array<Types::RevisionWeight>

The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.

Returns:

• (Array<Types::RevisionWeight>)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_config ⇒ Types::ScalingConfig

The scaling configuration for a web function endpoint.

Returns:

• (Types::ScalingConfig)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

The reason for the current state of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#throttle_config ⇒ Types::ThrottleConfig

The throttling configuration for a web function endpoint.

Returns:

• (Types::ThrottleConfig)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#update_status ⇒ String

The status of the most recent update to an endpoint. Possible values:

• InProgress – The update is in progress.

• Successful – The update completed successfully.

• Failed – The update failed.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#update_status_reason ⇒ String

The reason for the endpoint's most recent update status.

Returns:

• (String)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the endpoint was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 1202

class GetWebFunctionEndpointResponse < Struct.new(
  :function_arn,
  :endpoint_arn,
  :endpoint_name,
  :description,
  :endpoint_type,
  :domain_name,
  :auth_type,
  :auto_deployment_mode,
  :revision_weights,
  :regions,
  :scaling_config,
  :throttle_config,
  :state,
  :state_reason,
  :update_status,
  :update_status_reason,
  :regional_endpoints,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end