AWS::CodePipeline::Pipeline EncryptionKey - AWS CloudFormation
SyntaxProperties

AWS::CodePipeline::Pipeline EncryptionKey

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

EncryptionKey is a property of the ArtifactStore property type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Id" : String,
  "Type" : String
}

YAML

  Id: String
  Type: String

Properties

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.

Note

Aliases are recognized only in the account that created the AWS KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

Required: Yes

Type: String

Update requires: No interruption

Type

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

Required: Yes

Type: String

Update requires: No interruption