AWS::CodePipeline::Pipeline EncryptionKey - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::CodePipeline::Pipeline EncryptionKey

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

EncryptionKey is a property of the ArtifactStore property type.

Syntax

To declare this entity in your Amazon 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 Amazon 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 Amazon 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 Amazon KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

Required: Yes

Type: String

Update requires: No interruption