libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodePipeline.Types.EncryptionKey

Description

 
Synopsis

Documentation

data EncryptionKey Source #

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

See: newEncryptionKey smart constructor.

Constructors

EncryptionKey' 

Fields

  • id :: Text

    The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.

    Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

  • type' :: EncryptionKeyType

    The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

Instances

Instances details
Eq EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

Read EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

Show EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

Generic EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

Associated Types

type Rep EncryptionKey :: Type -> Type #

NFData EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

Methods

rnf :: EncryptionKey -> () #

Hashable EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

ToJSON EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

FromJSON EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

type Rep EncryptionKey Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.EncryptionKey

type Rep EncryptionKey = D1 ('MetaData "EncryptionKey" "Amazonka.CodePipeline.Types.EncryptionKey" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "EncryptionKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionKeyType)))

newEncryptionKey Source #

Create a value of EncryptionKey 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:id:EncryptionKey', encryptionKey_id - The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

$sel:type':EncryptionKey', encryptionKey_type - The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

encryptionKey_id :: Lens' EncryptionKey Text Source #

The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType Source #

The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.