CreateAuthorizerRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigateway.model.CreateAuthorizerRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreateAuthorizerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Request to add a new Authorizer to an existing RestApi resource.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateAuthorizerRequest()

Constructors
Constructor and Description
`CreateAuthorizerRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAuthorizerRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getAuthorizerCredentials()` Specifies the credentials required for the authorizer, if any.
`Integer`	`getAuthorizerResultTtlInSeconds()` The TTL of cached authorizer results.
`String`	`getAuthorizerUri()` [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
`String`	`getAuthType()` Optional customer-defined field, used in Swagger imports/exports.
`String`	`getIdentitySource()` [Required] The source of the identity in an incoming request.
`String`	`getIdentityValidationExpression()` A validation expression for the incoming identity.
`String`	`getName()` [Required] The name of the authorizer.
`List<String>`	`getProviderARNs()` A list of the Cognito Your User Pool authorizer's provider ARNs.
`String`	`getRestApiId()` The RestApi identifier under which the Authorizer will be created.
`String`	`getType()` [Required] The type of the authorizer.
`int`	`hashCode()`
`void`	`setAuthorizerCredentials(String authorizerCredentials)` Specifies the credentials required for the authorizer, if any.
`void`	`setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)` The TTL of cached authorizer results.
`void`	`setAuthorizerUri(String authorizerUri)` [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
`void`	`setAuthType(String authType)` Optional customer-defined field, used in Swagger imports/exports.
`void`	`setIdentitySource(String identitySource)` [Required] The source of the identity in an incoming request.
`void`	`setIdentityValidationExpression(String identityValidationExpression)` A validation expression for the incoming identity.
`void`	`setName(String name)` [Required] The name of the authorizer.
`void`	`setProviderARNs(Collection<String> providerARNs)` A list of the Cognito Your User Pool authorizer's provider ARNs.
`void`	`setRestApiId(String restApiId)` The RestApi identifier under which the Authorizer will be created.
`void`	`setType(AuthorizerType type)` [Required] The type of the authorizer.
`void`	`setType(String type)` [Required] The type of the authorizer.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateAuthorizerRequest`	`withAuthorizerCredentials(String authorizerCredentials)` Specifies the credentials required for the authorizer, if any.
`CreateAuthorizerRequest`	`withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)` The TTL of cached authorizer results.
`CreateAuthorizerRequest`	`withAuthorizerUri(String authorizerUri)` [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
`CreateAuthorizerRequest`	`withAuthType(String authType)` Optional customer-defined field, used in Swagger imports/exports.
`CreateAuthorizerRequest`	`withIdentitySource(String identitySource)` [Required] The source of the identity in an incoming request.
`CreateAuthorizerRequest`	`withIdentityValidationExpression(String identityValidationExpression)` A validation expression for the incoming identity.
`CreateAuthorizerRequest`	`withName(String name)` [Required] The name of the authorizer.
`CreateAuthorizerRequest`	`withProviderARNs(Collection<String> providerARNs)` A list of the Cognito Your User Pool authorizer's provider ARNs.
`CreateAuthorizerRequest`	`withProviderARNs(String... providerARNs)` A list of the Cognito Your User Pool authorizer's provider ARNs.
`CreateAuthorizerRequest`	`withRestApiId(String restApiId)` The RestApi identifier under which the Authorizer will be created.
`CreateAuthorizerRequest`	`withType(AuthorizerType type)` [Required] The type of the authorizer.
`CreateAuthorizerRequest`	`withType(String type)` [Required] The type of the authorizer.

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

- Constructor Detail
  - CreateAuthorizerRequest
```
public CreateAuthorizerRequest()
```
- Method Detail
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    The RestApi identifier under which the Authorizer will be created.
    
    Parameters:
    
    restApiId - The RestApi identifier under which the Authorizer will be created.
  - getRestApiId
```
public String getRestApiId()
```
    The RestApi identifier under which the Authorizer will be created.
    
    Returns:
    
    The RestApi identifier under which the Authorizer will be created.
  - withRestApiId
```
public CreateAuthorizerRequest withRestApiId(String restApiId)
```
    The RestApi identifier under which the Authorizer will be created.
    
    Parameters:
    
    restApiId - The RestApi identifier under which the Authorizer will be created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    [Required] The name of the authorizer.
    
    Parameters:
    
    name - [Required] The name of the authorizer.
  - getName
```
public String getName()
```
    [Required] The name of the authorizer.
    
    Returns:
    
    [Required] The name of the authorizer.
  - withName
```
public CreateAuthorizerRequest withName(String name)
```
    [Required] The name of the authorizer.
    
    Parameters:
    
    name - [Required] The name of the authorizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    [Required] The type of the authorizer.
    
    Parameters:
    
    type - [Required] The type of the authorizer.
    
    See Also:
    
    AuthorizerType
  - getType
```
public String getType()
```
    [Required] The type of the authorizer.
    
    Returns:
    
    [Required] The type of the authorizer.
    
    See Also:
    
    AuthorizerType
  - withType
```
public CreateAuthorizerRequest withType(String type)
```
    [Required] The type of the authorizer.
    
    Parameters:
    
    type - [Required] The type of the authorizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorizerType
  - setType
```
public void setType(AuthorizerType type)
```
    [Required] The type of the authorizer.
    
    Parameters:
    
    type - [Required] The type of the authorizer.
    
    See Also:
    
    AuthorizerType
  - withType
```
public CreateAuthorizerRequest withType(AuthorizerType type)
```
    [Required] The type of the authorizer.
    
    Parameters:
    
    type - [Required] The type of the authorizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorizerType
  - getProviderARNs
```
public List<String> getProviderARNs()
```
    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.
  - setProviderARNs
```
public void setProviderARNs(Collection<String> providerARNs)
```
    A list of the Cognito Your User Pool authorizer's provider ARNs.
    
    Parameters:
    
    providerARNs - A list of the Cognito Your User Pool authorizer's provider ARNs.
  - withProviderARNs
```
public CreateAuthorizerRequest withProviderARNs(String... providerARNs)
```
    A list of the Cognito Your User Pool authorizer's provider ARNs.
    
    NOTE: This method appends the values to the existing list (if any). Use setProviderARNs(java.util.Collection) or withProviderARNs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    providerARNs - A list of the Cognito Your User Pool authorizer's provider ARNs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withProviderARNs
```
public CreateAuthorizerRequest withProviderARNs(Collection<String> providerARNs)
```
    A list of the Cognito Your User Pool authorizer's provider ARNs.
    
    Parameters:
    
    providerARNs - A list of the Cognito Your User Pool authorizer's provider ARNs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthType
```
public void setAuthType(String authType)
```
    Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    
    Parameters:
    
    authType - Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
  - getAuthType
```
public String getAuthType()
```
    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.
  - withAuthType
```
public CreateAuthorizerRequest withAuthType(String authType)
```
    Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    
    Parameters:
    
    authType - Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizerUri
```
public void setAuthorizerUri(String authorizerUri)
```
    [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
    
    Parameters:
    
    authorizerUri - [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
  - getAuthorizerUri
```
public String getAuthorizerUri()
```
    [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
    
    Returns:
    
    [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
  - withAuthorizerUri
```
public CreateAuthorizerRequest withAuthorizerUri(String authorizerUri)
```
    [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
    
    Parameters:
    
    authorizerUri - [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizerCredentials
```
public void setAuthorizerCredentials(String authorizerCredentials)
```
    Specifies the credentials required for the authorizer, if any.
    
    Parameters:
    
    authorizerCredentials - Specifies the credentials required for the authorizer, if any.
  - getAuthorizerCredentials
```
public String getAuthorizerCredentials()
```
    Specifies the credentials required for the authorizer, if any.
    
    Returns:
    
    Specifies the credentials required for the authorizer, if any.
  - withAuthorizerCredentials
```
public CreateAuthorizerRequest withAuthorizerCredentials(String authorizerCredentials)
```
    Specifies the credentials required for the authorizer, if any.
    
    Parameters:
    
    authorizerCredentials - Specifies the credentials required for the authorizer, if any.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentitySource
```
public void setIdentitySource(String identitySource)
```
    [Required] The source of the identity in an incoming request.
    
    Parameters:
    
    identitySource - [Required] The source of the identity in an incoming request.
  - getIdentitySource
```
public String getIdentitySource()
```
    [Required] The source of the identity in an incoming request.
    
    Returns:
    
    [Required] The source of the identity in an incoming request.
  - withIdentitySource
```
public CreateAuthorizerRequest withIdentitySource(String identitySource)
```
    [Required] The source of the identity in an incoming request.
    
    Parameters:
    
    identitySource - [Required] The source of the identity in an incoming request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityValidationExpression
```
public void setIdentityValidationExpression(String identityValidationExpression)
```
    A validation expression for the incoming identity.
    
    Parameters:
    
    identityValidationExpression - A validation expression for the incoming identity.
  - getIdentityValidationExpression
```
public String getIdentityValidationExpression()
```
    A validation expression for the incoming identity.
    
    Returns:
    
    A validation expression for the incoming identity.
  - withIdentityValidationExpression
```
public CreateAuthorizerRequest withIdentityValidationExpression(String identityValidationExpression)
```
    A validation expression for the incoming identity.
    
    Parameters:
    
    identityValidationExpression - A validation expression for the incoming identity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizerResultTtlInSeconds
```
public void setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
```
    The TTL of cached authorizer results.
    
    Parameters:
    
    authorizerResultTtlInSeconds - The TTL of cached authorizer results.
  - getAuthorizerResultTtlInSeconds
```
public Integer getAuthorizerResultTtlInSeconds()
```
    The TTL of cached authorizer results.
    
    Returns:
    
    The TTL of cached authorizer results.
  - withAuthorizerResultTtlInSeconds
```
public CreateAuthorizerRequest withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
```
    The TTL of cached authorizer results.
    
    Parameters:
    
    authorizerResultTtlInSeconds - The TTL of cached authorizer results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateAuthorizerRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateAuthorizerRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateAuthorizerRequest

Method Detail

setRestApiId

getRestApiId

withRestApiId

setName

getName

withName

setType

getType

withType

setType

withType

getProviderARNs

setProviderARNs

withProviderARNs

withProviderARNs

setAuthType

getAuthType

withAuthType

setAuthorizerUri

getAuthorizerUri

withAuthorizerUri

setAuthorizerCredentials

getAuthorizerCredentials

withAuthorizerCredentials

setIdentitySource

getIdentitySource

withIdentitySource

setIdentityValidationExpression

getIdentityValidationExpression

withIdentityValidationExpression

setAuthorizerResultTtlInSeconds

getAuthorizerResultTtlInSeconds

withAuthorizerResultTtlInSeconds

toString

equals

hashCode

clone