Class: Aws::LocationService::Types::UpdateKeyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::LocationService::Types::UpdateKeyRequest
- Defined in:
- gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#description ⇒ String
Updates the description for the API key resource.
-
#expire_time ⇒ Time
Updates the timestamp for when the API key resource will expire in [ ISO 8601][1] format:
YYYY-MM-DDThh:mm:ss.sssZ
. -
#force_update ⇒ Boolean
The boolean flag to be included for updating
ExpireTime
orRestrictions
details. -
#key_name ⇒ String
The name of the API key resource to update.
-
#no_expiry ⇒ Boolean
Whether the API key should expire.
-
#restrictions ⇒ Types::ApiKeyRestrictions
Updates the API key restrictions for the API key resource.
Instance Attribute Details
#description ⇒ String
Updates the description for the API key resource.
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6354 class UpdateKeyRequest < Struct.new( :description, :expire_time, :force_update, :key_name, :no_expiry, :restrictions) SENSITIVE = [] include Aws::Structure end |
#expire_time ⇒ Time
Updates the timestamp for when the API key resource will expire in
ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6354 class UpdateKeyRequest < Struct.new( :description, :expire_time, :force_update, :key_name, :no_expiry, :restrictions) SENSITIVE = [] include Aws::Structure end |
#force_update ⇒ Boolean
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
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6354 class UpdateKeyRequest < Struct.new( :description, :expire_time, :force_update, :key_name, :no_expiry, :restrictions) SENSITIVE = [] include Aws::Structure end |
#key_name ⇒ String
The name of the API key resource to update.
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6354 class UpdateKeyRequest < Struct.new( :description, :expire_time, :force_update, :key_name, :no_expiry, :restrictions) SENSITIVE = [] include Aws::Structure end |
#no_expiry ⇒ Boolean
Whether the API key should expire. Set to true
to set the API key
to have no expiration time.
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6354 class UpdateKeyRequest < Struct.new( :description, :expire_time, :force_update, :key_name, :no_expiry, :restrictions) SENSITIVE = [] include Aws::Structure end |
#restrictions ⇒ Types::ApiKeyRestrictions
Updates the API key restrictions for the API key resource.
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6354 class UpdateKeyRequest < Struct.new( :description, :expire_time, :force_update, :key_name, :no_expiry, :restrictions) SENSITIVE = [] include Aws::Structure end |