CreateAuthorizerResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
    - - software.amazon.awssdk.services.apigatewayv2.model.CreateAuthorizerResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateAuthorizerResponse.Builder,CreateAuthorizerResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAuthorizerResponse
extends ApiGatewayV2Response
implements ToCopyableBuilder<CreateAuthorizerResponse.Builder,CreateAuthorizerResponse>

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`	`authorizerCredentialsArn()` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`String`	`authorizerId()` The authorizer identifier.
`Integer`	`authorizerResultTtlInSeconds()` The time to live (TTL), in seconds, of cached authorizer results.
`AuthorizerType`	`authorizerType()` The authorizer type.
`String`	`authorizerTypeAsString()` The authorizer type.
`String`	`authorizerUri()` The authorizer's Uniform Resource Identifier (URI).
`static CreateAuthorizerResponse.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<String>`	`identitySource()` The identity source for which authorization is requested.
`String`	`identityValidationExpression()` The validation expression does not apply to the REQUEST authorizer.
`String`	`name()` The name of the authorizer.
`List<String>`	`providerArns()` For REQUEST authorizer, this is not defined.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAuthorizerResponse.Builder>`	`serializableBuilderClass()`
`CreateAuthorizerResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
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
  - authorizerCredentialsArn
```
public String authorizerCredentialsArn()
```
    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.
  - authorizerId
```
public String authorizerId()
```
    The authorizer identifier.
    
    Returns:
    
    The authorizer identifier.
  - authorizerResultTtlInSeconds
```
public Integer authorizerResultTtlInSeconds()
```
    The time to live (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 time to live (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.
  - authorizerType
```
public AuthorizerType authorizerType()
```
    The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
    
    If the service returns an enum value that is not available in the current SDK version, authorizerType will return AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizerTypeAsString().
    
    Returns:
    
    The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
    
    See Also:
    
    AuthorizerType
  - authorizerTypeAsString
```
public String authorizerTypeAsString()
```
    The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
    
    If the service returns an enum value that is not available in the current SDK version, authorizerType will return AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizerTypeAsString().
    
    Returns:
    
    The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
    
    See Also:
    
    AuthorizerType
  - authorizerUri
```
public String authorizerUri()
```
    The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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:
    
    The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.
  - identitySource
```
public List<String> identitySource()
```
    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 and a Name query string parameters 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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 and a Name query string parameters 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 String identityValidationExpression()
```
    The validation expression does not apply to the REQUEST authorizer.
    
    Returns:
    
    The validation expression does not apply to the REQUEST authorizer.
  - name
```
public String name()
```
    The name of the authorizer.
    
    Returns:
    
    The name of the authorizer.
  - providerArns
```
public List<String> providerArns()
```
    For REQUEST authorizer, this is not defined.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    For REQUEST authorizer, this is not defined.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateAuthorizerResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response

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

authorizerCredentialsArn

authorizerId

authorizerResultTtlInSeconds

authorizerType

authorizerTypeAsString

authorizerUri

identitySource

identityValidationExpression

name

providerArns

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields