Interface UpdateKeyRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateKeyRequest.Builder,
,UpdateKeyRequest> LocationRequest.Builder
,SdkBuilder<UpdateKeyRequest.Builder,
,UpdateKeyRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateKeyRequest
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) Updates the description for the API key resource.expireTime
(Instant expireTime) Updates the timestamp for when the API key resource will expire in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.forceUpdate
(Boolean forceUpdate) The boolean flag to be included for updatingExpireTime
orRestrictions
details.The name of the API key resource to update.Whether the API key should expire.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default UpdateKeyRequest.Builder
restrictions
(Consumer<ApiKeyRestrictions.Builder> restrictions) Updates the API key restrictions for the API key resource.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 Details
-
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
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.
-
forceUpdate
The boolean flag to be included for updating
ExpireTime
orRestrictions
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 preferredDefault value:
False
- Parameters:
forceUpdate
- The boolean flag to be included for updatingExpireTime
orRestrictions
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 preferredDefault value:
False
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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 totrue
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.
-
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
Updates the API key restrictions for the API key resource.
This is a convenience method that creates an instance of theApiKeyRestrictions.Builder
avoiding the need to create one manually viaApiKeyRestrictions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torestrictions(ApiKeyRestrictions)
.- Parameters:
restrictions
- a consumer that will call methods onApiKeyRestrictions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-