Class: Aws::APIGateway::Types::CreateAuthorizerRequest

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

Overview

Note:

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

{
  rest_api_id: "String", # required
  name: "String", # required
  type: "TOKEN", # required, accepts TOKEN, REQUEST, COGNITO_USER_POOLS
  provider_arns: ["ProviderARN"],
  auth_type: "String",
  authorizer_uri: "String",
  authorizer_credentials: "String",
  identity_source: "String",
  identity_validation_expression: "String",
  authorizer_result_ttl_in_seconds: 1,
}

Request to add a new Authorizer to an existing RestApi resource.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_type ⇒ String

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Returns:

  • (String) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_credentials ⇒ String

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) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_result_ttl_in_seconds ⇒ Integer

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, 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) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_uri ⇒ String

Specifies the authorizer’s Uniform Resource Identifier (URI). For ‘TOKEN` or `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//invocations`.

Returns:

  • (String) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#identity_source ⇒ String

The identity source for which authorization is requested. * For a ‘TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required

and specifies the request header mapping expression for the custom
header holding the authorization token submitted by the client.
For example, if the token header name is `Auth`, the header
mapping expression is `method.request.header.Auth`.

  • 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:

  • (String) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#identity_validation_expression ⇒ String

A validation expression for the incoming identity token. For ‘TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer’s Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ‘REQUEST` authorizer.

Returns:

  • (String) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

[Required] The name of the authorizer.

Returns:

  • (String) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#provider_arns ⇒ Array<String>

A list of the Amazon Cognito user pool ARNs for the ‘COGNITO_USER_POOLS` authorizer. Each element is of this format: `arn:aws:cognito-idp:region:account_id:userpool/user_pool_id`. For a `TOKEN` or `REQUEST` authorizer, this is not defined.

Returns:

  • (Array<String>) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

[Required] The authorizer type. Valid values are ‘TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.

Returns:

  • (String) 


803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/aws-sdk-apigateway/types.rb', line 803

class CreateAuthorizerRequest < Struct.new(
  :rest_api_id,
  :name,
  :type,
  :provider_arns,
  :auth_type,
  :authorizer_uri,
  :authorizer_credentials,
  :identity_source,
  :identity_validation_expression,
  :authorizer_result_ttl_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end