CreateAuthorizerRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateAuthorizerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`enableCachingForHttp()` When `true`, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasTokenSigningPublicKeys()` For responses, this returns true if the service returned a value for the TokenSigningPublicKeys property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAuthorizerRequest.Builder>`	`serializableBuilderClass()`
`Boolean`	`signingDisabled()` Specifies whether 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.
`List<Tag>`	`tags()` Metadata which can be used to manage the custom authorizer.
`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 final String authorizerName()
```
    The authorizer name.
    
    Returns:
    
    The authorizer name.
  - authorizerFunctionArn
```
public final String authorizerFunctionArn()
```
    The ARN of the authorizer's Lambda function.
    
    Returns:
    
    The ARN of the authorizer's Lambda function.
  - tokenKeyName
```
public final 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 final boolean hasTokenSigningPublicKeys()
```
    For responses, this returns true if the service returned a value for the TokenSigningPublicKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tokenSigningPublicKeys
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTokenSigningPublicKeys() method.
    
    Returns:
    
    The public keys used to verify the digital signature returned by your custom authentication service.
  - status
```
public final 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 final 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
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<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..."
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    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..."
  - signingDisabled
```
public final Boolean signingDisabled()
```
    Specifies whether IoT validates the token signature in an authorization request.
    
    Returns:
    
    Specifies whether IoT validates the token signature in an authorization request.
  - enableCachingForHttp
```
public final 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.
    
    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.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateAuthorizerRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

authorizerName

authorizerFunctionArn

tokenKeyName

hasTokenSigningPublicKeys

tokenSigningPublicKeys

status

statusAsString

hasTags

tags

signingDisabled

enableCachingForHttp

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields