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

Class: Aws::ApiGatewayV2::Types::UpdateAuthorizerInput

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

Overview

The input parameters for an UpdateAuthorizer request.

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_credentials_arnString

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Returns:

  • (String)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

class UpdateAuthorizerInput < Struct.new(
  :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

The time to live (TTL), in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Returns:

  • (Integer)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

class UpdateAuthorizerInput < Struct.new(
  :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)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

class UpdateAuthorizerInput < Struct.new(
  :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

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id\}:function:{lambda_function_name\}/invocations. In general, the URI has this form: arn:aws:apigateway:{region\}:lambda:path/{service_api\} , where {region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Returns:

  • (String)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

class UpdateAuthorizerInput < Struct.new(
  :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>)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

class UpdateAuthorizerInput < Struct.new(
  :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

The validation expression does not apply to the REQUEST authorizer.

Returns:

  • (String)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

class UpdateAuthorizerInput < Struct.new(
  :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

The name of the authorizer.

Returns:

  • (String)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

class UpdateAuthorizerInput < Struct.new(
  :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>)


4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4950

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