com.amazonaws.services.iot.model

Class CreateAuthorizerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateAuthorizerRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateAuthorizerRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates an authorizer.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateAuthorizerRequest()

Method Summary

Modifier and Type	Method and Description
CreateAuthorizerRequest	addtokenSigningPublicKeysEntry(java.lang.String key, java.lang.String value) The public keys used to verify the digital signature returned by your custom authentication service.
CreateAuthorizerRequest	cleartokenSigningPublicKeysEntries() Removes all the entries added into tokenSigningPublicKeys.
boolean	equals(java.lang.Object obj)
java.lang.String	getAuthorizerFunctionArn() The ARN of the authorizer's Lambda function.
java.lang.String	getAuthorizerName() The authorizer name.
java.lang.Boolean	getSigningDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
java.lang.String	getStatus() The status of the create authorizer request.
java.util.List<Tag>	getTags() Metadata which can be used to manage the custom authorizer.
java.lang.String	getTokenKeyName() The name of the token 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 verify the digital 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	setAuthorizerFunctionArn(java.lang.String authorizerFunctionArn) The ARN of the authorizer's Lambda function.
void	setAuthorizerName(java.lang.String authorizerName) The authorizer name.
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 create authorizer request.
void	setStatus(java.lang.String status) The status of the create authorizer request.
void	setTags(java.util.Collection<Tag> tags) Metadata which can be used to manage the custom authorizer.
void	setTokenKeyName(java.lang.String tokenKeyName) The name of the token 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 verify the digital signature returned by your custom authentication service.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateAuthorizerRequest	withAuthorizerFunctionArn(java.lang.String authorizerFunctionArn) The ARN of the authorizer's Lambda function.
CreateAuthorizerRequest	withAuthorizerName(java.lang.String authorizerName) The authorizer name.
CreateAuthorizerRequest	withSigningDisabled(java.lang.Boolean signingDisabled) Specifies whether AWS IoT validates the token signature in an authorization request.
CreateAuthorizerRequest	withStatus(AuthorizerStatus status) The status of the create authorizer request.
CreateAuthorizerRequest	withStatus(java.lang.String status) The status of the create authorizer request.
CreateAuthorizerRequest	withTags(java.util.Collection<Tag> tags) Metadata which can be used to manage the custom authorizer.
CreateAuthorizerRequest	withTags(Tag... tags) Metadata which can be used to manage the custom authorizer.
CreateAuthorizerRequest	withTokenKeyName(java.lang.String tokenKeyName) The name of the token key used to extract the token from the HTTP headers.
CreateAuthorizerRequest	withTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.String> tokenSigningPublicKeys) The public keys used to verify the digital signature returned by your custom authentication service.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAuthorizerRequest

public CreateAuthorizerRequest()

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 CreateAuthorizerRequest 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.

getAuthorizerFunctionArn

public java.lang.String getAuthorizerFunctionArn()

The ARN of the authorizer's Lambda function.

Constraints:
Length: - 2048

Returns:

The ARN of the authorizer's Lambda function.

setAuthorizerFunctionArn

public void setAuthorizerFunctionArn(java.lang.String authorizerFunctionArn)

The ARN of the authorizer's Lambda function.

Constraints:
Length: - 2048

Parameters:

authorizerFunctionArn -

The ARN of the authorizer's Lambda function.

withAuthorizerFunctionArn

public CreateAuthorizerRequest withAuthorizerFunctionArn(java.lang.String authorizerFunctionArn)

The ARN of the authorizer's Lambda function.

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

Constraints:
Length: - 2048

Parameters:

authorizerFunctionArn -

The ARN of the authorizer's Lambda function.

Returns:

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

getTokenKeyName

public java.lang.String getTokenKeyName()

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

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

Returns:

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

setTokenKeyName

public void setTokenKeyName(java.lang.String tokenKeyName)

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

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

Parameters:

tokenKeyName -

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

withTokenKeyName

public CreateAuthorizerRequest withTokenKeyName(java.lang.String tokenKeyName)

The name of the token 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 name of the token 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 verify the digital signature returned by your custom authentication service.

Returns:

The public keys used to verify the digital 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 verify the digital signature returned by your custom authentication service.

Parameters:

tokenSigningPublicKeys -

The public keys used to verify the digital signature returned by your custom authentication service.

withTokenSigningPublicKeys

public CreateAuthorizerRequest withTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.String> tokenSigningPublicKeys)

The public keys used to verify the digital 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 verify the digital signature returned by your custom authentication service.

Returns:

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

addtokenSigningPublicKeysEntry

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

The public keys used to verify the digital 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 CreateAuthorizerRequest 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 create authorizer request.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Returns:

The status of the create authorizer request.

See Also:

AuthorizerStatus

setStatus

public void setStatus(java.lang.String status)

The status of the create authorizer request.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status -

The status of the create authorizer request.

See Also:

AuthorizerStatus

withStatus

public CreateAuthorizerRequest withStatus(java.lang.String status)

The status of the create authorizer request.

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 create authorizer request.

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 create authorizer request.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

status -

The status of the create authorizer request.

See Also:

AuthorizerStatus

withStatus

public CreateAuthorizerRequest withStatus(AuthorizerStatus status)

The status of the create authorizer request.

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 create authorizer request.

Returns:

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

See Also:

AuthorizerStatus

getTags

public java.util.List<Tag> getTags()

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

setTags

public void setTags(java.util.Collection<Tag> tags)

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Parameters:

tags -

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

withTags

public CreateAuthorizerRequest withTags(Tag... tags)

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

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

Parameters:

tags -

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

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

withTags

public CreateAuthorizerRequest withTags(java.util.Collection<Tag> tags)

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

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

Parameters:

tags -

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

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 CreateAuthorizerRequest 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