EncryptionKey

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

AmazonCI/CDContinuous DeliveryDevOpsPipelineRelease Automation

Properties

Name Type Description
id object
type object
View JSON Schema on GitHub

JSON Schema

amazon-codepipeline-encryption-key-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-schema/amazon-codepipeline-encryption-key-schema.json",
  "title": "EncryptionKey",
  "description": "Represents information about the key used to encrypt data in the artifact store, such as an Amazon Web Services Key Management Service (Key Management Service) key.",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionKeyId"
        },
        {
          "description": "<p>The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.</p> <note> <p>Aliases are recognized only in the account that created the 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).</p> </note>"
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionKeyType"
        },
        {
          "description": "The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'."
        }
      ]
    }
  },
  "required": [
    "id",
    "type"
  ]
}