You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateAuthorizerRequest data as a hash:

{
  api_id: "__string", # required
  authorizer_credentials_arn: "Arn",
  authorizer_result_ttl_in_seconds: 1,
  authorizer_type: "REQUEST", # required, accepts REQUEST
  authorizer_uri: "UriWithLengthBetween1And2048", # required
  identity_source: ["__string"], # required
  identity_validation_expression: "StringWithLengthBetween0And1024",
  name: "StringWithLengthBetween1And128", # required
  provider_arns: ["Arn"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#authorizer_credentials_arnString

Represents an Amazon Resource Name (ARN).

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#authorizer_result_ttl_in_secondsInteger

An integer with a value between [0-3600].

Returns:

  • (Integer)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#authorizer_typeString

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#authorizer_uriString

A string representation of a URI with a length between [1-2048].

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#identity_sourceArray<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>)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#identity_validation_expressionString

A string with a length between [0-1024].

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#nameString

A string with a length between [1-128].

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end

#provider_arnsArray<String>

For REQUEST authorizer, this is not defined.

Returns:

  • (Array<String>)


712
713
714
715
716
717
718
719
720
721
722
723
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 712

class CreateAuthorizerRequest < Struct.new(
  :api_id,
  :authorizer_credentials_arn,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :name,
  :provider_arns)
  include Aws::Structure
end