AWS Kinesis · Schema

StopStreamEncryptionInput

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
StreamName object
EncryptionType object
KeyId object
StreamARN object
View JSON Schema on GitHub

JSON Schema

kinesis-stopstreamencryptioninput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StopStreamEncryptionInput",
  "title": "StopStreamEncryptionInput",
  "type": "object",
  "required": [
    "EncryptionType",
    "KeyId"
  ],
  "properties": {
    "StreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamName"
        },
        {
          "description": "The name of the stream on which to stop encrypting records."
        }
      ]
    },
    "EncryptionType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionType"
        },
        {
          "description": "The encryption type. The only valid value is <code>KMS</code>."
        }
      ]
    },
    "KeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyId"
        },
        {
          "description": "<p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Data Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
        }
      ]
    },
    "StreamARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamARN"
        },
        {
          "description": "The ARN of the stream."
        }
      ]
    }
  }
}