Package software.amazon.awssdk.services.apigateway.model

Class CreateAuthorizerRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.CreateAuthorizerRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateAuthorizerRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAuthorizerRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	authorizerCredentials()	Specifies the credentials required for the authorizer, if any.
Integer	authorizerResultTtlInSeconds()	The TTL of cached authorizer results.
String	authorizerUri()	[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
String	authType()	Optional customer-defined field, used in Swagger imports/exports.
static CreateAuthorizerRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	identitySource()	[Required] The source of the identity in an incoming request.
String	identityValidationExpression()	A validation expression for the incoming identity.
String	name()	[Required] The name of the authorizer.
List<String>	providerARNs()	A list of the Cognito Your User Pool authorizer's provider ARNs.
String	restApiId()	The RestApi identifier under which the Authorizer will be created.
static Class<? extends CreateAuthorizerRequest.Builder>	serializableBuilderClass()
CreateAuthorizerRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	[Required] The type of the authorizer.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

The RestApi identifier under which the Authorizer will be created.

Returns:

The RestApi identifier under which the Authorizer will be created.

name

public String name()

[Required] The name of the authorizer.

Returns:

[Required] The name of the authorizer.

type

public String type()

[Required] The type of the authorizer.

Returns:

[Required] The type of the authorizer.

See Also:

AuthorizerType

providerARNs

public List<String> providerARNs()

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

Returns:

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

authType

public String authType()

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

Returns:

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

authorizerUri

public String authorizerUri()

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

Returns:

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

authorizerCredentials

public String authorizerCredentials()

Specifies the credentials required for the authorizer, if any.

Returns:

Specifies the credentials required for the authorizer, if any.

identitySource

public String identitySource()

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

Returns:

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

identityValidationExpression

public String identityValidationExpression()

A validation expression for the incoming identity.

Returns:

A validation expression for the incoming identity.

authorizerResultTtlInSeconds

public Integer authorizerResultTtlInSeconds()

The TTL of cached authorizer results.

Returns:

The TTL of cached authorizer results.

toBuilder

public CreateAuthorizerRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>

Returns:

a builder for type T

builder

public static CreateAuthorizerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAuthorizerRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object