Amazon CodePipeline · JSON Structure

Amazon Codepipeline Encryption Key Structure

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: 2 Required: 2
AmazonCI/CDContinuous DeliveryDevOpsPipelineRelease Automation

EncryptionKey is a JSON Structure definition published by Amazon CodePipeline, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-structure/amazon-codepipeline-encryption-key-structure.json",
  "name": "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"
  ]
}