Package software.amazon.awssdk.services.location.model

Interface UpdateKeyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateKeyRequest.Builder,UpdateKeyRequest>, LocationRequest.Builder, SdkBuilder<UpdateKeyRequest.Builder,UpdateKeyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateKeyRequest

public static interface UpdateKeyRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<UpdateKeyRequest.Builder,UpdateKeyRequest>

Method Summary

Modifier and Type	Method	Description
UpdateKeyRequest.Builder	description(String description)	Updates the description for the API key resource.
UpdateKeyRequest.Builder	expireTime(Instant expireTime)	Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
UpdateKeyRequest.Builder	forceUpdate(Boolean forceUpdate)	The boolean flag to be included for updating ExpireTime or Restrictions details.
UpdateKeyRequest.Builder	keyName(String keyName)	The name of the API key resource to update.
UpdateKeyRequest.Builder	noExpiry(Boolean noExpiry)	Whether the API key should expire.
UpdateKeyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateKeyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default UpdateKeyRequest.Builder	restrictions(Consumer<ApiKeyRestrictions.Builder> restrictions)	Updates the API key restrictions for the API key resource.
UpdateKeyRequest.Builder	restrictions(ApiKeyRestrictions restrictions)	Updates the API key restrictions for the API key resource.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

keyName

UpdateKeyRequest.Builder keyName(String keyName)

The name of the API key resource to update.

Parameters:

keyName - The name of the API key resource to update.

Returns:

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

description

UpdateKeyRequest.Builder description(String description)

Updates the description for the API key resource.

Parameters:

description - Updates the description for the API key resource.

Returns:

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

expireTime

UpdateKeyRequest.Builder expireTime(Instant expireTime)

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Parameters:

expireTime - Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

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

noExpiry

UpdateKeyRequest.Builder noExpiry(Boolean noExpiry)

Whether the API key should expire. Set to true to set the API key to have no expiration time.

Parameters:

noExpiry - Whether the API key should expire. Set to true to set the API key to have no expiration time.

Returns:

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

forceUpdate

UpdateKeyRequest.Builder forceUpdate(Boolean forceUpdate)

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Parameters:

forceUpdate - The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Returns:

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

restrictions

UpdateKeyRequest.Builder restrictions(ApiKeyRestrictions restrictions)

Updates the API key restrictions for the API key resource.

Parameters:

restrictions - Updates the API key restrictions for the API key resource.

Returns:

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

restrictions

default UpdateKeyRequest.Builder restrictions(Consumer<ApiKeyRestrictions.Builder> restrictions)

Updates the API key restrictions for the API key resource.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to restrictions(ApiKeyRestrictions).

Parameters:

restrictions - a consumer that will call methods on ApiKeyRestrictions.Builder

Returns:

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

See Also:

restrictions(ApiKeyRestrictions)

overrideConfiguration

UpdateKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder