Encryption

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconnect/refs/heads/main/json-schema/mediaconnect-api-encryption-schema.json",
  "title": "Encryption",
  "description": "Information about the encryption of the flow.",
  "type": "object",
  "properties": {
    "Algorithm": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Algorithm"
        },
        {
          "xml": {
            "name": "algorithm"
          },
          "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."
        }
      ]
    },
    "ConstantInitializationVector": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "constantInitializationVector"
          },
          "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."
        }
      ]
    },
    "DeviceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "deviceId"
          },
          "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."
        }
      ]
    },
    "KeyType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyType"
        },
        {
          "xml": {
            "name": "keyType"
          },
          "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."
        }
      ]
    },
    "Region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "region"
          },
          "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."
        }
      ]
    },
    "ResourceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "resourceId"
          },
          "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "roleArn"
          },
          "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."
        }
      ]
    },
    "SecretArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "secretArn"
          },
          "description": "The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."
        }
      ]
    },
    "Url": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "url"
          },
          "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."
        }
      ]
    }
  },
  "required": [
    "RoleArn"
  ]
}