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 = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Updates the description for the API key resource.

Returns:

  • (String) 


6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6673

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :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.

Returns:

  • (Time) 


6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6673

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :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

Returns:

  • (Boolean) 


6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6673

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

#key_name ⇒ String

The name of the API key resource to update.

Returns:

  • (String) 


6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6673

class UpdateKeyRequest < Struct.new(
  :key_name,
  :description,
  :expire_time,
  :no_expiry,
  :force_update,
  :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.

Returns:

  • (Boolean) 


6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6673

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

#restrictions ⇒ Types::ApiKeyRestrictions

Updates the API key restrictions for the API key resource.

Returns:



6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6673

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