AuthorizerDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.AuthorizerDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthorizerDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

The authorizer description.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

AuthorizerDescription()

Constructors
Constructor and Description
`AuthorizerDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthorizerDescription`	`addTokenSigningPublicKeysEntry(String key, String value)` Add a single TokenSigningPublicKeys entry
`AuthorizerDescription`	`clearTokenSigningPublicKeysEntries()` Removes all the entries added into TokenSigningPublicKeys.
`AuthorizerDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAuthorizerArn()` The authorizer ARN.
`String`	`getAuthorizerFunctionArn()` The authorizer's Lambda function ARN.
`String`	`getAuthorizerName()` The authorizer name.
`Date`	`getCreationDate()` The UNIX timestamp of when the authorizer was created.
`Date`	`getLastModifiedDate()` The UNIX timestamp of when the authorizer was last updated.
`Boolean`	`getSigningDisabled()` Specifies whether IoT validates the token signature in an authorization request.
`String`	`getStatus()` The status of the authorizer.
`String`	`getTokenKeyName()` The key used to extract the token from the HTTP headers.
`Map<String,String>`	`getTokenSigningPublicKeys()` The public keys used to validate the token signature returned by your custom authentication service.
`int`	`hashCode()`
`Boolean`	`isSigningDisabled()` Specifies whether IoT validates the token signature in an authorization request.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthorizerArn(String authorizerArn)` The authorizer ARN.
`void`	`setAuthorizerFunctionArn(String authorizerFunctionArn)` The authorizer's Lambda function ARN.
`void`	`setAuthorizerName(String authorizerName)` The authorizer name.
`void`	`setCreationDate(Date creationDate)` The UNIX timestamp of when the authorizer was created.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The UNIX timestamp of when the authorizer was last updated.
`void`	`setSigningDisabled(Boolean signingDisabled)` Specifies whether IoT validates the token signature in an authorization request.
`void`	`setStatus(String status)` The status of the authorizer.
`void`	`setTokenKeyName(String tokenKeyName)` The key used to extract the token from the HTTP headers.
`void`	`setTokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys)` The public keys used to validate the token signature returned by your custom authentication service.
`String`	`toString()` Returns a string representation of this object.
`AuthorizerDescription`	`withAuthorizerArn(String authorizerArn)` The authorizer ARN.
`AuthorizerDescription`	`withAuthorizerFunctionArn(String authorizerFunctionArn)` The authorizer's Lambda function ARN.
`AuthorizerDescription`	`withAuthorizerName(String authorizerName)` The authorizer name.
`AuthorizerDescription`	`withCreationDate(Date creationDate)` The UNIX timestamp of when the authorizer was created.
`AuthorizerDescription`	`withLastModifiedDate(Date lastModifiedDate)` The UNIX timestamp of when the authorizer was last updated.
`AuthorizerDescription`	`withSigningDisabled(Boolean signingDisabled)` Specifies whether IoT validates the token signature in an authorization request.
`AuthorizerDescription`	`withStatus(AuthorizerStatus status)` The status of the authorizer.
`AuthorizerDescription`	`withStatus(String status)` The status of the authorizer.
`AuthorizerDescription`	`withTokenKeyName(String tokenKeyName)` The key used to extract the token from the HTTP headers.
`AuthorizerDescription`	`withTokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys)` The public keys used to validate the token signature returned by your custom authentication service.

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

- Constructor Detail
  - AuthorizerDescription
```
public AuthorizerDescription()
```
- Method Detail
  - setAuthorizerName
```
public void setAuthorizerName(String authorizerName)
```
    The authorizer name.
    
    Parameters:
    
    authorizerName - The authorizer name.
  - getAuthorizerName
```
public String getAuthorizerName()
```
    The authorizer name.
    
    Returns:
    
    The authorizer name.
  - withAuthorizerName
```
public AuthorizerDescription withAuthorizerName(String authorizerName)
```
    The authorizer name.
    
    Parameters:
    
    authorizerName - The authorizer name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizerArn
```
public void setAuthorizerArn(String authorizerArn)
```
    The authorizer ARN.
    
    Parameters:
    
    authorizerArn - The authorizer ARN.
  - getAuthorizerArn
```
public String getAuthorizerArn()
```
    The authorizer ARN.
    
    Returns:
    
    The authorizer ARN.
  - withAuthorizerArn
```
public AuthorizerDescription withAuthorizerArn(String authorizerArn)
```
    The authorizer ARN.
    
    Parameters:
    
    authorizerArn - The authorizer ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizerFunctionArn
```
public void setAuthorizerFunctionArn(String authorizerFunctionArn)
```
    The authorizer's Lambda function ARN.
    
    Parameters:
    
    authorizerFunctionArn - The authorizer's Lambda function ARN.
  - getAuthorizerFunctionArn
```
public String getAuthorizerFunctionArn()
```
    The authorizer's Lambda function ARN.
    
    Returns:
    
    The authorizer's Lambda function ARN.
  - withAuthorizerFunctionArn
```
public AuthorizerDescription withAuthorizerFunctionArn(String authorizerFunctionArn)
```
    The authorizer's Lambda function ARN.
    
    Parameters:
    
    authorizerFunctionArn - The authorizer's Lambda function ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTokenKeyName
```
public void setTokenKeyName(String tokenKeyName)
```
    The key used to extract the token from the HTTP headers.
    
    Parameters:
    
    tokenKeyName - The key used to extract the token from the HTTP headers.
  - getTokenKeyName
```
public String getTokenKeyName()
```
    The key used to extract the token from the HTTP headers.
    
    Returns:
    
    The key used to extract the token from the HTTP headers.
  - withTokenKeyName
```
public AuthorizerDescription withTokenKeyName(String tokenKeyName)
```
    The key used to extract the token from the HTTP headers.
    
    Parameters:
    
    tokenKeyName - The key used to extract the token from the HTTP headers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTokenSigningPublicKeys
```
public Map<String,String> getTokenSigningPublicKeys()
```
    The public keys used to validate the token signature returned by your custom authentication service.
    
    Returns:
    
    The public keys used to validate the token signature returned by your custom authentication service.
  - setTokenSigningPublicKeys
```
public void setTokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys)
```
    The public keys used to validate the token signature returned by your custom authentication service.
    
    Parameters:
    
    tokenSigningPublicKeys - The public keys used to validate the token signature returned by your custom authentication service.
  - withTokenSigningPublicKeys
```
public AuthorizerDescription withTokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys)
```
    The public keys used to validate the token signature returned by your custom authentication service.
    
    Parameters:
    
    tokenSigningPublicKeys - The public keys used to validate the token signature returned by your custom authentication service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTokenSigningPublicKeysEntry
```
public AuthorizerDescription addTokenSigningPublicKeysEntry(String key,
                                                            String value)
```
    Add a single TokenSigningPublicKeys entry
    
    See Also:
    
    withTokenSigningPublicKeys(java.util.Map<java.lang.String, java.lang.String>)
  - clearTokenSigningPublicKeysEntries
```
public AuthorizerDescription clearTokenSigningPublicKeysEntries()
```
    Removes all the entries added into TokenSigningPublicKeys.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the authorizer.
    
    Parameters:
    
    status - The status of the authorizer.
    
    See Also:
    
    AuthorizerStatus
  - getStatus
```
public String getStatus()
```
    The status of the authorizer.
    
    Returns:
    
    The status of the authorizer.
    
    See Also:
    
    AuthorizerStatus
  - withStatus
```
public AuthorizerDescription withStatus(String status)
```
    The status of the authorizer.
    
    Parameters:
    
    status - The status of the authorizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorizerStatus
  - withStatus
```
public AuthorizerDescription withStatus(AuthorizerStatus status)
```
    The status of the authorizer.
    
    Parameters:
    
    status - The status of the authorizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorizerStatus
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The UNIX timestamp of when the authorizer was created.
    
    Parameters:
    
    creationDate - The UNIX timestamp of when the authorizer was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The UNIX timestamp of when the authorizer was created.
    
    Returns:
    
    The UNIX timestamp of when the authorizer was created.
  - withCreationDate
```
public AuthorizerDescription withCreationDate(Date creationDate)
```
    The UNIX timestamp of when the authorizer was created.
    
    Parameters:
    
    creationDate - The UNIX timestamp of when the authorizer was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The UNIX timestamp of when the authorizer was last updated.
    
    Parameters:
    
    lastModifiedDate - The UNIX timestamp of when the authorizer was last updated.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The UNIX timestamp of when the authorizer was last updated.
    
    Returns:
    
    The UNIX timestamp of when the authorizer was last updated.
  - withLastModifiedDate
```
public AuthorizerDescription withLastModifiedDate(Date lastModifiedDate)
```
    The UNIX timestamp of when the authorizer was last updated.
    
    Parameters:
    
    lastModifiedDate - The UNIX timestamp of when the authorizer was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSigningDisabled
```
public void setSigningDisabled(Boolean signingDisabled)
```
    Specifies whether IoT validates the token signature in an authorization request.
    
    Parameters:
    
    signingDisabled - Specifies whether IoT validates the token signature in an authorization request.
  - getSigningDisabled
```
public Boolean getSigningDisabled()
```
    Specifies whether IoT validates the token signature in an authorization request.
    
    Returns:
    
    Specifies whether IoT validates the token signature in an authorization request.
  - withSigningDisabled
```
public AuthorizerDescription withSigningDisabled(Boolean signingDisabled)
```
    Specifies whether IoT validates the token signature in an authorization request.
    
    Parameters:
    
    signingDisabled - Specifies whether IoT validates the token signature in an authorization request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSigningDisabled
```
public Boolean isSigningDisabled()
```
    Specifies whether IoT validates the token signature in an authorization request.
    
    Returns:
    
    Specifies whether IoT validates the token signature in an authorization request.
  - 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
    
    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 AuthorizerDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AuthorizerDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthorizerDescription

Method Detail

setAuthorizerName

getAuthorizerName

withAuthorizerName

setAuthorizerArn

getAuthorizerArn

withAuthorizerArn

setAuthorizerFunctionArn

getAuthorizerFunctionArn

withAuthorizerFunctionArn

setTokenKeyName

getTokenKeyName

withTokenKeyName

getTokenSigningPublicKeys

setTokenSigningPublicKeys

withTokenSigningPublicKeys

addTokenSigningPublicKeysEntry

clearTokenSigningPublicKeysEntries

setStatus

getStatus

withStatus

withStatus

setCreationDate

getCreationDate

withCreationDate

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setSigningDisabled

getSigningDisabled

withSigningDisabled

isSigningDisabled

toString

equals

hashCode

clone

marshall