CreateAuthorizerResponse (AWS Java SDK :: Services :: Amazon API Gateway 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
    - - software.amazon.awssdk.services.apigateway.model.CreateAuthorizerResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAuthorizerResponse.Builder,CreateAuthorizerResponse>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAuthorizerResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<CreateAuthorizerResponse.Builder,CreateAuthorizerResponse>
```
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateAuthorizerResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateAuthorizerResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`authorizerCredentials()` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`Integer`	`authorizerResultTtlInSeconds()` The TTL in seconds of cached authorizer results.
`String`	`authorizerUri()` Specifies the authorizer's Uniform Resource Identifier (URI).
`String`	`authType()` Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
`static CreateAuthorizerResponse.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasProviderARNs()` Returns true if the ProviderARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`id()` The identifier for the authorizer resource.
`String`	`identitySource()` The identity source for which authorization is requested.
`String`	`identityValidationExpression()` A validation expression for the incoming identity token.
`String`	`name()` [Required] The name of the authorizer.
`List<String>`	`providerARNs()` A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAuthorizerResponse.Builder>`	`serializableBuilderClass()`
`CreateAuthorizerResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`AuthorizerType`	`type()` The authorizer type.
`String`	`typeAsString()` The authorizer type.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public final String id()
```
    The identifier for the authorizer resource.
    
    Returns:
    
    The identifier for the authorizer resource.
  - name
```
public final String name()
```
    [Required] The name of the authorizer.
    
    Returns:
    
    [Required] The name of the authorizer.
  - type
```
public final AuthorizerType type()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, type will return AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AuthorizerType
  - typeAsString
```
public final String typeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, type will return AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AuthorizerType
  - hasProviderARNs
```
public final boolean hasProviderARNs()
```
    Returns true if the ProviderARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - providerARNs
```
public final List<String> providerARNs()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasProviderARNs() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - authType
```
public final String authType()
```
    Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    
    Returns:
    
    Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
  - authorizerUri
```
public final String authorizerUri()
```
    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/[FunctionARN]/invocations.
    
    Returns:
    
    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/[FunctionARN]/invocations.
  - authorizerCredentials
```
public final String authorizerCredentials()
```
    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:
    
    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.
  - identitySource
```
public final String identitySource()
```
    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:
    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.
  - identityValidationExpression
```
public final String identityValidationExpression()
```
    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:
    
    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.
  - authorizerResultTtlInSeconds
```
public final Integer authorizerResultTtlInSeconds()
```
    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:
    
    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.
  - toBuilder
```
public CreateAuthorizerResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateAuthorizerResponse.Builder,CreateAuthorizerResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static CreateAuthorizerResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAuthorizerResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateAuthorizerResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

type

typeAsString

hasProviderARNs

providerARNs

authType

authorizerUri

authorizerCredentials

identitySource

identityValidationExpression

authorizerResultTtlInSeconds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields