software.amazon.awssdk.services.iot.model

Interface CreateAuthorizerRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>, IotRequest.Builder, SdkBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAuthorizerRequest

public static interface CreateAuthorizerRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>

Method Summary

Modifier and Type	Method and Description
CreateAuthorizerRequest.Builder	authorizerFunctionArn(String authorizerFunctionArn) The ARN of the authorizer's Lambda function.
CreateAuthorizerRequest.Builder	authorizerName(String authorizerName) The authorizer name.
CreateAuthorizerRequest.Builder	enableCachingForHttp(Boolean enableCachingForHttp) When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections.
CreateAuthorizerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateAuthorizerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateAuthorizerRequest.Builder	signingDisabled(Boolean signingDisabled) Specifies whether IoT validates the token signature in an authorization request.
CreateAuthorizerRequest.Builder	status(AuthorizerStatus status) The status of the create authorizer request.
CreateAuthorizerRequest.Builder	status(String status) The status of the create authorizer request.
CreateAuthorizerRequest.Builder	tags(Collection<Tag> tags) Metadata which can be used to manage the custom authorizer.
CreateAuthorizerRequest.Builder	tags(Consumer<Tag.Builder>... tags) Metadata which can be used to manage the custom authorizer.
CreateAuthorizerRequest.Builder	tags(Tag... tags) Metadata which can be used to manage the custom authorizer.
CreateAuthorizerRequest.Builder	tokenKeyName(String tokenKeyName) The name of the token key used to extract the token from the HTTP headers.
CreateAuthorizerRequest.Builder	tokenSigningPublicKeys(Map<String,String> tokenSigningPublicKeys) The public keys used to verify the digital signature returned by your custom authentication service.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

authorizerName

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

authorizerFunctionArn

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

tokenKeyName

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

tokenSigningPublicKeys

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

status

CreateAuthorizerRequest.Builder status(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, AuthorizerStatus

status

CreateAuthorizerRequest.Builder status(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, AuthorizerStatus

tags

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

tags

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

tags

CreateAuthorizerRequest.Builder tags(Consumer<Tag.Builder>... 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..."

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

signingDisabled

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

enableCachingForHttp

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

overrideConfiguration

CreateAuthorizerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateAuthorizerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder