software.amazon.awssdk.services.iot.model

Class CreateAuthorizerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.CreateAuthorizerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAuthorizerRequest
extends IotRequest
implements ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAuthorizerRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authorizerFunctionArn() The ARN of the authorizer's Lambda function.
String	authorizerName() The authorizer name.
static CreateAuthorizerRequest.Builder	builder()
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).
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAuthorizerRequest.Builder>	serializableBuilderClass()
Boolean	signingDisabled() Specifies whether AWS IoT validates the token signature in an authorization request.
AuthorizerStatus	status() The status of the create authorizer request.
String	statusAsString() The status of the create authorizer request.
CreateAuthorizerRequest.Builder	toBuilder()
String	tokenKeyName() The name of the token key used to extract the token from the HTTP headers.
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

authorizerFunctionArn

public String authorizerFunctionArn()

The ARN of the authorizer's Lambda function.

Returns:

The ARN of the authorizer's Lambda function.

tokenKeyName

public String tokenKeyName()

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.

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

status

public AuthorizerStatus status()

The status of the create authorizer request.

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

See Also:

AuthorizerStatus

statusAsString

public String statusAsString()

The status of the create authorizer request.

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

See Also:

AuthorizerStatus

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 CreateAuthorizerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreateAuthorizerRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo