Amazonka.Lightsail.Types.AccessKey

Documentation

data AccessKey

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.

See: newAccessKey smart constructor.

Constructors

AccessKey'

Fields

• accessKeyId :: Maybe (Sensitive Text)

  The ID of the access key.

• createdAt :: Maybe POSIX

  The timestamp when the access key was created.

• lastUsed :: Maybe AccessKeyLastUsed

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

  This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

• secretAccessKey :: Maybe Text

  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.

• status :: Maybe StatusType

  The status of the access key.

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

Instances

FromJSON AccessKey

Defined in Amazonka.Lightsail.Types.AccessKey

Methods

parseJSON :: Value -> Parser AccessKey

parseJSONList :: Value -> Parser [AccessKey]

Generic AccessKey

Defined in Amazonka.Lightsail.Types.AccessKey

Associated Types

type Rep AccessKey :: Type -> Type

Methods

from :: AccessKey -> Rep AccessKey x

to :: Rep AccessKey x -> AccessKey

Show AccessKey

Defined in Amazonka.Lightsail.Types.AccessKey

Methods

showsPrec :: Int -> AccessKey -> ShowS

show :: AccessKey -> String

showList :: [AccessKey] -> ShowS

NFData AccessKey

Defined in Amazonka.Lightsail.Types.AccessKey

Methods

rnf :: AccessKey -> ()

Eq AccessKey

Defined in Amazonka.Lightsail.Types.AccessKey

Methods

(==) :: AccessKey -> AccessKey -> Bool

(/=) :: AccessKey -> AccessKey -> Bool

Hashable AccessKey

Defined in Amazonka.Lightsail.Types.AccessKey

Methods

hashWithSalt :: Int -> AccessKey -> Int

hash :: AccessKey -> Int

type Rep AccessKey

Defined in Amazonka.Lightsail.Types.AccessKey

type Rep AccessKey = D1 ('MetaData "AccessKey" "Amazonka.Lightsail.Types.AccessKey" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "AccessKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "lastUsed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessKeyLastUsed)) :*: (S1 ('MetaSel ('Just "secretAccessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatusType))))))

newAccessKey :: AccessKey

Create a value of AccessKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessKeyId:AccessKey', accessKey_accessKeyId - The ID of the access key.

$sel:createdAt:AccessKey', accessKey_createdAt - The timestamp when the access key was created.

$sel:lastUsed:AccessKey', accessKey_lastUsed - An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

$sel:secretAccessKey:AccessKey', accessKey_secretAccessKey - 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.

$sel:status:AccessKey', accessKey_status - The status of the access key.

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

accessKey_accessKeyId :: Lens' AccessKey (Maybe Text)

The ID of the access key.

accessKey_createdAt :: Lens' AccessKey (Maybe UTCTime)

The timestamp when the access key was created.

accessKey_lastUsed :: Lens' AccessKey (Maybe AccessKeyLastUsed)

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

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

accessKey_secretAccessKey :: Lens' AccessKey (Maybe Text)

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.

accessKey_status :: Lens' AccessKey (Maybe StatusType)

The status of the access key.

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