Class: Aws::LocationService::Types::UpdateKeyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-locationservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:expire_time]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Updates the description for the API key resource.

Returns:

  • (String) 


6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6852

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :restrictions)
  SENSITIVE = [:expire_time]
  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`.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time) 


6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6852

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :restrictions)
  SENSITIVE = [:expire_time]
  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`

Returns:

  • (Boolean) 


6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6852

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :restrictions)
  SENSITIVE = [:expire_time]
  include Aws::Structure
end

#key_name ⇒ String

The name of the API key resource to update.

Returns:

  • (String) 


6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6852

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :restrictions)
  SENSITIVE = [:expire_time]
  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.

Returns:

  • (Boolean) 


6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6852

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :restrictions)
  SENSITIVE = [:expire_time]
  include Aws::Structure
end

#restrictions ⇒ Types::ApiKeyRestrictions

Updates the API key restrictions for the API key resource.

Returns:



6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6852

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :restrictions)
  SENSITIVE = [:expire_time]
  include Aws::Structure
end