Amazon MediaPackage · JSON Structure

Mediapackage Api Speke Key Provider Structure

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

Type: object Properties: 6 Required: 4
BroadcastingMedia ProcessingMedia

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

Properties

CertificateArn EncryptionContractConfiguration ResourceId RoleArn SystemIds Url

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-mediapackage/refs/heads/main/json-structure/mediapackage-api-speke-key-provider-structure.json",
  "name": "SpekeKeyProvider",
  "type": "object",
  "description": "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.",
  "properties": {
    "CertificateArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "certificateArn"
          },
          "description": "An Amazon Resource Name (ARN) of a Certificate Manager certificate\nthat MediaPackage will use for enforcing secure end-to-end data\ntransfer with the key provider service.\n"
        }
      ]
    },
    "EncryptionContractConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionContractConfiguration"
        },
        {
          "xml": {
            "name": "encryptionContractConfiguration"
          }
        }
      ]
    },
    "ResourceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "resourceId"
          },
          "description": "The resource ID to include in key requests."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "roleArn"
          },
          "description": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental\nMediaPackage will assume when accessing the key provider service.\n"
        }
      ]
    },
    "SystemIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "xml": {
            "name": "systemIds"
          },
          "description": "The system IDs to include in key requests."
        }
      ]
    },
    "Url": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "url"
          },
          "description": "The URL of the external key provider service."
        }
      ]
    }
  },
  "required": [
    "ResourceId",
    "SystemIds",
    "Url",
    "RoleArn"
  ]
}