openapi: 3.0.0
info:
version: 2015-08-04
x-release: v4
title: 'Amazon Kinesis Firehose CreateSignalingChannel #X Amz Target=Firehose 20150804.CreateDeliveryStream API'
description: <fullname>Amazon Kinesis Data Firehose API Reference</fullname> <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: firehose
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/firehose-2015-08-04.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://firehose.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Firehose multi-region endpoint
- url: https://firehose.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Firehose multi-region endpoint
- url: http://firehose.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Firehose endpoint for China (Beijing) and China (Ningxia)
- url: https://firehose.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Firehose endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=Firehose 20150804.CreateDeliveryStream'
paths:
/#X-Amz-Target=Firehose_20150804.CreateDeliveryStream:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateDeliveryStream
description: '<p>Creates a Kinesis Data Firehose delivery stream.</p> <p>By default, you can create up to 50 delivery streams per Amazon Web Services Region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. If the delivery stream creation fails, the status transitions to <code>CREATING_FAILED</code>. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>If the status of a delivery stream is <code>CREATING_FAILED</code>, this status doesn''t change, and you can''t invoke <code>CreateDeliveryStream</code> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it.</p> <p>A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the <code>DeliveryStreamType</code> parameter to <code>KinesisStreamAsSource</code>, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the <code>KinesisStreamSourceConfiguration</code> parameter.</p> <p>To create a delivery stream with server-side encryption (SSE) enabled, include <a>DeliveryStreamEncryptionConfigurationInput</a> in your request. This is optional. You can also invoke <a>StartDeliveryStreamEncryption</a> to turn on SSE for an existing delivery stream that doesn''t have SSE enabled.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: <code>ExtendedS3DestinationConfiguration</code>, <code>S3DestinationConfiguration</code>, <code>ElasticsearchDestinationConfiguration</code>, <code>RedshiftDestinationConfiguration</code>, or <code>SplunkDestinationConfiguration</code>.</p> <p>When you specify <code>S3DestinationConfiguration</code>, you can also provide the following optional values: BufferingHints, <code>EncryptionConfiguration</code>, and <code>CompressionFormat</code>. By default, if no <code>BufferingHints</code> value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. <code>BufferingHints</code> is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <code>RedshiftDestinationConfiguration.S3Configuration</code> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn''t support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant Kinesis Data Firehose Access to an Amazon S3 Destination</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDeliveryStreamOutput'
'480':
description: InvalidArgumentException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArgumentException'
'481':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'482':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'483':
description: InvalidKMSResourceException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidKMSResourceException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDeliveryStreamInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Firehose_20150804.CreateDeliveryStream
tags:
- '#X Amz Target=Firehose 20150804.CreateDeliveryStream'
components:
schemas:
HttpEndpointBufferingHints:
type: object
properties:
SizeInMBs:
allOf:
- $ref: '#/components/schemas/HttpEndpointBufferingSizeInMBs'
- description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. </p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
IntervalInSeconds:
allOf:
- $ref: '#/components/schemas/HttpEndpointBufferingIntervalInSeconds'
- description: 'Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). '
description: 'Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The <code>SizeInMBs</code> and <code>IntervalInSeconds</code> parameters are optional. However, if specify a value for one of them, you must also provide a value for the other. '
DeliveryStreamType:
type: string
enum:
- DirectPut
- KinesisStreamAsSource
HttpEndpointCommonAttribute:
type: object
required:
- AttributeName
- AttributeValue
properties:
AttributeName:
allOf:
- $ref: '#/components/schemas/HttpEndpointAttributeName'
- description: The name of the HTTP endpoint common attribute.
AttributeValue:
allOf:
- $ref: '#/components/schemas/HttpEndpointAttributeValue'
- description: The value of the HTTP endpoint common attribute.
description: Describes the metadata that's delivered to the specified HTTP endpoint destination.
ElasticsearchS3BackupMode:
type: string
enum:
- FailedDocumentsOnly
- AllDocuments
HECEndpoint:
type: string
pattern: .*
minLength: 0
maxLength: 2048
ProcessorParameterList:
type: array
items:
$ref: '#/components/schemas/ProcessorParameter'
TagDeliveryStreamInputTagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 50
DynamicPartitioningConfiguration:
type: object
properties:
RetryOptions:
allOf:
- $ref: '#/components/schemas/RetryOptions'
- description: The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
Enabled:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
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. '
CloudWatchLoggingOptions:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Enables or disables CloudWatch logging.
LogGroupName:
allOf:
- $ref: '#/components/schemas/LogGroupName'
- description: The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName:
allOf:
- $ref: '#/components/schemas/LogStreamName'
- description: The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
description: Describes the Amazon CloudWatch logging options for your delivery stream.
S3BackupMode:
type: string
enum:
- Disabled
- Enabled
AmazonopensearchserviceTypeName:
type: string
pattern: .*
minLength: 0
maxLength: 100
OutputFormatConfiguration:
type: object
properties:
Serializer:
allOf:
- $ref: '#/components/schemas/Serializer'
- description: Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.
description: Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true.
HttpEndpointCommonAttributesList:
type: array
items:
$ref: '#/components/schemas/HttpEndpointCommonAttribute'
minItems: 0
maxItems: 50
LogGroupName:
type: string
pattern: '[\.\-_/#A-Za-z0-9]*'
minLength: 0
maxLength: 512
HttpEndpointAccessKey:
type: string
pattern: .*
minLength: 0
maxLength: 4096
format: password
AmazonopensearchserviceBufferingHints:
type: object
properties:
IntervalInSeconds:
allOf:
- $ref: '#/components/schemas/AmazonopensearchserviceBufferingIntervalInSeconds'
- description: 'Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). '
SizeInMBs:
allOf:
- $ref: '#/components/schemas/AmazonopensearchserviceBufferingSizeInMBs'
- description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.</p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
description: 'Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination. '
AmazonOpenSearchServerlessBufferingHints:
type: object
properties:
IntervalInSeconds:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingIntervalInSeconds'
- description: Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
SizeInMBs:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingSizeInMBs'
- description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. </p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>
description: Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
HttpEndpointRetryDurationInSeconds:
type: integer
minimum: 0
maximum: 7200
Processor:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/ProcessorType'
- description: The type of processor.
Parameters:
allOf:
- $ref: '#/components/schemas/ProcessorParameterList'
- description: The processor parameters.
description: Describes a data processor.
NonEmptyString:
type: string
pattern: ^(?!\s*$).+
minLength: 1
maxLength: 1024
CopyOptions:
type: string
pattern: .*
minLength: 0
maxLength: 204800
ProcessorType:
type: string
enum:
- RecordDeAggregation
- Lambda
- MetadataExtraction
- AppendDelimiterToRecord
AmazonopensearchserviceBufferingSizeInMBs:
type: integer
minimum: 1
maximum: 100
RedshiftS3BackupMode:
type: string
enum:
- Disabled
- Enabled
OrcCompression:
type: string
enum:
- NONE
- ZLIB
- SNAPPY
CreateDeliveryStreamInput:
type: object
required:
- DeliveryStreamName
title: CreateDeliveryStreamInput
properties:
DeliveryStreamName:
allOf:
- $ref: '#/components/schemas/DeliveryStreamName'
- description: The name of the delivery stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
DeliveryStreamType:
allOf:
- $ref: '#/components/schemas/DeliveryStreamType'
- description: '<p>The delivery stream type. This parameter can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream as a source.</p> </li> </ul>'
KinesisStreamSourceConfiguration:
allOf:
- $ref: '#/components/schemas/KinesisStreamSourceConfiguration'
- description: When a Kinesis data stream is used as the source for the delivery stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
DeliveryStreamEncryptionConfigurationInput:
allOf:
- $ref: '#/components/schemas/DeliveryStreamEncryptionConfigurationInput'
- description: Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
S3DestinationConfiguration:
allOf:
- $ref: '#/components/schemas/S3DestinationConfiguration'
- deprecated: true
description: '[Deprecated] The destination in Amazon S3. You can specify only one destination.'
ExtendedS3DestinationConfiguration:
allOf:
- $ref: '#/components/schemas/ExtendedS3DestinationConfiguration'
- description: The destination in Amazon S3. You can specify only one destination.
RedshiftDestinationConfiguration:
allOf:
- $ref: '#/components/schemas/RedshiftDestinationConfiguration'
- description: The destination in Amazon Redshift. You can specify only one destination.
ElasticsearchDestinationConfiguration:
allOf:
- $ref: '#/components/schemas/ElasticsearchDestinationConfiguration'
- description: The destination in Amazon ES. You can specify only one destination.
AmazonopensearchserviceDestinationConfiguration:
allOf:
- $ref: '#/components/schemas/AmazonopensearchserviceDestinationConfiguration'
- description: The destination in Amazon OpenSearch Service. You can specify only one destination.
SplunkDestinationConfiguration:
allOf:
- $ref: '#/components/schemas/SplunkDestinationConfiguration'
- description: The destination in Splunk. You can specify only one destination.
HttpEndpointDestinationConfiguration:
allOf:
- $ref: '#/components/schemas/HttpEndpointDestinationConfiguration'
- description: Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
Tags:
allOf:
- $ref: '#/components/schemas/TagDeliveryStreamInputTagList'
- description: <p>A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User Guide.</p> <p>You can specify up to 50 tags when creating a delivery stream.</p>
AmazonOpenSearchServerlessDestinationConfiguration:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessDestinationConfiguration'
- description: The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
OrcStripeSizeBytes:
type: integer
minimum: 8388608
ProcessorParameter:
type: object
required:
- ParameterName
- ParameterValue
properties:
ParameterName:
allOf:
- $ref: '#/components/schemas/ProcessorParameterName'
- description: 'The name of the parameter. Currently the following default values are supported: 3 for <code>NumberOfRetries</code> and 60 for the <code>BufferIntervalInSeconds</code>. The <code>BufferSizeInMBs</code> ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB. '
ParameterValue:
allOf:
- $ref: '#/components/schemas/ProcessorParameterValue'
- description: The parameter value.
description: 'Describes the processor parameter. '
InputFormatConfiguration:
type: object
properties:
Deserializer:
allOf:
- $ref: '#/components/schemas/Deserializer'
- description: Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.
description: Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if <code>Enabled</code> is set to true.
KeyType:
type: string
enum:
- AWS_OWNED_CMK
- CUSTOMER_MANAGED_CMK
RedshiftDestinationConfiguration:
type: object
required:
- RoleARN
- ClusterJDBCURL
- CopyCommand
- Username
- Password
- S3Configuration
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>.
ClusterJDBCURL:
allOf:
- $ref: '#/components/schemas/ClusterJDBCURL'
- description: The database connection string.
CopyCommand:
allOf:
- $ref: '#/components/schemas/CopyCommand'
- description: The <code>COPY</code> command.
Username:
allOf:
- $ref: '#/components/schemas/Username'
- description: The name of the user.
Password:
allOf:
- $ref: '#/components/schemas/Password'
- description: The user password.
RetryOptions:
allOf:
- $ref: '#/components/schemas/RedshiftRetryOptions'
- description: The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
S3Configuration:
allOf:
- $ref: '#/components/schemas/S3DestinationConfiguration'
- description: <p>The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>
ProcessingConfiguration:
allOf:
- $ref: '#/components/schemas/ProcessingConfiguration'
- description: The data processing configuration.
S3BackupMode:
allOf:
- $ref: '#/components/schemas/RedshiftS3BackupMode'
- description: 'The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can''t update the delivery stream to disable it. '
S3BackupConfiguration:
allOf:
- $ref: '#/components/schemas/S3DestinationConfiguration'
- description: The configuration for backup in Amazon S3.
CloudWatchLoggingOptions:
allOf:
- $ref: '#/components/schemas/CloudWatchLoggingOptions'
- description: The CloudWatch logging options for your delivery stream.
description: Describes the configuration of a destination in Amazon Redshift.
HttpEndpointUrl:
type: string
pattern: https://.*
minLength: 1
maxLength: 1000
format: password
HiveJsonSerDe:
type: object
properties:
TimestampFormats:
allOf:
- $ref: '#/components/schemas/ListOfNonEmptyStrings'
- description: Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see <a href="https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html">Class DateTimeFormat</a>. You can also use the special value <code>millis</code> to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses <code>java.sql.Timestamp::valueOf</code> by default.
description: The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
DataTableName:
type: string
pattern: .*
minLength: 1
maxLength: 512
VpcConfiguration:
type: object
required:
- SubnetIds
- RoleARN
- SecurityGroupIds
properties:
SubnetIds:
allOf:
- $ref: '#/components/schemas/SubnetIdList'
- description: <p>The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>
RoleARN:
allOf:
- $ref: '#/components/schemas/RoleARN'
- description: <p>The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:</p> <ul> <li> <p> <code>ec2:DescribeVpcs</code> </p> </li> <li> <p> <code>ec2:DescribeVpcAttribute</code> </p> </li> <li> <p> <code>ec2:DescribeSubnets</code> </p> </li> <li> <p> <code>ec2:DescribeSecurityGroups</code> </p> </li> <li> <p> <code>ec2:DescribeNetworkInterfaces</code> </p> </li> <li> <p> <code>ec2:CreateNetworkInterface</code> </p> </li> <li> <p> <code>ec2:CreateNetworkInterfacePermission</code> </p> </li> <li> <p> <code>ec2:DeleteNetworkInterface</code> </p> </li> </ul> <p>If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.</p>
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdList'
- description: The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules">Security group rules</a> in the Amazon VPC documentation.
description: The details of the VPC of the Amazon ES destination.
ElasticsearchRetryOptions:
type: object
properties:
DurationInSeconds:
allOf:
- $ref: '#/components/schemas/ElasticsearchRetryDurationInSeconds'
- description: After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
description: Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
ElasticsearchIndexRotationPeriod:
type: string
enum:
- NoRotation
- OneHour
- OneDay
- OneWeek
- OneMonth
OrcRowIndexStride:
type: integer
minimum: 1000
ElasticsearchDomainARN:
type: string
patt
# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kinesis/refs/heads/main/openapi/kinesis-x-amz-target-firehose-20150804-createdeliverystream-api-openapi.yml