Class CreateAuthorizerRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAuthorizerRequest.Builder,
CreateAuthorizerRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of the authorizer's Lambda function.final String
The authorizer name.builder()
final Boolean
Whentrue
, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the TokenSigningPublicKeys property.static Class
<? extends CreateAuthorizerRequest.Builder> final Boolean
Specifies whether IoT validates the token signature in an authorization request.final AuthorizerStatus
status()
The status of the create authorizer request.final String
The status of the create authorizer request.tags()
Metadata which can be used to manage the custom authorizer.Take this object and create a builder that contains all of the current property values of this object.final String
The name of the token key used to extract the token from the HTTP headers.The public keys used to verify the digital signature returned by your custom authentication service.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
authorizerName
The authorizer name.
- Returns:
- The authorizer name.
-
authorizerFunctionArn
The ARN of the authorizer's Lambda function.
- Returns:
- The ARN of the authorizer's Lambda function.
-
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 theisEmpty()
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
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
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 returnAuthorizerStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the create authorizer request.
- See Also:
-
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 returnAuthorizerStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the create authorizer request.
- See Also:
-
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 theisEmpty()
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
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
Specifies whether IoT validates the token signature in an authorization request.
- Returns:
- Specifies whether IoT validates the token signature in an authorization request.
-
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 inrefreshAfterInSeconds
. 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 inrefreshAfterInSeconds
. This value does not affect authorization of clients that use MQTT connections.The default value is
false
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAuthorizerRequest.Builder,
CreateAuthorizerRequest> - Specified by:
toBuilder
in classIotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-