Class: Aws::LambdaWeb::Types::EndpointConfig

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

Overview

The configuration for a web function endpoint.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_type ⇒ String

The authorization type for the 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) 


784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deployment_mode ⇒ String

The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.

Valid values:

  • LatestRevision – The endpoint automatically serves the newest revision.

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

Returns:

  • (String) 


784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the endpoint.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_name ⇒ String

The name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The name is limited to 64 characters in length.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_type ⇒ String

The type of endpoint. Determines how traffic is served and routed across Regions.

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) 


784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

Returns:

  • (Array<String>) 


784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_config ⇒ Types::ScalingConfig

The scaling configuration for the endpoint.

Returns:



784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end

#throttle_config ⇒ Types::ThrottleConfig

The throttling configuration for the endpoint.

Returns:



784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/types.rb', line 784

class EndpointConfig < Struct.new(
  :endpoint_name,
  :description,
  :endpoint_type,
  :auth_type,
  :auto_deployment_mode,
  :regions,
  :scaling_config,
  :throttle_config)
  SENSITIVE = []
  include Aws::Structure
end