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 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 Firehose Limits</a>. </para><para> Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. </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 KiB 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> 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 (<c>\n</c>) 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 <c>PutRecord</c> operation returns a <c>RecordId</c>, 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 <c>PutRecord</c> operation throws a <c>ServiceUnavailableException</c>, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </para><para> Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. </para><para> Data records sent to 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 Amazon Web Services 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>Amazon Web Services 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 <c>DescribeDeliveryStream</c> to see whether the delivery stream is <c>ACTIVE</c> and therefore ready for data to be sent to it. <para> If the status of a delivery stream is <c>CREATING_FAILED</c>, 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 <c>DELETING_FAILED</c>, 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. 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 <c>ListDeliveryStreams</c>. You can limit the number of delivery streams returned, using the <c>Limit</c> parameter. To determine whether there are more delivery streams to list, check the value of <c>HasMoreDeliveryStreams</c> in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the <c>ExclusiveStartDeliveryStreamName</c> 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><c>DirectPut</c>: Provider applications access the delivery stream directly.</para></li><li><para><c>KinesisStreamAsSource</c>: 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 <c>ListDeliveryStreams</c> will start with the delivery stream whose name comes alphabetically immediately after the name you specify in <c>ExclusiveStartDeliveryStreamName</c>.</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, <c>ListTagsForDeliveryStream</c> gets all tags that occur after <c>ExclusiveStartTagKey</c>.</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, <c>HasMoreTags</c> is set to <c>true</c> in the response. To list additional tags, set <c>ExclusiveStartTagKey</c> 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 Firehose delivery stream. <para> By default, you can create up to 50 delivery streams per Amazon Web Services Region. </para><para> This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <c>CREATING</c>. After the delivery stream is created, its status is <c>ACTIVE</c> and it now accepts data. If the delivery stream creation fails, the status transitions to <c>CREATING_FAILED</c>. Attempts to send data to a delivery stream that is not in the <c>ACTIVE</c> 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 <c>CREATING_FAILED</c>, this status doesn't change, and you can't invoke <c>CreateDeliveryStream</c> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it. </para><para> A 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 <c>DeliveryStreamType</c> parameter to <c>KinesisStreamAsSource</c>, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the <c>KinesisStreamSourceConfiguration</c> 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, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: <c>ExtendedS3DestinationConfiguration</c>, <c>S3DestinationConfiguration</c>, <c>ElasticsearchDestinationConfiguration</c>, <c>RedshiftDestinationConfiguration</c>, or <c>SplunkDestinationConfiguration</c>. </para><para> When you specify <c>S3DestinationConfiguration</c>, you can also provide the following optional values: BufferingHints, <c>EncryptionConfiguration</c>, and <c>CompressionFormat</c>. By default, if no <c>BufferingHints</c> value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. <c>BufferingHints</c> 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. Firehose first delivers data to Amazon S3 and then uses <c>COPY</c> syntax to load data into an Amazon Redshift table. This is specified in the <c>RedshiftDestinationConfiguration.S3Configuration</c> parameter. </para></li><li><para> The compression formats <c>SNAPPY</c> or <c>ZIP</c> cannot be specified in <c>RedshiftDestinationConfiguration.S3Configuration</c> because the Amazon Redshift <c>COPY</c> 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 Firehose, and that the permissions for the account are restricted for Amazon Redshift <c>INSERT</c> permissions. </para></li></ul><para> Firehose assumes the IAM role that is configured as part of the destination. The role should allow the 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 Firehose Access to an Amazon S3 Destination</a> in the <i>Amazon 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.SnowflakeDestinationConfiguration_AccountUrl"> <summary> <para> <para>URL for accessing your Snowflake account. This URL must include your <a href="https://docs.snowflake.com/en/user-guide/admin-account-identifier">account identifier</a>. Note that the protocol (https://) and port number are optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_ClusterEndpoint"> <summary> <para> <para>The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field. </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 <c>ClusterEndpoint</c> or the <c>DomainARN</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_CollectionEndpoint"> <summary> <para> <para>The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.</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.AuthenticationConfiguration_Connectivity"> <summary> <para> <para>The type of connectivity used to access the Amazon MSK cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_ContentColumnName"> <summary> <para> <para>The name of the record content column</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_RequestConfiguration_ContentEncoding"> <summary> <para> <para>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.SnowflakeDestinationConfiguration_Database"> <summary> <para> <para>All data in Snowflake is maintained in databases.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_DataLoadingOption"> <summary> <para> <para>Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_DocumentIdOptions_DefaultDocumentIdFormat"> <summary> <para> <para>When the <c>FIREHOSE_DEFAULT</c> option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.</para><para>When the <c>NO_DOCUMENT_ID</c> option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.DocumentIdOptions_DefaultDocumentIdFormat"> <summary> <para> <para>When the <c>FIREHOSE_DEFAULT</c> option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.</para><para>When the <c>NO_DOCUMENT_ID</c> option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.</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 Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.</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><c>DirectPut</c>: Provider applications access the delivery stream directly.</para></li><li><para><c>KinesisStreamAsSource</c>: 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.AmazonopensearchserviceDestinationConfiguration_DomainARN"> <summary> <para> <para>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. </para> </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 <c>DescribeDomain</c>, <c>DescribeDomains</c>, and <c>DescribeDomainConfig</c> 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 Amazon Web Services Service Namespaces</a>.</para><para>Specify either <c>ClusterEndpoint</c> or <c>DomainARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_RetryOptions_DurationInSeconds"> <summary> <para> <para>After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which 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.AmazonopensearchserviceDestinationConfiguration_RetryOptions_DurationInSeconds"> <summary> <para> <para>After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which 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.RetryOptions_DurationInSecond"> <summary> <para> <para>After an initial failure to deliver to Amazon ES, the total amount of time during which 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 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 Firehose waits for acknowledgment from the specified destination after each attempt. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_RetryOptions_DurationInSeconds"> <summary> <para> <para>the time period where Firehose will retry sending data to the chosen HTTP endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_CloudWatchLoggingOptions_Enabled"> <summary> <para> <para>Enables or disables CloudWatch logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_ProcessingConfiguration_Enabled"> <summary> <para> <para>Enables or disables data processing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_CloudWatchLoggingOptions_Enabled"> <summary> <para> <para>Enables or disables CloudWatch logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_ProcessingConfiguration_Enabled"> <summary> <para> <para>Enables or disables data processing.</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.SnowflakeDestinationConfiguration_CloudWatchLoggingOptions_Enabled"> <summary> <para> <para>Enables or disables CloudWatch logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_ProcessingConfiguration_Enabled"> <summary> <para> <para>Enables or disables data processing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeRoleConfiguration_Enabled"> <summary> <para> <para>Enable Snowflake role</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.AmazonOpenSearchServerlessDestinationConfiguration_IndexName"> <summary> <para> <para>The Serverless offering for Amazon OpenSearch Service index name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_IndexName"> <summary> <para> <para>The ElasticsearAmazon OpenSearch Service index name.</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.AmazonopensearchserviceDestinationConfiguration_IndexRotationPeriod"> <summary> <para> <para>The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.</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 <c>IndexName</c> 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 <c>OneDay</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_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.AmazonopensearchserviceDestinationConfiguration_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.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 <c>KeyType</c> to <c>CUSTOMER_MANAGED_CMK</c>, you must specify the Amazon Resource Name (ARN) of the CMK. If you set <c>KeyType</c> to <c>Amazon Web Services_OWNED_CMK</c>, Firehose uses a service-account CMK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_KeyPassphrase"> <summary> <para> <para>Passphrase to decrypt the private key when the key is encrypted. For information, see <a href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation">Using Key Pair Authentication & Key Rotation</a>.</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 <c>Amazon Web Services_OWNED_CMK</c>. 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 <c>KeyType</c> set to CUSTOMER_MANAGED_CMK, 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 Firehose service to use the customer managed CMK to perform encryption and decryption. 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, 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, Firehose throws a <c>LimitExceededException</c>. </para><important><para>To encrypt your delivery stream, use symmetric CMKs. 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 Amazon Web Services 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.AmazonOpenSearchServerlessDestinationConfiguration_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.AmazonopensearchserviceDestinationConfiguration_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_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.SnowflakeDestinationConfiguration_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.AmazonOpenSearchServerlessDestinationConfiguration_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.AmazonopensearchserviceDestinationConfiguration_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.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.SnowflakeDestinationConfiguration_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.SnowflakeDestinationConfiguration_MetaDataColumnName"> <summary> <para> <para>The name of the record metadata column</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.MSKSourceConfiguration_MSKClusterARN"> <summary> <para> <para>The ARN of the Amazon MSK cluster.</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.SnowflakeDestinationConfiguration_PrivateKey"> <summary> <para> <para>The private key used to encrypt your Snowflake client. For information, see <a href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation">Using Key Pair Authentication & Key Rotation</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeVpcConfiguration_PrivateLinkVpceId"> <summary> <para> <para>The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see <a href="https://docs.snowflake.com/en/user-guide/admin-security-privatelink">Amazon PrivateLink & Snowflake</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_ProcessingConfiguration_Processors"> <summary> <para> <para>The data processors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_ProcessingConfiguration_Processors"> <summary> <para> <para>The data processors.</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.SnowflakeDestinationConfiguration_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.AmazonOpenSearchServerlessDestinationConfiguration_RoleARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_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 Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:</para><ul><li><para><c>ec2:DescribeVpcs</c></para></li><li><para><c>ec2:DescribeVpcAttribute</c></para></li><li><para><c>ec2:DescribeSubnets</c></para></li><li><para><c>ec2:DescribeSecurityGroups</c></para></li><li><para><c>ec2:DescribeNetworkInterfaces</c></para></li><li><para><c>ec2:CreateNetworkInterface</c></para></li><li><para><c>ec2:CreateNetworkInterfacePermission</c></para></li><li><para><c>ec2:DeleteNetworkInterface</c></para></li></ul><important><para>When you specify subnets for delivering data to the destination in a private VPC, make sure you have enough number of free IP addresses in chosen subnets. If there is no available free IP address in a specified subnet, Firehose cannot create or add ENIs for the data delivery in the private VPC, and the delivery will be degraded or fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_RoleARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_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 Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:</para><ul><li><para><c>ec2:DescribeVpcs</c></para></li><li><para><c>ec2:DescribeVpcAttribute</c></para></li><li><para><c>ec2:DescribeSubnets</c></para></li><li><para><c>ec2:DescribeSecurityGroups</c></para></li><li><para><c>ec2:DescribeNetworkInterfaces</c></para></li><li><para><c>ec2:CreateNetworkInterface</c></para></li><li><para><c>ec2:CreateNetworkInterfacePermission</c></para></li><li><para><c>ec2:DeleteNetworkInterface</c></para></li></ul><important><para>When you specify subnets for delivering data to the destination in a private VPC, make sure you have enough number of free IP addresses in chosen subnets. If there is no available free IP address in a specified subnet, Firehose cannot create or add ENIs for the data delivery in the private VPC, and the delivery will be degraded or fail.</para></important> </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 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 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 Amazon Web Services 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 Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:</para><ul><li><para><c>ec2:DescribeVpcs</c></para></li><li><para><c>ec2:DescribeVpcAttribute</c></para></li><li><para><c>ec2:DescribeSubnets</c></para></li><li><para><c>ec2:DescribeSecurityGroups</c></para></li><li><para><c>ec2:DescribeNetworkInterfaces</c></para></li><li><para><c>ec2:CreateNetworkInterface</c></para></li><li><para><c>ec2:CreateNetworkInterfacePermission</c></para></li><li><para><c>ec2:DeleteNetworkInterface</c></para></li></ul><important><para>When you specify subnets for delivering data to the destination in a private VPC, make sure you have enough number of free IP addresses in chosen subnets. If there is no available free IP address in a specified subnet, Firehose cannot create or add ENIs for the data delivery in the private VPC, and the delivery will be degraded or fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.HttpEndpointDestinationConfiguration_RoleARN"> <summary> <para> <para>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">Amazon Web Services Identity and Access Management (IAM) ARN Format</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AuthenticationConfiguration_RoleARN"> <summary> <para> <para>The ARN of the role used to access the Amazon MSK cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_RoleARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Snowflake role</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_S3BackupMode"> <summary> <para> <para>Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_S3BackupMode"> <summary> <para> <para>Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. </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 <c>FailedDocumentsOnly</c>, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with <c>AmazonOpenSearchService-failed/</c> appended to the key prefix. When set to <c>AllDocuments</c>, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with <c>AmazonOpenSearchService-failed/</c> 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 <c>FailedDocumentsOnly</c>.</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 Firehose delivers to the HTTP endpoint destination. You can back up all documents (<c>AllData</c>) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (<c>FailedDataOnly</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_S3BackupMode"> <summary> <para> <para>Choose an S3 backup mode</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_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.AmazonopensearchserviceDestinationConfiguration_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.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.SnowflakeDestinationConfiguration_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.SnowflakeDestinationConfiguration_Schema"> <summary> <para> <para>Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonOpenSearchServerlessDestinationConfiguration_VpcConfiguration_SecurityGroupIds"> <summary> <para> <para>The IDs of the security groups that you want 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.AmazonopensearchserviceDestinationConfiguration_VpcConfiguration_SecurityGroupIds"> <summary> <para> <para>The IDs of the security groups that you want 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.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>The IDs of the security groups that you want 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.AmazonOpenSearchServerlessDestinationConfiguration_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.AmazonopensearchserviceDestinationConfiguration_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.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.SnowflakeRoleConfiguration_SnowflakeRole"> <summary> <para> <para>The Snowflake role you wish to configure</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.AmazonOpenSearchServerlessDestinationConfiguration_VpcConfiguration_SubnetIds"> <summary> <para> <para>The IDs of the subnets that you want 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. 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 Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable 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 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.AmazonopensearchserviceDestinationConfiguration_VpcConfiguration_SubnetIds"> <summary> <para> <para>The IDs of the subnets that you want 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. 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 Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable 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 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.VpcConfiguration_SubnetId"> <summary> <para> <para>The IDs of the subnets that you want 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. 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 Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable 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 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.SnowflakeDestinationConfiguration_Table"> <summary> <para> <para>All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.</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 Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User Guide.</para><para>You can specify up to 50 tags when creating a delivery stream.</para><para>If you specify tags in the <c>CreateDeliveryStream</c> action, Amazon Data Firehose performs an additional authorization on the <c>firehose:TagDeliveryStream</c> action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose delivery streams with IAM resource tags will fail with an <c>AccessDeniedException</c> such as following.</para><para><b>AccessDeniedException</b></para><para>User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.</para><para>For an example IAM policy, see <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples">Tag example.</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.MSKSourceConfiguration_TopicName"> <summary> <para> <para>The topic name within the Amazon MSK cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.AmazonopensearchserviceDestinationConfiguration_TypeName"> <summary> <para> <para>The Amazon OpenSearch Service 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, Firehose returns an error during run time. </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, Firehose returns an error during run time.</para><para>For Elasticsearch 7.x, don't specify a <c>TypeName</c>.</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><important><para>If you choose an HTTP endpoint as your destination, review and follow the instructions in the <a href="https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html">Appendix - HTTP Endpoint Delivery Request and Response Specifications</a>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.SnowflakeDestinationConfiguration_User"> <summary> <para> <para>User login name for the Snowflake account.</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> You can delete a delivery stream only if it is in one of the following states: <c>ACTIVE</c>, <c>DELETING</c>, <c>CREATING_FAILED</c>, or <c>DELETING_FAILED</c>. You can't delete a delivery stream that is in the <c>CREATING</c> state. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>. </para><para> DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the delivery stream is marked for deletion, and it goes into the <c>DELETING</c> state.While the delivery stream is in the <c>DELETING</c> 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><para> Removal of a delivery stream that is in the <c>DELETING</c> state is a low priority operation for the service. A stream may remain in the <c>DELETING</c> state for several minutes. Therefore, as a best practice, applications should not wait for streams in the <c>DELETING</c> state to be removed. </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 Firehose is unable to retire the grant for the CMK. 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 Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, 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, Firehose first sets the encryption status of the stream to <c>ENABLING</c>, and then to <c>ENABLED</c>. The encryption status of a delivery stream is the <c>Status</c> property in <a>DeliveryStreamEncryptionConfiguration</a>. If the operation fails, the encryption status changes to <c>ENABLING_FAILED</c>. You can continue to read and write data to your delivery stream while the encryption status is <c>ENABLING</c>, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to <c>ENABLED</c> 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 <c>CUSTOMER_MANAGED_CMK</c>, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type <c>CUSTOMER_MANAGED_CMK</c>, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant. </para><para> For the KMS grant creation to be successful, Firehose APIs <c>StartDeliveryStreamEncryption</c> and <c>CreateDeliveryStream</c> should not be called with session credentials that are more than 6 hours old. </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 <c>ENABLING_FAILED</c>, 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 <c>ENABLING_FAILED</c>, 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 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 <c>DirectPut</c> as its source. </para><para> The <c>StartDeliveryStreamEncryption</c> and <c>StopDeliveryStreamEncryption</c> operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call <c>StartDeliveryStreamEncryption</c> 13 times and <c>StopDeliveryStreamEncryption</c> 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 <c>KeyType</c> to <c>CUSTOMER_MANAGED_CMK</c>, you must specify the Amazon Resource Name (ARN) of the CMK. If you set <c>KeyType</c> to <c>Amazon Web Services_OWNED_CMK</c>, 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 <c>Amazon Web Services_OWNED_CMK</c>. 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 <c>KeyType</c> set to CUSTOMER_MANAGED_CMK, 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 Firehose service to use the customer managed CMK to perform encryption and decryption. 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, 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, Firehose throws a <c>LimitExceededException</c>. </para><important><para>To encrypt your delivery stream, use symmetric CMKs. 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 Amazon Web Services 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, Firehose first sets the encryption status of the stream to <c>DISABLING</c>, and then to <c>DISABLED</c>. You can continue to read and write data to your stream while its status is <c>DISABLING</c>. It can take up to 5 seconds after the encryption status changes to <c>DISABLED</c> 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 <c>StopDeliveryStreamEncryption</c>, 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 <c>StartDeliveryStreamEncryption</c> and <c>StopDeliveryStreamEncryption</c> operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call <c>StartDeliveryStreamEncryption</c> 13 times and <c>StopDeliveryStreamEncryption</c> 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 OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. </para><para> If the destination type is the same, 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 <c>EncryptionConfiguration</c> 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, Firehose does not merge any parameters. In this case, all parameters must be specified. </para><para> Firehose uses <c>CurrentDeliveryStreamVersionId</c> 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 <c>CurrentDeliveryStreamVersionId</c> 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.SnowflakeDestinationUpdate_AccountUrl"> <summary> <para> <para>URL for accessing your Snowflake account. This URL must include your <a href="https://docs.snowflake.com/en/user-guide/admin-account-identifier">account identifier</a>. Note that the protocol (https://) and port number are optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_ClusterEndpoint"> <summary> <para> <para>The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field. </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 <c>ClusterEndpoint</c> or the <c>DomainARN</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_CollectionEndpoint"> <summary> <para> <para>The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.</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.SnowflakeDestinationUpdate_ContentColumnName"> <summary> <para> <para>The name of the content metadata column</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_RequestConfiguration_ContentEncoding"> <summary> <para> <para>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 <c>VersionId</c> 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 <c>VersionId</c> 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.SnowflakeDestinationUpdate_Database"> <summary> <para> <para>All data in Snowflake is maintained in databases.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.SnowflakeDestinationUpdate_DataLoadingOption"> <summary> <para> <para> JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_DocumentIdOptions_DefaultDocumentIdFormat"> <summary> <para> <para>When the <c>FIREHOSE_DEFAULT</c> option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.</para><para>When the <c>NO_DOCUMENT_ID</c> option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.DocumentIdOptions_DefaultDocumentIdFormat"> <summary> <para> <para>When the <c>FIREHOSE_DEFAULT</c> option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.</para><para>When the <c>NO_DOCUMENT_ID</c> option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.</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.AmazonopensearchserviceDestinationUpdate_DomainARN"> <summary> <para> <para>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.</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 <c>DescribeDomain</c>, <c>DescribeDomains</c>, and <c>DescribeDomainConfig</c> after assuming the IAM role specified in <c>RoleARN</c>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</para><para>Specify either <c>ClusterEndpoint</c> or <c>DomainARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_RetryOptions_DurationInSeconds"> <summary> <para> <para>After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which 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.AmazonopensearchserviceDestinationUpdate_RetryOptions_DurationInSeconds"> <summary> <para> <para>After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which 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.RetryOptions_DurationInSecond"> <summary> <para> <para>After an initial failure to deliver to Amazon ES, the total amount of time during which 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 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 Firehose waits for acknowledgment from the specified destination after each attempt. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.SnowflakeDestinationConfiguration_RetryOptions_DurationInSeconds"> <summary> <para> <para>the time period where Firehose will retry sending data to the chosen HTTP endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_CloudWatchLoggingOptions_Enabled"> <summary> <para> <para>Enables or disables CloudWatch logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_ProcessingConfiguration_Enabled"> <summary> <para> <para>Enables or disables data processing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_CloudWatchLoggingOptions_Enabled"> <summary> <para> <para>Enables or disables CloudWatch logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_ProcessingConfiguration_Enabled"> <summary> <para> <para>Enables or disables data processing.</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.SnowflakeDestinationConfiguration_CloudWatchLoggingOptions_Enabled"> <summary> <para> <para>Enables or disables CloudWatch logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.SnowflakeDestinationConfiguration_ProcessingConfiguration_Enabled"> <summary> <para> <para>Enables or disables data processing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.SnowflakeRoleConfiguration_Enabled"> <summary> <para> <para>Enable Snowflake role</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.AmazonOpenSearchServerlessDestinationUpdate_IndexName"> <summary> <para> <para>The Serverless offering for Amazon OpenSearch Service index name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_IndexName"> <summary> <para> <para>The Amazon OpenSearch Service index name.</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.AmazonopensearchserviceDestinationUpdate_IndexRotationPeriod"> <summary> <para> <para>The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.</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 <c>IndexName</c> 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 <c>OneDay</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_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.AmazonopensearchserviceDestinationUpdate_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.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.SnowflakeDestinationUpdate_KeyPassphrase"> <summary> <para> <para>Passphrase to decrypt the private key when the key is encrypted. For information, see <a href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation">Using Key Pair Authentication & Key Rotation</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_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.AmazonopensearchserviceDestinationUpdate_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_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.SnowflakeDestinationConfiguration_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.AmazonOpenSearchServerlessDestinationUpdate_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.AmazonopensearchserviceDestinationUpdate_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.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.SnowflakeDestinationConfiguration_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.SnowflakeDestinationUpdate_MetaDataColumnName"> <summary> <para> <para>The name of the record metadata column</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.SnowflakeDestinationUpdate_PrivateKey"> <summary> <para> <para>The private key used to encrypt your Snowflake client. For information, see <a href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation">Using Key Pair Authentication & Key Rotation</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_ProcessingConfiguration_Processors"> <summary> <para> <para>The data processors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_ProcessingConfiguration_Processors"> <summary> <para> <para>The data processors.</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.SnowflakeDestinationConfiguration_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.AmazonOpenSearchServerlessDestinationUpdate_RoleARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_RoleARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. </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 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 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 Amazon Web Services Service Namespaces</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.HttpEndpointDestinationUpdate_RoleARN"> <summary> <para> <para>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.SnowflakeDestinationUpdate_RoleARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Snowflake role</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 (<c>AllData</c>) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (<c>FailedDataOnly</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.SnowflakeDestinationUpdate_S3BackupMode"> <summary> <para> <para>Choose an S3 backup mode</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_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.AmazonopensearchserviceDestinationUpdate_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.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.SnowflakeDestinationUpdate_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.SnowflakeDestinationUpdate_Schema"> <summary> <para> <para>Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonOpenSearchServerlessDestinationUpdate_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.AmazonopensearchserviceDestinationUpdate_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.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.SnowflakeRoleConfiguration_SnowflakeRole"> <summary> <para> <para>The Snowflake role you wish to configure</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.SnowflakeDestinationUpdate_Table"> <summary> <para> <para>All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.AmazonopensearchserviceDestinationUpdate_TypeName"> <summary> <para> <para>The Amazon OpenSearch Service 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, 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, 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 TypeName. </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, 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, 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 <c>TypeName</c>. </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><important><para>If you choose an HTTP endpoint as your destination, review and follow the instructions in the <a href="https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html">Appendix - HTTP Endpoint Delivery Request and Response Specifications</a>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.SnowflakeDestinationUpdate_User"> <summary> <para> <para>User login name for the Snowflake account.</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> Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. </para><para> For information about service quota, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon 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 base64 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> 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 (<c>\n</c>) 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, <c>FailedPutCount</c>, and an array of responses, <c>RequestResponses</c>. Even if the <a>PutRecordBatch</a> call succeeds, the value of <c>FailedPutCount</c> may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the <c>RequestResponses</c> 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. <c>RequestResponses</c> includes both successfully and unsuccessfully processed records. 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 <c>RecordId</c> value, which is unique for the record. An unsuccessfully processed record includes <c>ErrorCode</c> and <c>ErrorMessage</c> values. <c>ErrorCode</c> reflects the type of error, and is one of the following values: <c>ServiceUnavailableException</c> or <c>InternalFailure</c>. <c>ErrorMessage</c> 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 <c>FailedPutCount</c> 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 <c>ServiceUnavailableException</c>, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </para><para> Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. </para><para> Data records sent to 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> |