AWS Kinesis · Schema

ExtendedS3DestinationUpdate

Describes an update for a destination in Amazon S3.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
RoleARN object
BucketARN object
Prefix object
ErrorOutputPrefix object
BufferingHints object
CompressionFormat object
EncryptionConfiguration object
CloudWatchLoggingOptions object
ProcessingConfiguration object
S3BackupMode object
S3BackupUpdate object
DataFormatConversionConfiguration object
DynamicPartitioningConfiguration object
View JSON Schema on GitHub

JSON Schema

kinesis-extendeds3destinationupdate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExtendedS3DestinationUpdate",
  "title": "ExtendedS3DestinationUpdate",
  "type": "object",
  "properties": {
    "RoleARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>."
        }
      ]
    },
    "BucketARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BucketARN"
        },
        {
          "description": "The ARN of the S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>."
        }
      ]
    },
    "Prefix": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Prefix"
        },
        {
          "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html\">Custom Prefixes for Amazon S3 Objects</a>."
        }
      ]
    },
    "ErrorOutputPrefix": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorOutputPrefix"
        },
        {
          "description": "A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html\">Custom Prefixes for Amazon S3 Objects</a>."
        }
      ]
    },
    "BufferingHints": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BufferingHints"
        },
        {
          "description": "The buffering option."
        }
      ]
    },
    "CompressionFormat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CompressionFormat"
        },
        {
          "description": "The compression format. If no value is specified, the default is <code>UNCOMPRESSED</code>. "
        }
      ]
    },
    "EncryptionConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionConfiguration"
        },
        {
          "description": "The encryption configuration. If no value is specified, the default is no encryption."
        }
      ]
    },
    "CloudWatchLoggingOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CloudWatchLoggingOptions"
        },
        {
          "description": "The Amazon CloudWatch logging options for your delivery stream."
        }
      ]
    },
    "ProcessingConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProcessingConfiguration"
        },
        {
          "description": "The data processing configuration."
        }
      ]
    },
    "S3BackupMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3BackupMode"
        },
        {
          "description": "You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it. "
        }
      ]
    },
    "S3BackupUpdate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3DestinationUpdate"
        },
        {
          "description": "The Amazon S3 destination for backup."
        }
      ]
    },
    "DataFormatConversionConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataFormatConversionConfiguration"
        },
        {
          "description": "The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3."
        }
      ]
    },
    "DynamicPartitioningConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DynamicPartitioningConfiguration"
        },
        {
          "description": "The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. "
        }
      ]
    }
  },
  "description": "Describes an update for a destination in Amazon S3."
}