com.amazonaws.services.iot.model

Class AuthorizerDescription

java.lang.Object

com.amazonaws.services.iot.model.AuthorizerDescription

All Implemented Interfaces:

java.io.Serializable

public class AuthorizerDescription
extends java.lang.Object
implements java.io.Serializable

The authorizer description.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthorizerDescription()

Method Summary

Modifier and Type	Method and Description
AuthorizerDescription	addtokenSigningPublicKeysEntry(java.lang.String key, java.lang.String value) The public keys used to validate the token signature returned by your custom authentication service.
AuthorizerDescription	cleartokenSigningPublicKeysEntries() Removes all the entries added into tokenSigningPublicKeys.
boolean	equals(java.lang.Object obj)
java.lang.String	getAuthorizerArn() The authorizer ARN.
java.lang.String	getAuthorizerFunctionArn() The authorizer's Lambda function ARN.
java.lang.String	getAuthorizerName() The authorizer name.
java.util.Date	getCreationDate() The UNIX timestamp of when the authorizer was created.
java.util.Date	getLastModifiedDate() The UNIX timestamp of when the authorizer was last updated.
java.lang.Boolean	getSigningDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
java.lang.String	getStatus() The status of the authorizer.
java.lang.String	getTokenKeyName() The key used to extract the token from the HTTP headers.
java.util.Map<java.lang.String,java.lang.String>	getTokenSigningPublicKeys() The public keys used to validate the token signature returned by your custom authentication service.
int	hashCode()
java.lang.Boolean	isSigningDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
void	setAuthorizerArn(java.lang.String authorizerArn) The authorizer ARN.
void	setAuthorizerFunctionArn(java.lang.String authorizerFunctionArn) The authorizer's Lambda function ARN.
void	setAuthorizerName(java.lang.String authorizerName) The authorizer name.
void	setCreationDate(java.util.Date creationDate) The UNIX timestamp of when the authorizer was created.
void	setLastModifiedDate(java.util.Date lastModifiedDate) The UNIX timestamp of when the authorizer was last updated.
void	setSigningDisabled(java.lang.Boolean signingDisabled) Specifies whether AWS IoT validates the token signature in an authorization request.
void	setStatus(AuthorizerStatus status) The status of the authorizer.
void	setStatus(java.lang.String status) The status of the authorizer.
void	setTokenKeyName(java.lang.String tokenKeyName) The key used to extract the token from the HTTP headers.
void	setTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.String> tokenSigningPublicKeys) The public keys used to validate the token signature returned by your custom authentication service.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AuthorizerDescription	withAuthorizerArn(java.lang.String authorizerArn) The authorizer ARN.
AuthorizerDescription	withAuthorizerFunctionArn(java.lang.String authorizerFunctionArn) The authorizer's Lambda function ARN.
AuthorizerDescription	withAuthorizerName(java.lang.String authorizerName) The authorizer name.
AuthorizerDescription	withCreationDate(java.util.Date creationDate) The UNIX timestamp of when the authorizer was created.
AuthorizerDescription	withLastModifiedDate(java.util.Date lastModifiedDate) The UNIX timestamp of when the authorizer was last updated.
AuthorizerDescription	withSigningDisabled(java.lang.Boolean signingDisabled) Specifies whether AWS IoT validates the token signature in an authorization request.
AuthorizerDescription	withStatus(AuthorizerStatus status) The status of the authorizer.
AuthorizerDescription	withStatus(java.lang.String status) The status of the authorizer.
AuthorizerDescription	withTokenKeyName(java.lang.String tokenKeyName) The key used to extract the token from the HTTP headers.
AuthorizerDescription	withTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.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

getAuthorizerName

public java.lang.String getAuthorizerName()

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Returns:

The authorizer name.

setAuthorizerName

public void setAuthorizerName(java.lang.String authorizerName)

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Parameters:

authorizerName -

The authorizer name.

withAuthorizerName

public AuthorizerDescription withAuthorizerName(java.lang.String authorizerName)

The authorizer name.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Parameters:

authorizerName -

The authorizer name.

Returns:

A reference to this updated object so that method calls can be chained together.

getAuthorizerArn

public java.lang.String getAuthorizerArn()

The authorizer ARN.

Constraints:
Length: - 2048

Returns:

The authorizer ARN.

setAuthorizerArn

public void setAuthorizerArn(java.lang.String authorizerArn)

The authorizer ARN.

Constraints:
Length: - 2048

Parameters:

authorizerArn -

The authorizer ARN.

withAuthorizerArn

public AuthorizerDescription withAuthorizerArn(java.lang.String authorizerArn)

The authorizer ARN.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 2048

Parameters:

authorizerArn -

The authorizer ARN.

Returns:

A reference to this updated object so that method calls can be chained together.

getAuthorizerFunctionArn

public java.lang.String getAuthorizerFunctionArn()

The authorizer's Lambda function ARN.

Constraints:
Length: - 2048

Returns:

The authorizer's Lambda function ARN.

setAuthorizerFunctionArn

public void setAuthorizerFunctionArn(java.lang.String authorizerFunctionArn)

The authorizer's Lambda function ARN.

Constraints:
Length: - 2048

Parameters:

authorizerFunctionArn -

The authorizer's Lambda function ARN.

withAuthorizerFunctionArn

public AuthorizerDescription withAuthorizerFunctionArn(java.lang.String authorizerFunctionArn)

The authorizer's Lambda function ARN.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 2048

Parameters:

authorizerFunctionArn -

The authorizer's Lambda function ARN.

Returns:

A reference to this updated object so that method calls can be chained together.

getTokenKeyName

public java.lang.String getTokenKeyName()

The key used to extract the token from the HTTP headers.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Returns:

The key used to extract the token from the HTTP headers.

setTokenKeyName

public void setTokenKeyName(java.lang.String tokenKeyName)

The key used to extract the token from the HTTP headers.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Parameters:

tokenKeyName -

The key used to extract the token from the HTTP headers.

withTokenKeyName

public AuthorizerDescription withTokenKeyName(java.lang.String tokenKeyName)

The key used to extract the token from the HTTP headers.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Parameters:

tokenKeyName -

The key used to extract the token from the HTTP headers.

Returns:

A reference to this updated object so that method calls can be chained together.

getTokenSigningPublicKeys

public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> tokenSigningPublicKeys)

The public keys used to validate the token signature returned by your custom authentication service.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tokenSigningPublicKeys -

The public keys used to validate the token signature returned by your custom authentication service.

Returns:

A reference to this updated object so that method calls can be chained together.

addtokenSigningPublicKeysEntry

public AuthorizerDescription addtokenSigningPublicKeysEntry(java.lang.String key,
                                                            java.lang.String value)

The public keys used to validate the token signature returned by your custom authentication service.

The method adds a new key-value pair into tokenSigningPublicKeys parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into tokenSigningPublicKeys.

value - The corresponding value of the entry to be added into tokenSigningPublicKeys.

Returns:

A reference to this updated object so that method calls can be chained together.

cleartokenSigningPublicKeysEntries

public AuthorizerDescription cleartokenSigningPublicKeysEntries()

Removes all the entries added into tokenSigningPublicKeys.

Returns a reference to this object so that method calls can be chained together.

getStatus

public java.lang.String getStatus()

The status of the authorizer.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Returns:

The status of the authorizer.

See Also:

AuthorizerStatus

setStatus

public void setStatus(java.lang.String status)

The status of the authorizer.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status -

The status of the authorizer.

See Also:

AuthorizerStatus

withStatus

public AuthorizerDescription withStatus(java.lang.String status)

The status of the authorizer.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status -

The status of the authorizer.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AuthorizerStatus

setStatus

public void setStatus(AuthorizerStatus status)

The status of the authorizer.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status -

The status of the authorizer.

See Also:

AuthorizerStatus

withStatus

public AuthorizerDescription withStatus(AuthorizerStatus status)

The status of the authorizer.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status -

The status of the authorizer.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AuthorizerStatus

getCreationDate

public java.util.Date getCreationDate()

The UNIX timestamp of when the authorizer was created.

Returns:

The UNIX timestamp of when the authorizer was created.

setCreationDate

public void setCreationDate(java.util.Date creationDate)

The UNIX timestamp of when the authorizer was created.

Parameters:

creationDate -

The UNIX timestamp of when the authorizer was created.

withCreationDate

public AuthorizerDescription withCreationDate(java.util.Date creationDate)

The UNIX timestamp of when the authorizer was created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

creationDate -

The UNIX timestamp of when the authorizer was created.

Returns:

A reference to this updated object so that method calls can be chained together.

getLastModifiedDate

public java.util.Date getLastModifiedDate()

The UNIX timestamp of when the authorizer was last updated.

Returns:

The UNIX timestamp of when the authorizer was last updated.

setLastModifiedDate

public void setLastModifiedDate(java.util.Date lastModifiedDate)

The UNIX timestamp of when the authorizer was last updated.

Parameters:

lastModifiedDate -

The UNIX timestamp of when the authorizer was last updated.

withLastModifiedDate

public AuthorizerDescription withLastModifiedDate(java.util.Date lastModifiedDate)

The UNIX timestamp of when the authorizer was last updated.

Returns a reference to this object so that method calls can be chained together.

Parameters:

lastModifiedDate -

The UNIX timestamp of when the authorizer was last updated.

Returns:

A reference to this updated object so that method calls can be chained together.

isSigningDisabled

public java.lang.Boolean isSigningDisabled()

Specifies whether AWS IoT validates the token signature in an authorization request.

Returns:

Specifies whether AWS IoT validates the token signature in an authorization request.

getSigningDisabled

public java.lang.Boolean getSigningDisabled()

Specifies whether AWS IoT validates the token signature in an authorization request.

Returns:

Specifies whether AWS IoT validates the token signature in an authorization request.

setSigningDisabled

public void setSigningDisabled(java.lang.Boolean signingDisabled)

Specifies whether AWS IoT validates the token signature in an authorization request.

Parameters:

signingDisabled -

Specifies whether AWS IoT validates the token signature in an authorization request.

withSigningDisabled

public AuthorizerDescription withSigningDisabled(java.lang.Boolean signingDisabled)

Specifies whether AWS IoT validates the token signature in an authorization request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

signingDisabled -

Specifies whether AWS IoT validates the token signature in an authorization request.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object