AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::ApiGatewayV2::Types::UpdateAuthorizerRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateAuthorizerRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

Returns:

  • (String)

#authorizer_credentials_arnString

Represents an Amazon Resource Name (ARN).

Returns:

  • (String)

    Represents an Amazon Resource Name (ARN).

    .

#authorizer_idString

Returns:

  • (String)

#authorizer_result_ttl_in_secondsInteger

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

Returns:

  • (Integer)

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

    .

#authorizer_typeString

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

Possible values:

  • REQUEST
  • JWT

Returns:

  • (String)

    The authorizer type.

#authorizer_uriString

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

Returns:

  • (String)

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

    .

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

    The identity source for which authorization is requested.

#identity_validation_expressionString

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

Returns:

  • (String)

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

    .

#jwt_configurationTypes::JWTConfiguration

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Returns:

#nameString

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

Returns:

  • (String)

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

    .