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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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, COGNITO_USER_POOLS
  provider_arns: ["ProviderARN"],
  auth_type: "String",
  authorizer_uri: "String",
  authorizer_credentials: "String",
  identity_source: "String", # required
  identity_validation_expression: "String",
  authorizer_result_ttl_in_seconds: 1,
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#auth_typeString

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#authorizer_credentialsString

Specifies the credentials required for the authorizer, if any.

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#authorizer_result_ttl_in_secondsInteger

The TTL of cached authorizer results.

Returns:

  • (Integer)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#authorizer_uriString

[Required] Specifies the authorizer's Uniform Resource Identifier (URI).

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#identity_sourceString

[Required] The source of the identity in an incoming request.

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#identity_validation_expressionString

A validation expression for the incoming identity.

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#nameString

[Required] The name of the authorizer.

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#provider_arnsArray<String>

A list of the Cognito Your User Pool authorizer's provider ARNs.

Returns:

  • (Array<String>)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end

#typeString

[Required] The type of the authorizer.

Returns:

  • (String)


588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 588

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)
  include Aws::Structure
end