com.amazonaws.services.iot.model

Class CreateAuthorizerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateAuthorizerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAuthorizerRequest()

Method Summary

Modifier and Type	Method and Description
CreateAuthorizerRequest	addTokenSigningPublicKeysEntry(String key, String value) Add a single TokenSigningPublicKeys entry
CreateAuthorizerRequest	clearTokenSigningPublicKeysEntries() Removes all the entries added into TokenSigningPublicKeys.
CreateAuthorizerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAuthorizerFunctionArn() The ARN of the authorizer's Lambda function.
String	getAuthorizerName() The authorizer name.
Boolean	getEnableCachingForHttp() When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections.
Boolean	getSigningDisabled() Specifies whether IoT validates the token signature in an authorization request.
String	getStatus() The status of the create authorizer request.
List<Tag>	getTags() Metadata which can be used to manage the custom authorizer.
String	getTokenKeyName() The name of the token key used to extract the token from the HTTP headers.
Map<String,String>	getTokenSigningPublicKeys() The public keys used to verify the digital signature returned by your custom authentication service.
int	hashCode()
Boolean	isEnableCachingForHttp() When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections.
Boolean	isSigningDisabled() Specifies whether IoT validates the token signature in an authorization request.
void	setAuthorizerFunctionArn(String authorizerFunctionArn) The ARN of the authorizer's Lambda function.
void	setAuthorizerName(String authorizerName) The authorizer name.
void	setEnableCachingForHttp(Boolean enableCachingForHttp) When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections.
void	setSigningDisabled(Boolean signingDisabled) Specifies whether IoT validates the token signature in an authorization request.
void	setStatus(String status) The status of the create authorizer request.
void	setTags(Collection<Tag> tags) Metadata which can be used to manage the custom authorizer.
void	setTokenKeyName(String tokenKeyName) The name of the token key used to extract the token from the HTTP headers.
void	setTokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys) The public keys used to verify the digital signature returned by your custom authentication service.
String	toString() Returns a string representation of this object.
CreateAuthorizerRequest	withAuthorizerFunctionArn(String authorizerFunctionArn) The ARN of the authorizer's Lambda function.
CreateAuthorizerRequest	withAuthorizerName(String authorizerName) The authorizer name.
CreateAuthorizerRequest	withEnableCachingForHttp(Boolean enableCachingForHttp) When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections.
CreateAuthorizerRequest	withSigningDisabled(Boolean signingDisabled) Specifies whether IoT validates the token signature in an authorization request.
CreateAuthorizerRequest	withStatus(AuthorizerStatus status) The status of the create authorizer request.
CreateAuthorizerRequest	withStatus(String status) The status of the create authorizer request.
CreateAuthorizerRequest	withTags(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(String tokenKeyName) The name of the token key used to extract the token from the HTTP headers.
CreateAuthorizerRequest	withTokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys) The public keys used to verify the digital signature returned by your custom authentication service.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAuthorizerRequest

public CreateAuthorizerRequest()

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

setAuthorizerFunctionArn

public void setAuthorizerFunctionArn(String authorizerFunctionArn)

The ARN of the authorizer's Lambda function.

Parameters:

authorizerFunctionArn - The ARN of the authorizer's Lambda function.

getAuthorizerFunctionArn

public String getAuthorizerFunctionArn()

The ARN of the authorizer's Lambda function.

Returns:

The ARN of the authorizer's Lambda function.

withAuthorizerFunctionArn

public CreateAuthorizerRequest withAuthorizerFunctionArn(String authorizerFunctionArn)

The ARN of the authorizer's Lambda function.

Parameters:

authorizerFunctionArn - The ARN of the authorizer's Lambda function.

Returns:

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

setTokenKeyName

public void setTokenKeyName(String tokenKeyName)

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

Parameters:

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

getTokenKeyName

public String getTokenKeyName()

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

Returns:

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

withTokenKeyName

public CreateAuthorizerRequest withTokenKeyName(String tokenKeyName)

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

Parameters:

tokenKeyName - The name of the token 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 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(Map<String,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(Map<String,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.

Returns:

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

addTokenSigningPublicKeysEntry

public CreateAuthorizerRequest addTokenSigningPublicKeysEntry(String key,
                                                              String value)

Add a single TokenSigningPublicKeys entry

See Also:

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

clearTokenSigningPublicKeysEntries

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

Parameters:

status - The status of the create authorizer request.

See Also:

AuthorizerStatus

getStatus

public String getStatus()

The status of the create authorizer request.

Returns:

The status of the create authorizer request.

See Also:

AuthorizerStatus

withStatus

public CreateAuthorizerRequest withStatus(String status)

The status of the create authorizer request.

Parameters:

status - The status of the create authorizer request.

Returns:

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

See Also:

AuthorizerStatus

withStatus

public CreateAuthorizerRequest withStatus(AuthorizerStatus status)

The status of the create authorizer request.

Parameters:

status - The status of the create authorizer request.

Returns:

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

See Also:

AuthorizerStatus

getTags

public 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(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..."

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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:

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

withTags

public CreateAuthorizerRequest withTags(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..."

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

setEnableCachingForHttp

public void setEnableCachingForHttp(Boolean enableCachingForHttp)

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

Parameters:

enableCachingForHttp - When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

getEnableCachingForHttp

public Boolean getEnableCachingForHttp()

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

Returns:

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

withEnableCachingForHttp

public CreateAuthorizerRequest withEnableCachingForHttp(Boolean enableCachingForHttp)

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

Parameters:

enableCachingForHttp - When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

Returns:

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

isEnableCachingForHttp

public Boolean isEnableCachingForHttp()

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

Returns:

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

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 CreateAuthorizerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()