software.amazon.awssdk.services.iot.model

Class AuthorizerDescription

java.lang.Object

software.amazon.awssdk.services.iot.model.AuthorizerDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AuthorizerDescription.Builder,AuthorizerDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class AuthorizerDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AuthorizerDescription.Builder,AuthorizerDescription>

The authorizer description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthorizerDescription.Builder

Method Summary

Modifier and Type	Method and Description
String	authorizerArn() The authorizer ARN.
String	authorizerFunctionArn() The authorizer's Lambda function ARN.
String	authorizerName() The authorizer name.
static AuthorizerDescription.Builder	builder()
Instant	creationDate() The UNIX timestamp of when the authorizer was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTokenSigningPublicKeys() Returns true if the TokenSigningPublicKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Instant	lastModifiedDate() The UNIX timestamp of when the authorizer was last updated.
List<SdkField<?>>	sdkFields()
static Class<? extends AuthorizerDescription.Builder>	serializableBuilderClass()
Boolean	signingDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
AuthorizerStatus	status() The status of the authorizer.
String	statusAsString() The status of the authorizer.
AuthorizerDescription.Builder	toBuilder()
String	tokenKeyName() The key used to extract the token from the HTTP headers.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authorizerName

public String authorizerName()

The authorizer name.

Returns:

The authorizer name.

authorizerArn

public String authorizerArn()

The authorizer ARN.

Returns:

The authorizer ARN.

authorizerFunctionArn

public String authorizerFunctionArn()

The authorizer's Lambda function ARN.

Returns:

The authorizer's Lambda function ARN.

tokenKeyName

public String tokenKeyName()

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

Returns:

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

hasTokenSigningPublicKeys

public boolean hasTokenSigningPublicKeys()

Returns true if the TokenSigningPublicKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tokenSigningPublicKeys

public Map<String,String> tokenSigningPublicKeys()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTokenSigningPublicKeys() to see if a value was sent in this field.

Returns:

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

status

public AuthorizerStatus status()

The status of the authorizer.

If the service returns an enum value that is not available in the current SDK version, status will return AuthorizerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the authorizer.

See Also:

AuthorizerStatus

statusAsString

public String statusAsString()

The status of the authorizer.

If the service returns an enum value that is not available in the current SDK version, status will return AuthorizerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the authorizer.

See Also:

AuthorizerStatus

creationDate

public Instant creationDate()

The UNIX timestamp of when the authorizer was created.

Returns:

The UNIX timestamp of when the authorizer was created.

lastModifiedDate

public Instant lastModifiedDate()

The UNIX timestamp of when the authorizer was last updated.

Returns:

The UNIX timestamp of when the authorizer was last updated.

signingDisabled

public Boolean signingDisabled()

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.

toBuilder

public AuthorizerDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthorizerDescription.Builder,AuthorizerDescription>

builder

public static AuthorizerDescription.Builder builder()

serializableBuilderClass

public static Class<? extends AuthorizerDescription.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo