Class: Aws::ApiGatewayV2::Types::UpdateAuthorizerRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::UpdateAuthorizerRequest
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_id ⇒ String
-
#authorizer_credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
-
#authorizer_id ⇒ String
-
#authorizer_payload_format_version ⇒ String
A string with a length between [1-64].
-
#authorizer_result_ttl_in_seconds ⇒ Integer
An integer with a value between [0-3600].
-
#authorizer_type ⇒ String
The authorizer type.
-
#authorizer_uri ⇒ String
A string representation of a URI with a length between [1-2048].
-
#enable_simple_responses ⇒ Boolean
-
#identity_source ⇒ Array<String>
The identity source for which authorization is requested.
-
#identity_validation_expression ⇒ String
A string with a length between [0-1024].
-
#jwt_configuration ⇒ Types::JWTConfiguration
Represents the configuration of a JWT authorizer.
-
#name ⇒ String
A string with a length between [1-128].
Instance Attribute Details
#api_id ⇒ String
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#authorizer_credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#authorizer_id ⇒ String
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#authorizer_payload_format_version ⇒ String
A string with a length between [1-64].
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#authorizer_result_ttl_in_seconds ⇒ Integer
An integer with a value between [0-3600].
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#authorizer_type ⇒ String
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#authorizer_uri ⇒ String
A string representation of a URI with a length between [1-2048].
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#enable_simple_responses ⇒ Boolean
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#identity_source ⇒ Array<String>
The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#identity_validation_expression ⇒ String
A string with a length between [0-1024].
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#jwt_configuration ⇒ Types::JWTConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A string with a length between [1-128].
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6290 class UpdateAuthorizerRequest < Struct.new( :api_id, :authorizer_credentials_arn, :authorizer_id, :authorizer_result_ttl_in_seconds, :authorizer_type, :authorizer_uri, :identity_source, :identity_validation_expression, :jwt_configuration, :name, :authorizer_payload_format_version, :enable_simple_responses) SENSITIVE = [] include Aws::Structure end |