AWS.Tools.KinesisFirehose

4.1.8.0

AWS.Tools.KinesisFirehose.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.KinesisFirehose</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet">
            <summary>
            Writes a single data record into an Amazon Kinesis Data Firehose delivery stream.
            To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>.
            Applications using these operations are referred to as producers.
             
              
            <para>
            By default, each delivery stream can take in up to 2,000 transactions per second,
            5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and <a>PutRecordBatch</a>,
            the limits are an aggregate across these two operations for each delivery stream.
            For more information about limits and how to request an increase, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon
            Kinesis Data Firehose Limits</a>.
            </para><para>
            You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>.
            The data record consists of a data blob that can be up to 1,000 KB in size, and any
            kind of data. For example, it can be a segment from a log file, geographic location
            data, website clickstream data, and so on.
            </para><para>
            Kinesis Data Firehose buffers records before delivering them to the destination. To
            disambiguate the data blobs at the destination, a common solution is to use delimiters
            in the data, such as a newline (<code>\n</code>) or some other character unique within
            the data. This allows the consumer application to parse individual data items when
            reading the data from the destination.
            </para><para>
            The <code>PutRecord</code> operation returns a <code>RecordId</code>, which is a unique
            string assigned to each record. Producer applications can use this ID for purposes
            such as auditability and investigation.
            </para><para>
            If the <code>PutRecord</code> operation throws a <code>ServiceUnavailableException</code>,
            back off and retry. If the exception persists, it is possible that the throughput
            limits have been exceeded for the delivery stream.
            </para><para>
            Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they
            are added to a delivery stream as it tries to send the records to the destination.
            If the destination is unreachable for more than 24 hours, the data is no longer available.
            </para><important><para>
            Don't concatenate two or more base64 strings to form the data fields of your records.
            Instead, concatenate the raw data, then perform base64 encoding.
            </para></important>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.Text">
            <summary>
            This parameter is obsolete and will be removed in a future version. Use 'Record_Data' instead.
            Text string containing the data to send, which is base64-encoded when serialized.
            The maximum size of the data blob, before base64-encoding, is 1,000 KB.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.FilePath">
            <summary>
            This parameter is obsolete and will be removed in a future version. Use 'Record_Data' instead.
            The fully qualified name to a file containing the data to be used instead of the Record_Data parameter.
            Text fully qualified name to a file containing the data to send, which is base64-encoded when serialized.
            The maximum size of the data blob, before base64-encoding, is 1,000 KB.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.Record_Data">
            <summary>
            <para>
            <para>The data blob, which is base64-encoded when the blob is serialized. The maximum size
            of the data blob, before base64-encoding, is 1,000 KiB.</para>
            </para>
            <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'RecordId'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.PutRecordResponse).
            Specifying the name of a property of type Amazon.KinesisFirehose.Model.PutRecordResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.AddKINFDeliveryStreamTagCmdlet">
            <summary>
            Adds or updates tags for the specified delivery stream. A tag is a key-value pair
            that you can define and assign to AWS resources. If you specify a tag that already
            exists, the tag value is replaced with the value that you specify in the request.
            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 <i>AWS Billing and Cost Management User Guide</i>.
             
             
              
            <para>
            Each delivery stream can have up to 50 tags.
            </para><para>
            This operation has a limit of five transactions per second per account.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.AddKINFDeliveryStreamTagCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream to which you want to add the tags.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.AddKINFDeliveryStreamTagCmdlet.Tag">
            <summary>
            <para>
            <para>A set of key-value pairs to use to create the tags.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.AddKINFDeliveryStreamTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.TagDeliveryStreamResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.AddKINFDeliveryStreamTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the DeliveryStreamName parameter.
            The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.AddKINFDeliveryStreamTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet">
            <summary>
            Describes the specified delivery stream and its status. For example, after your delivery
            stream is created, call <code>DescribeDeliveryStream</code> to see whether the delivery
            stream is <code>ACTIVE</code> and therefore ready for data to be sent to it.
             
              
            <para>
            If the status of a delivery stream is <code>CREATING_FAILED</code>, this status doesn't
            change, and you can't invoke <a>CreateDeliveryStream</a> again on it. However, you
            can invoke the <a>DeleteDeliveryStream</a> operation to delete it. If the status is
            <code>DELETING_FAILED</code>, you can force deletion by invoking <a>DeleteDeliveryStream</a>
            again but with <a>DeleteDeliveryStreamInput$AllowForceDelete</a> set to true.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet.ExclusiveStartDestinationId">
            <summary>
            <para>
            <para>The ID of the destination to start returning the destination information. Kinesis
            Data Firehose supports one destination per delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet.Limit">
            <summary>
            <para>
            <para>The limit on the number of destinations to return. You can have one destination per
            delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'DeliveryStreamDescription'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.DescribeDeliveryStreamResponse).
            Specifying the name of a property of type Amazon.KinesisFirehose.Model.DescribeDeliveryStreamResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet">
            <summary>
            Lists your delivery streams in alphabetical order of their names.
             
              
            <para>
            The number of delivery streams might be too large to return using a single call to
            <code>ListDeliveryStreams</code>. You can limit the number of delivery streams returned,
            using the <code>Limit</code> parameter. To determine whether there are more delivery
            streams to list, check the value of <code>HasMoreDeliveryStreams</code> in the output.
            If there are more delivery streams to list, you can request them by calling this operation
            again and setting the <code>ExclusiveStartDeliveryStreamName</code> parameter to the
            name of the last delivery stream returned in the last call.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet.DeliveryStreamType">
            <summary>
            <para>
            <para>The delivery stream type. This can be one of the following values:</para><ul><li><para><code>DirectPut</code>: Provider applications access the delivery stream directly.</para></li><li><para><code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream
            as a source.</para></li></ul><para>This parameter is optional. If this parameter is omitted, delivery streams of all
            types are returned.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet.ExclusiveStartDeliveryStreamName">
            <summary>
            <para>
            <para>The list of delivery streams returned by this call to <code>ListDeliveryStreams</code>
            will start with the delivery stream whose name comes alphabetically immediately after
            the name you specify in <code>ExclusiveStartDeliveryStreamName</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet.Limit">
            <summary>
            <para>
            <para>The maximum number of delivery streams to list. The default value is 10.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.ListDeliveryStreamsResponse).
            Specifying the name of a property of type Amazon.KinesisFirehose.Model.ListDeliveryStreamsResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.GetKINFTagsForDeliveryStreamCmdlet">
            <summary>
            Lists the tags for the specified delivery stream. This operation has a limit of five
            transactions per second per account.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFTagsForDeliveryStreamCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream whose tags you want to list.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFTagsForDeliveryStreamCmdlet.ExclusiveStartTagKey">
            <summary>
            <para>
            <para>The key to use as the starting point for the list of tags. If you set this parameter,
            <code>ListTagsForDeliveryStream</code> gets all tags that occur after <code>ExclusiveStartTagKey</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFTagsForDeliveryStreamCmdlet.Limit">
            <summary>
            <para>
            <para>The number of tags to return. If this number is less than the total number of tags
            associated with the delivery stream, <code>HasMoreTags</code> is set to <code>true</code>
            in the response. To list additional tags, set <code>ExclusiveStartTagKey</code> to
            the last key in the response. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFTagsForDeliveryStreamCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.ListTagsForDeliveryStreamResponse).
            Specifying the name of a property of type Amazon.KinesisFirehose.Model.ListTagsForDeliveryStreamResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFTagsForDeliveryStreamCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the DeliveryStreamName parameter.
            The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet">
            <summary>
            Creates a Kinesis Data Firehose delivery stream.
             
              
            <para>
            By default, you can create up to 50 delivery streams per AWS Region.
            </para><para>
            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>.
            </para><para>
            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.
            </para><para>
            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.
            </para><para>
            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.
            </para><para>
            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>.
            </para><para>
            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.
            </para><para>
            A few notes about Amazon Redshift as a destination:
            </para><ul><li><para>
            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.
            </para></li><li><para>
            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.
            </para></li><li><para>
            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.
            </para></li></ul><para>
            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>.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_EndpointConfiguration_AccessKey">
            <summary>
            <para>
            <para>The access key required for Kinesis Firehose to authenticate with the HTTP endpoint
            selected as the destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_ClusterEndpoint">
            <summary>
            <para>
            <para>The endpoint to use when communicating with the cluster. Specify either this <code>ClusterEndpoint</code>
            or the <code>DomainARN</code> field.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_RequestConfiguration_CommonAttributes">
            <summary>
            <para>
            <para>Describes the metadata sent to the HTTP endpoint destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_RequestConfiguration_ContentEncoding">
            <summary>
            <para>
            <para>Kinesis Data Firehose uses the content encoding to compress the body of a request
            before sending the request to the destination. For more information, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding">Content-Encoding</a>
            in MDN Web Docs, the official Mozilla documentation.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream. This name must be unique per AWS account in the same
            AWS Region. If the delivery streams are in different accounts or different Regions,
            you can have multiple delivery streams with the same name.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.DeliveryStreamType">
            <summary>
            <para>
            <para>The delivery stream type. This parameter can be one of the following values:</para><ul><li><para><code>DirectPut</code>: Provider applications access the delivery stream directly.</para></li><li><para><code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream
            as a source.</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_DomainARN">
            <summary>
            <para>
            <para>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>,
            <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after
            assuming the role specified in <b>RoleARN</b>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            Resource Names (ARNs) and AWS Service Namespaces</a>.</para><para>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.RetryOptions_DurationInSecond">
            <summary>
            <para>
            <para>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.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_RetryOptions_DurationInSeconds">
            <summary>
            <para>
            <para>The total amount of time that Kinesis Data Firehose spends on retries. This duration
            starts after the initial attempt to send data to the custom destination via HTTPS
            endpoint fails. It doesn't include the periods during which Kinesis Data Firehose
            waits for acknowledgment from the specified destination after each attempt. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.CloudWatchLoggingOptions_Enabled">
            <summary>
            <para>
            <para>Enables or disables CloudWatch logging.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ProcessingConfiguration_Enabled">
            <summary>
            <para>
            <para>Enables or disables data processing.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_CloudWatchLoggingOptions_Enabled">
            <summary>
            <para>
            <para>Enables or disables CloudWatch logging.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_ProcessingConfiguration_Enabled">
            <summary>
            <para>
            <para>Enables or disables data processing.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ExtendedS3DestinationConfiguration">
            <summary>
            <para>
            <para>The destination in Amazon S3. You can specify only one destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_IndexName">
            <summary>
            <para>
            <para>The Elasticsearch index name.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_IndexRotationPeriod">
            <summary>
            <para>
            <para>The Elasticsearch index rotation period. Index rotation appends a timestamp to the
            <code>IndexName</code> to facilitate the expiration of old data. For more information,
            see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation">Index
            Rotation for the Amazon ES Destination</a>. The default value is <code>OneDay</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.BufferingHints_IntervalInSecond">
            <summary>
            <para>
            <para>Buffer incoming data for the specified period of time, in seconds, before delivering
            it to the destination. The default value is 300 (5 minutes).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_BufferingHints_IntervalInSeconds">
            <summary>
            <para>
            <para>Buffer incoming data for the specified period of time, in seconds, before delivering
            it to the destination. The default value is 300 (5 minutes). </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.DeliveryStreamEncryptionConfigurationInput_KeyARN">
            <summary>
            <para>
            <para>If you set <code>KeyType</code> to <code>CUSTOMER_MANAGED_CMK</code>, you must specify
            the Amazon Resource Name (ARN) of the CMK. If you set <code>KeyType</code> to <code>AWS_OWNED_CMK</code>,
            Kinesis Data Firehose uses a service-account CMK.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.DeliveryStreamEncryptionConfigurationInput_KeyType">
            <summary>
            <para>
            <para>Indicates the type of customer master key (CMK) to use for encryption. The default
            setting is <code>AWS_OWNED_CMK</code>. For more information about CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer
            Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a>
            with <code>KeyType</code> set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes
            the Amazon KMS operation <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html">CreateGrant</a>
            to create a grant that allows the Kinesis Data Firehose service to use the customer
            managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that
            grant. </para><para>When you invoke <a>StartDeliveryStreamEncryption</a> to change the CMK for a delivery
            stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules
            the grant it had on the old CMK for retirement.</para><para>You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams.
            If a <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> operation
            exceeds this limit, Kinesis Data Firehose throws a <code>LimitExceededException</code>.
            </para><important><para>To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't
            support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see
            <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html">About
            Symmetric and Asymmetric CMKs</a> in the AWS Key Management Service developer guide.</para></important>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.KinesisStreamSourceConfiguration_KinesisStreamARN">
            <summary>
            <para>
            <para>The ARN of the source Kinesis data stream. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
            Kinesis Data Streams ARN Format</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.CloudWatchLoggingOptions_LogGroupName">
            <summary>
            <para>
            <para>The CloudWatch group name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_CloudWatchLoggingOptions_LogGroupName">
            <summary>
            <para>
            <para>The CloudWatch group name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.CloudWatchLoggingOptions_LogStreamName">
            <summary>
            <para>
            <para>The CloudWatch log stream name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_CloudWatchLoggingOptions_LogStreamName">
            <summary>
            <para>
            <para>The CloudWatch log stream name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.EndpointConfiguration_Name">
            <summary>
            <para>
            <para>The name of the HTTP endpoint selected as the destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ProcessingConfiguration_Processor">
            <summary>
            <para>
            <para>The data processors.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_ProcessingConfiguration_Processors">
            <summary>
            <para>
            <para>The data processors.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.RedshiftDestinationConfiguration">
            <summary>
            <para>
            <para>The destination in Amazon Redshift. You can specify only one destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_RoleARN">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
            for calling the Amazon ES Configuration API and for indexing documents. 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> and <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            Resource Names (ARNs) and AWS Service Namespaces</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.VpcConfiguration_RoleARN">
            <summary>
            <para>
            <para>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:</para><ul><li><para><code>ec2:DescribeVpcs</code></para></li><li><para><code>ec2:DescribeVpcAttribute</code></para></li><li><para><code>ec2:DescribeSubnets</code></para></li><li><para><code>ec2:DescribeSecurityGroups</code></para></li><li><para><code>ec2:DescribeNetworkInterfaces</code></para></li><li><para><code>ec2:CreateNetworkInterface</code></para></li><li><para><code>ec2:CreateNetworkInterfacePermission</code></para></li><li><para><code>ec2:DeleteNetworkInterface</code></para></li></ul><para>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.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_RoleARN">
            <summary>
            <para>
            <para>Kinesis Data Firehose uses this IAM role for all the permissions that the delivery
            stream needs.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.KinesisStreamSourceConfiguration_RoleARN">
            <summary>
            <para>
            <para>The ARN of the role that provides access to the source Kinesis data stream. For more
            information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
            Identity and Access Management (IAM) ARN Format</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_S3BackupMode">
            <summary>
            <para>
            <para>Defines how documents should be delivered to Amazon S3. When it is set to <code>FailedDocumentsOnly</code>,
            Kinesis Data Firehose writes any documents that could not be indexed to the configured
            Amazon S3 destination, with <code>elasticsearch-failed/</code> appended to the key
            prefix. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all
            incoming records to Amazon S3, and also writes failed documents with <code>elasticsearch-failed/</code>
            appended to the prefix. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup">Amazon
            S3 Backup for the Amazon ES Destination</a>. Default value is <code>FailedDocumentsOnly</code>.</para><para>You can't change this backup mode after you create the delivery stream. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_S3BackupMode">
            <summary>
            <para>
            <para>Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers
            to the HTTP endpoint destination. You can back up all documents (<code>AllData</code>)
            or only the documents that Kinesis Data Firehose could not deliver to the specified
            HTTP endpoint destination (<code>FailedDataOnly</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_S3Configuration">
            <summary>
            <para>
            <para>The configuration for the backup Amazon S3 location.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_S3Configuration">
            <summary>
            <para>
            The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.VpcConfiguration_SecurityGroupId">
            <summary>
            <para>
            <para>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.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.BufferingHints_SizeInMBs">
            <summary>
            <para>
            <para>Buffer incoming data to the specified size, in MBs, before delivering it to the destination.
            The default value is 5.</para><para>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.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_BufferingHints_SizeInMBs">
            <summary>
            <para>
            <para>Buffer incoming data to the specified size, in MBs, before delivering it to the destination.
            The default value is 5. </para><para>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. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SplunkDestinationConfiguration">
            <summary>
            <para>
            <para>The destination in Splunk. You can specify only one destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.VpcConfiguration_SubnetId">
            <summary>
            <para>
            <para>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.</para><para>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.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.Tag">
            <summary>
            <para>
            <para>A set of tags to assign to the delivery stream. A tag is a key-value pair that you
            can define and assign to AWS 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 AWS Billing and Cost Management User Guide.</para><para>You can specify up to 50 tags when creating a delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.ElasticsearchDestinationConfiguration_TypeName">
            <summary>
            <para>
            <para>The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per
            index. If you try to specify a new type for an existing index that already has another
            type, Kinesis Data Firehose returns an error during run time.</para><para>For Elasticsearch 7.x, don't specify a <code>TypeName</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_EndpointConfiguration_Url">
            <summary>
            <para>
            <para>The URL of the HTTP endpoint selected as the destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.S3DestinationConfiguration">
            <summary>
            <para>
            <para>[Deprecated] The destination in Amazon S3. You can specify only one destination.</para>
            </para>
            <para>This parameter is deprecated.</para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'DeliveryStreamARN'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.CreateDeliveryStreamResponse).
            Specifying the name of a property of type Amazon.KinesisFirehose.Model.CreateDeliveryStreamResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet">
            <summary>
            Deletes a delivery stream and its data.
             
              
            <para>
            To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>. You can
            delete a delivery stream only if it is in one of the following states: <code>ACTIVE</code>,
            <code>DELETING</code>, <code>CREATING_FAILED</code>, or <code>DELETING_FAILED</code>.
            You can't delete a delivery stream that is in the <code>CREATING</code> state. While
            the deletion request is in process, the delivery stream is in the <code>DELETING</code>
            state.
            </para><para>
            While the delivery stream is in the <code>DELETING</code> state, the service might
            continue to accept records, but it doesn't make any guarantees with respect to delivering
            the data. Therefore, as a best practice, first stop any applications that are sending
            records before you delete a delivery stream.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.AllowForceDelete">
            <summary>
            <para>
            <para>Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose
            is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to
            retire the grant due to a customer error, such as when the CMK or the grant are in
            an invalid state. If you force deletion, you can then use the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a>
            operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire
            the grant happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the
            delete operation.</para><para>The default value is false.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.DeleteDeliveryStreamResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the DeliveryStreamName parameter.
            The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamTagCmdlet">
            <summary>
            Removes tags from the specified delivery stream. Removed tags are deleted, and you
            can't recover them after this operation successfully completes.
             
              
            <para>
            If you specify a tag that doesn't exist, the operation ignores it.
            </para><para>
            This operation has a limit of five transactions per second per account.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamTagCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamTagCmdlet.TagKey">
            <summary>
            <para>
            <para>A list of tag keys. Each corresponding tag is removed from the delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.UntagDeliveryStreamResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the DeliveryStreamName parameter.
            The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.StartKINFDeliveryStreamEncryptionCmdlet">
            <summary>
            Enables server-side encryption (SSE) for the delivery stream.
             
              
            <para>
            This operation is asynchronous. It returns immediately. When you invoke it, Kinesis
            Data Firehose first sets the encryption status of the stream to <code>ENABLING</code>,
            and then to <code>ENABLED</code>. The encryption status of a delivery stream is the
            <code>Status</code> property in <a>DeliveryStreamEncryptionConfiguration</a>. If the
            operation fails, the encryption status changes to <code>ENABLING_FAILED</code>. You
            can continue to read and write data to your delivery stream while the encryption status
            is <code>ENABLING</code>, but the data is not encrypted. It can take up to 5 seconds
            after the encryption status changes to <code>ENABLED</code> before all records written
            to the delivery stream are encrypted. To find out whether a record or a batch of records
            was encrypted, check the response elements <a>PutRecordOutput$Encrypted</a> and <a>PutRecordBatchOutput$Encrypted</a>,
            respectively.
            </para><para>
            To check the encryption status of a delivery stream, use <a>DescribeDeliveryStream</a>.
            </para><para>
            Even if encryption is currently enabled for a delivery stream, you can still invoke
            this operation on it to change the ARN of the CMK or both its type and ARN. If you
            invoke this method to change the CMK, and the old CMK is of type <code>CUSTOMER_MANAGED_CMK</code>,
            Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If
            the new CMK is of type <code>CUSTOMER_MANAGED_CMK</code>, Kinesis Data Firehose creates
            a grant that enables it to use the new CMK to encrypt and decrypt data and to manage
            the grant.
            </para><para>
            If a delivery stream already has encryption enabled and then you invoke this operation
            to change the ARN of the CMK or both its type and ARN and you get <code>ENABLING_FAILED</code>,
            this only means that the attempt to change the CMK failed. In this case, encryption
            remains enabled with the old CMK.
            </para><para>
            If the encryption status of your delivery stream is <code>ENABLING_FAILED</code>,
            you can invoke this operation again with a valid CMK. The CMK must be enabled and
            the key policy mustn't explicitly deny the permission for Kinesis Data Firehose to
            invoke KMS encrypt and decrypt operations.
            </para><para>
            You can enable SSE for a delivery stream only if it's a delivery stream that uses
            <code>DirectPut</code> as its source.
            </para><para>
            The <code>StartDeliveryStreamEncryption</code> and <code>StopDeliveryStreamEncryption</code>
            operations have a combined limit of 25 calls per delivery stream per 24 hours. For
            example, you reach the limit if you call <code>StartDeliveryStreamEncryption</code>
            13 times and <code>StopDeliveryStreamEncryption</code> 12 times for the same delivery
            stream in a 24-hour period.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StartKINFDeliveryStreamEncryptionCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream for which you want to enable server-side encryption
            (SSE).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StartKINFDeliveryStreamEncryptionCmdlet.DeliveryStreamEncryptionConfigurationInput_KeyARN">
            <summary>
            <para>
            <para>If you set <code>KeyType</code> to <code>CUSTOMER_MANAGED_CMK</code>, you must specify
            the Amazon Resource Name (ARN) of the CMK. If you set <code>KeyType</code> to <code>AWS_OWNED_CMK</code>,
            Kinesis Data Firehose uses a service-account CMK.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StartKINFDeliveryStreamEncryptionCmdlet.DeliveryStreamEncryptionConfigurationInput_KeyType">
            <summary>
            <para>
            <para>Indicates the type of customer master key (CMK) to use for encryption. The default
            setting is <code>AWS_OWNED_CMK</code>. For more information about CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer
            Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a>
            with <code>KeyType</code> set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes
            the Amazon KMS operation <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html">CreateGrant</a>
            to create a grant that allows the Kinesis Data Firehose service to use the customer
            managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that
            grant. </para><para>When you invoke <a>StartDeliveryStreamEncryption</a> to change the CMK for a delivery
            stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules
            the grant it had on the old CMK for retirement.</para><para>You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams.
            If a <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> operation
            exceeds this limit, Kinesis Data Firehose throws a <code>LimitExceededException</code>.
            </para><important><para>To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't
            support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see
            <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html">About
            Symmetric and Asymmetric CMKs</a> in the AWS Key Management Service developer guide.</para></important>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StartKINFDeliveryStreamEncryptionCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.StartDeliveryStreamEncryptionResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StartKINFDeliveryStreamEncryptionCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the DeliveryStreamName parameter.
            The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StartKINFDeliveryStreamEncryptionCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.StopKINFDeliveryStreamEncryptionCmdlet">
            <summary>
            Disables server-side encryption (SSE) for the delivery stream.
             
              
            <para>
            This operation is asynchronous. It returns immediately. When you invoke it, Kinesis
            Data Firehose first sets the encryption status of the stream to <code>DISABLING</code>,
            and then to <code>DISABLED</code>. You can continue to read and write data to your
            stream while its status is <code>DISABLING</code>. It can take up to 5 seconds after
            the encryption status changes to <code>DISABLED</code> before all records written
            to the delivery stream are no longer subject to encryption. To find out whether a
            record or a batch of records was encrypted, check the response elements <a>PutRecordOutput$Encrypted</a>
            and <a>PutRecordBatchOutput$Encrypted</a>, respectively.
            </para><para>
            To check the encryption state of a delivery stream, use <a>DescribeDeliveryStream</a>.
             
            </para><para>
            If SSE is enabled using a customer managed CMK and then you invoke <code>StopDeliveryStreamEncryption</code>,
            Kinesis Data Firehose schedules the related KMS grant for retirement and then retires
            it after it ensures that it is finished delivering records to the destination.
            </para><para>
            The <code>StartDeliveryStreamEncryption</code> and <code>StopDeliveryStreamEncryption</code>
            operations have a combined limit of 25 calls per delivery stream per 24 hours. For
            example, you reach the limit if you call <code>StartDeliveryStreamEncryption</code>
            13 times and <code>StopDeliveryStreamEncryption</code> 12 times for the same delivery
            stream in a 24-hour period.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StopKINFDeliveryStreamEncryptionCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream for which you want to disable server-side encryption
            (SSE).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StopKINFDeliveryStreamEncryptionCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.StopDeliveryStreamEncryptionResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StopKINFDeliveryStreamEncryptionCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the DeliveryStreamName parameter.
            The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.StopKINFDeliveryStreamEncryptionCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet">
            <summary>
            Updates the specified destination of the specified delivery stream.
             
              
            <para>
            Use this operation to change the destination type (for example, to replace the Amazon
            S3 destination with Amazon Redshift) or change the parameters associated with a destination
            (for example, to change the bucket name of the Amazon S3 destination). The update
            might not occur immediately. The target delivery stream remains active while the configurations
            are updated, so data writes to the delivery stream can continue during this process.
            The updated configurations are usually effective within a few minutes.
            </para><para>
            Switching between Amazon ES and other services is not supported. For an Amazon ES
            destination, you can only update to another Amazon ES destination.
            </para><para>
            If the destination type is the same, Kinesis Data Firehose merges the configuration
            parameters specified with the destination configuration that already exists on the
            delivery stream. If any of the parameters are not specified in the call, the existing
            values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a>
            is not specified, then the existing <code>EncryptionConfiguration</code> is maintained
            on the destination.
            </para><para>
            If the destination type is not the same, for example, changing the destination from
            Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters.
            In this case, all parameters must be specified.
            </para><para>
            Kinesis Data Firehose uses <code>CurrentDeliveryStreamVersionId</code> to avoid race
            conditions and conflicting merges. This is a required field, and the service updates
            the configuration only if the existing configuration has a version ID that matches.
            After the update is applied successfully, the version ID is updated, and can be retrieved
            using <a>DescribeDeliveryStream</a>. Use the new version ID to set <code>CurrentDeliveryStreamVersionId</code>
            in the next call.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_EndpointConfiguration_AccessKey">
            <summary>
            <para>
            <para>The access key required for Kinesis Firehose to authenticate with the HTTP endpoint
            selected as the destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ElasticsearchDestinationUpdate_ClusterEndpoint">
            <summary>
            <para>
            <para>The endpoint to use when communicating with the cluster. Specify either this <code>ClusterEndpoint</code>
            or the <code>DomainARN</code> field.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_RequestConfiguration_CommonAttributes">
            <summary>
            <para>
            <para>Describes the metadata sent to the HTTP endpoint destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_RequestConfiguration_ContentEncoding">
            <summary>
            <para>
            <para>Kinesis Data Firehose uses the content encoding to compress the body of a request
            before sending the request to the destination. For more information, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding">Content-Encoding</a>
            in MDN Web Docs, the official Mozilla documentation.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.CurrentDeliveryStreamVersionId">
            <summary>
            <para>
            <para>Obtain this value from the <code>VersionId</code> result of <a>DeliveryStreamDescription</a>.
            This value is required, and helps the service perform conditional operations. For
            example, if there is an interleaving update and this value is null, then the update
            destination fails. After the update is successful, the <code>VersionId</code> value
            is updated. The service then performs a merge of the old configuration with the new
            configuration.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.DestinationId">
            <summary>
            <para>
            <para>The ID of the destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ElasticsearchDestinationUpdate_DomainARN">
            <summary>
            <para>
            <para>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>,
            <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after
            assuming the IAM role specified in <code>RoleARN</code>. For more information, see
            <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            Resource Names (ARNs) and AWS Service Namespaces</a>.</para><para>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.RetryOptions_DurationInSecond">
            <summary>
            <para>
            <para>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.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_RetryOptions_DurationInSeconds">
            <summary>
            <para>
            <para>The total amount of time that Kinesis Data Firehose spends on retries. This duration
            starts after the initial attempt to send data to the custom destination via HTTPS
            endpoint fails. It doesn't include the periods during which Kinesis Data Firehose
            waits for acknowledgment from the specified destination after each attempt. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.CloudWatchLoggingOptions_Enabled">
            <summary>
            <para>
            <para>Enables or disables CloudWatch logging.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ProcessingConfiguration_Enabled">
            <summary>
            <para>
            <para>Enables or disables data processing.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_CloudWatchLoggingOptions_Enabled">
            <summary>
            <para>
            <para>Enables or disables CloudWatch logging.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_ProcessingConfiguration_Enabled">
            <summary>
            <para>
            <para>Enables or disables data processing.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ExtendedS3DestinationUpdate">
            <summary>
            <para>
            <para>Describes an update for a destination in Amazon S3.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ElasticsearchDestinationUpdate_IndexName">
            <summary>
            <para>
            <para>The Elasticsearch index name.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ElasticsearchDestinationUpdate_IndexRotationPeriod">
            <summary>
            <para>
            <para>The Elasticsearch index rotation period. Index rotation appends a timestamp to <code>IndexName</code>
            to facilitate the expiration of old data. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation">Index
            Rotation for the Amazon ES Destination</a>. Default value is <code>OneDay</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.BufferingHints_IntervalInSecond">
            <summary>
            <para>
            <para>Buffer incoming data for the specified period of time, in seconds, before delivering
            it to the destination. The default value is 300 (5 minutes).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_BufferingHints_IntervalInSeconds">
            <summary>
            <para>
            <para>Buffer incoming data for the specified period of time, in seconds, before delivering
            it to the destination. The default value is 300 (5 minutes). </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.CloudWatchLoggingOptions_LogGroupName">
            <summary>
            <para>
            <para>The CloudWatch group name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_CloudWatchLoggingOptions_LogGroupName">
            <summary>
            <para>
            <para>The CloudWatch group name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.CloudWatchLoggingOptions_LogStreamName">
            <summary>
            <para>
            <para>The CloudWatch log stream name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_CloudWatchLoggingOptions_LogStreamName">
            <summary>
            <para>
            <para>The CloudWatch log stream name for logging. This value is required if CloudWatch logging
            is enabled.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.EndpointConfiguration_Name">
            <summary>
            <para>
            <para>The name of the HTTP endpoint selected as the destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ProcessingConfiguration_Processor">
            <summary>
            <para>
            <para>The data processors.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_ProcessingConfiguration_Processors">
            <summary>
            <para>
            <para>The data processors.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.RedshiftDestinationUpdate">
            <summary>
            <para>
            <para>Describes an update for a destination in Amazon Redshift.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ElasticsearchDestinationUpdate_RoleARN">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
            for calling the Amazon ES Configuration API and for indexing documents. 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> and <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            Resource Names (ARNs) and AWS Service Namespaces</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_RoleARN">
            <summary>
            <para>
            <para>Kinesis Data Firehose uses this IAM role for all the permissions that the delivery
            stream needs.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_S3BackupMode">
            <summary>
            <para>
            <para>Describes the S3 bucket backup options for the data that Kinesis Firehose delivers
            to the HTTP endpoint destination. You can back up all documents (<code>AllData</code>)
            or only the documents that Kinesis Data Firehose could not deliver to the specified
            HTTP endpoint destination (<code>FailedDataOnly</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ElasticsearchDestinationUpdate_S3Update">
            <summary>
            <para>
            <para>The Amazon S3 destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_S3Update">
            <summary>
            <para>
            The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.BufferingHints_SizeInMBs">
            <summary>
            <para>
            <para>Buffer incoming data to the specified size, in MBs, before delivering it to the destination.
            The default value is 5.</para><para>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.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_BufferingHints_SizeInMBs">
            <summary>
            <para>
            <para>Buffer incoming data to the specified size, in MBs, before delivering it to the destination.
            The default value is 5. </para><para>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. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.SplunkDestinationUpdate">
            <summary>
            <para>
            <para>Describes an update for a destination in Splunk.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.ElasticsearchDestinationUpdate_TypeName">
            <summary>
            <para>
            <para>The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per
            index. If you try to specify a new type for an existing index that already has another
            type, Kinesis Data Firehose returns an error during runtime.</para><para>If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream,
            Kinesis Data Firehose still delivers data to Elasticsearch with the old index name
            and type name. If you want to update your delivery stream with a new index name, provide
            an empty string for <code>TypeName</code>. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_EndpointConfiguration_Url">
            <summary>
            <para>
            <para>The URL of the HTTP endpoint selected as the destination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.S3DestinationUpdate">
            <summary>
            <para>
            <para>[Deprecated] Describes an update for a destination in Amazon S3.</para>
            </para>
            <para>This parameter is deprecated.</para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.UpdateDestinationResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet">
            <summary>
            Writes multiple data records into a delivery stream in a single call, which can achieve
            higher throughput per producer than when writing single records. To write single data
            records into a delivery stream, use <a>PutRecord</a>. Applications using these operations
            are referred to as producers.
             
              
            <para>
            For information about service quota, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon
            Kinesis Data Firehose Quota</a>.
            </para><para>
            Each <a>PutRecordBatch</a> request supports up to 500 records. Each record in the
            request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB
            for the entire request. These limits cannot be changed.
            </para><para>
            You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>.
            The data record consists of a data blob that can be up to 1,000 KB in size, and any
            kind of data. For example, it could be a segment from a log file, geographic location
            data, website clickstream data, and so on.
            </para><para>
            Kinesis Data Firehose buffers records before delivering them to the destination. To
            disambiguate the data blobs at the destination, a common solution is to use delimiters
            in the data, such as a newline (<code>\n</code>) or some other character unique within
            the data. This allows the consumer application to parse individual data items when
            reading the data from the destination.
            </para><para>
            The <a>PutRecordBatch</a> response includes a count of failed records, <code>FailedPutCount</code>,
            and an array of responses, <code>RequestResponses</code>. Even if the <a>PutRecordBatch</a>
            call succeeds, the value of <code>FailedPutCount</code> may be greater than 0, indicating
            that there are records for which the operation didn't succeed. Each entry in the <code>RequestResponses</code>
            array provides additional information about the processed record. It directly correlates
            with a record in the request array using the same ordering, from the top to the bottom.
            The response array always includes the same number of records as the request array.
            <code>RequestResponses</code> includes both successfully and unsuccessfully processed
            records. Kinesis Data Firehose tries to process all records in each <a>PutRecordBatch</a>
            request. A single record failure does not stop the processing of subsequent records.
             
            </para><para>
            A successfully processed record includes a <code>RecordId</code> value, which is unique
            for the record. An unsuccessfully processed record includes <code>ErrorCode</code>
            and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of
            error, and is one of the following values: <code>ServiceUnavailableException</code>
            or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed
            information about the error.
            </para><para>
            If there is an internal server error or a timeout, the write might have completed
            or it might have failed. If <code>FailedPutCount</code> is greater than 0, retry the
            request, resending only those records that might have failed processing. This minimizes
            the possible duplicate records and also reduces the total bytes sent (and corresponding
            charges). We recommend that you handle any duplicates at the destination.
            </para><para>
            If <a>PutRecordBatch</a> throws <code>ServiceUnavailableException</code>, back off
            and retry. If the exception persists, it is possible that the throughput limits have
            been exceeded for the delivery stream.
            </para><para>
            Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they
            are added to a delivery stream as it attempts to send the records to the destination.
            If the destination is unreachable for more than 24 hours, the data is no longer available.
            </para><important><para>
            Don't concatenate two or more base64 strings to form the data fields of your records.
            Instead, concatenate the raw data, then perform base64 encoding.
            </para></important>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.DeliveryStreamName">
            <summary>
            <para>
            <para>The name of the delivery stream.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.Record">
            <summary>
            <para>
            <para>One or more records.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.PutRecordBatchResponse).
            Specifying the name of a property of type Amazon.KinesisFirehose.Model.PutRecordBatchResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Record parameter.
            The -PassThru parameter is deprecated, use -Select '^Record' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
    </members>
</doc>