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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/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) 


6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6801

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.

Returns:

  • (Time) 


6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6801

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) 


6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6801

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) 


6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6801

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) 


6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6801

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:



6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6801

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