Class: Aws::Lightsail::Types::AccessKey

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

Overview

Describes an access key for an Amazon Lightsail bucket.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the [CreateBucketAccessKey] action to create an access key for a specific bucket. For more information about access keys, see [Creating access keys for a bucket in Amazon Lightsail] in the *Amazon Lightsail Developer Guide*.

The ‘secretAccessKey` value is returned only in response to the `CreateBucketAccessKey` action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

[1]: docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html [2]: lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_key_id]

Instance Attribute Summary collapse

Instance Attribute Details

#access_key_id ⇒ String

The ID of the access key.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-lightsail/types.rb', line 99

class AccessKey < Struct.new(
  :access_key_id,
  :secret_access_key,
  :status,
  :created_at,
  :last_used)
  SENSITIVE = [:access_key_id]
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the access key was created.

Returns:

  • (Time) 


99
100
101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-lightsail/types.rb', line 99

class AccessKey < Struct.new(
  :access_key_id,
  :secret_access_key,
  :status,
  :created_at,
  :last_used)
  SENSITIVE = [:access_key_id]
  include Aws::Structure
end

#last_used ⇒ Types::AccessKeyLastUsed

An object that describes the last time the access key was used.

<note markdown=“1”> This object does not include data in the response of a

CreateBucketAccessKey][1

action. If the access key has not been

used, the ‘region` and `serviceName` values are `N/A`, and the `lastUsedDate` value is null.

</note>

[1]: docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html

Returns:



99
100
101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-lightsail/types.rb', line 99

class AccessKey < Struct.new(
  :access_key_id,
  :secret_access_key,
  :status,
  :created_at,
  :last_used)
  SENSITIVE = [:access_key_id]
  include Aws::Structure
end

#secret_access_key ⇒ String

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-lightsail/types.rb', line 99

class AccessKey < Struct.new(
  :access_key_id,
  :secret_access_key,
  :status,
  :created_at,
  :last_used)
  SENSITIVE = [:access_key_id]
  include Aws::Structure
end

#status ⇒ String

The status of the access key.

A status of ‘Active` means that the key is valid, while `Inactive` means it is not.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-lightsail/types.rb', line 99

class AccessKey < Struct.new(
  :access_key_id,
  :secret_access_key,
  :status,
  :created_at,
  :last_used)
  SENSITIVE = [:access_key_id]
  include Aws::Structure
end