Class: Aws::ApiGatewayV2::Types::CreateAuthorizerRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigatewayv2/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_id ⇒ String

Returns:

  • (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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).

Returns:

  • (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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].

Returns:

  • (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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].

Returns:

  • (Integer) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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).

Returns:

  • (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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].

Returns:

  • (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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

Returns:

  • (Boolean) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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.

Returns:

  • (Array<String>) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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].

Returns:

  • (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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.

Returns:



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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].

Returns:

  • (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 986

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :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