VaporShell.KinesisFirehose.psm1
|
# PSM1 Contents function Format-Json { [CmdletBinding()] Param ( [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)] [String] $Json ) Begin { $cleaner = { param([String]$Line) Process{ [Regex]::Replace( $Line, "\\u(?<Value>[a-zA-Z0-9]{4})", { param($m)([char]([int]::Parse( $m.Groups['Value'].Value, [System.Globalization.NumberStyles]::HexNumber ))).ToString() } ) } } } Process { if ($PSVersionTable.PSVersion.Major -lt 6) { try { $indent = 0; $res = $Json -split '\n' | ForEach-Object { if ($_ -match '[\}\]]') { # This line contains ] or }, decrement the indentation level $indent-- } $line = (' ' * $indent * 2) + $_.TrimStart().Replace(': ', ': ') if ($_ -match '[\{\[]') { # This line contains [ or {, increment the indentation level $indent++ } $cleaner.Invoke($line) } $res -join "`n" } catch { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } else { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } } function Get-TrueCount { Param ( [parameter(Mandatory = $false,Position = 0,ValueFromPipeline = $true)] $Array ) Process { if ($array) { if ($array.Count) { $count = $array.Count } else { $count = 1 } } else { $count = 0 } } End { return $count } } function New-VSError { <# .SYNOPSIS Error generator function to use in tandem with $PSCmdlet.ThrowTerminatingError() .PARAMETER Result Allows input of an error from AWS SDK, resulting in the Exception message being parsed out. .PARAMETER String Used to create basic String message errors in the same wrapper #> [cmdletbinding(DefaultParameterSetName="Result")] param( [parameter(Position=0,ParameterSetName="Result")] $Result, [parameter(Position=0,ParameterSetName="String")] $String ) switch ($PSCmdlet.ParameterSetName) { Result { $Exception = "$($result.Exception.InnerException.Message)" } String { $Exception = "$String" } } $e = New-Object "System.Exception" $Exception $errorRecord = New-Object 'System.Management.Automation.ErrorRecord' $e, $null, ([System.Management.Automation.ErrorCategory]::InvalidOperation), $null return $errorRecord } function ResolveS3Endpoint { <# .SYNOPSIS Resolves the S3 endpoint most appropriate for each region. #> Param ( [parameter(Mandatory=$true,Position=0)] [ValidateSet("eu-west-2","ap-south-1","us-east-2","sa-east-1","us-west-1","us-west-2","eu-west-1","ap-southeast-2","ca-central-1","ap-northeast-2","us-east-1","eu-central-1","ap-southeast-1","ap-northeast-1")] [String] $Region ) $endpointMap = @{ "us-east-2" = "s3.us-east-2.amazonaws.com" "us-east-1" = "s3.amazonaws.com" "us-west-1" = "s3-us-west-1.amazonaws.com" "us-west-2" = "s3-us-west-2.amazonaws.com" "ca-central-1" = "s3.ca-central-1.amazonaws.com" "ap-south-1" = "s3.ap-south-1.amazonaws.com" "ap-northeast-2" = "s3.ap-northeast-2.amazonaws.com" "ap-southeast-1" = "s3-ap-southeast-1.amazonaws.com" "ap-southeast-2" = "s3-ap-southeast-2.amazonaws.com" "ap-northeast-1" = "s3-ap-northeast-1.amazonaws.com" "eu-central-1" = "s3.eu-central-1.amazonaws.com" "eu-west-1" = "s3-eu-west-1.amazonaws.com" "eu-west-2" = "s3.eu-west-2.amazonaws.com" "sa-east-1" = "s3-sa-east-1.amazonaws.com" } return $endpointMap[$Region] } function Add-VSKinesisFirehoseDeliveryStreamBufferingHints { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.BufferingHints resource property to the template. The BufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data before delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.BufferingHints resource property to the template. The BufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data before delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html .PARAMETER IntervalInSeconds The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the IntervalInSeconds content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds UpdateType: Mutable PrimitiveType: Integer .PARAMETER SizeInMBs The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the SizeInMBs content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamBufferingHints])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IntervalInSeconds, [parameter(Mandatory = $false)] [object] $SizeInMBs ) Process { $obj = [KinesisFirehoseDeliveryStreamBufferingHints]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamBufferingHints' function Add-VSKinesisFirehoseDeliveryStreamCloudWatchLoggingOptions { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions resource property to the template. The CloudWatchLoggingOptions property type specifies Amazon CloudWatch Logs (CloudWatch Logs logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses for the delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions resource property to the template. The CloudWatchLoggingOptions property type specifies Amazon CloudWatch Logs (CloudWatch Logs logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses for the delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html .PARAMETER Enabled Indicates whether CloudWatch Logs logging is enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER LogGroupName The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use. Conditional. If you enable logging, you must specify this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname UpdateType: Mutable PrimitiveType: String .PARAMETER LogStreamName The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery. Conditional. If you enable logging, you must specify this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamCloudWatchLoggingOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] [object] $LogGroupName, [parameter(Mandatory = $false)] [object] $LogStreamName ) Process { $obj = [KinesisFirehoseDeliveryStreamCloudWatchLoggingOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamCloudWatchLoggingOptions' function Add-VSKinesisFirehoseDeliveryStreamCopyCommand { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.CopyCommand resource property to the template. The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.CopyCommand resource property to the template. The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html .PARAMETER CopyOptions Parameters to use with the Amazon Redshift COPY command. For examples, see the CopyOptions content for the CopyCommand: https://docs.aws.amazon.com/firehose/latest/APIReference/API_CopyCommand.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions UpdateType: Mutable PrimitiveType: String .PARAMETER DataTableColumns A comma-separated list of column names. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns UpdateType: Mutable PrimitiveType: String .PARAMETER DataTableName The name of the target table. The table must already exist in the database. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablename UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamCopyCommand])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CopyOptions, [parameter(Mandatory = $false)] [object] $DataTableColumns, [parameter(Mandatory = $true)] [object] $DataTableName ) Process { $obj = [KinesisFirehoseDeliveryStreamCopyCommand]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamCopyCommand' function Add-VSKinesisFirehoseDeliveryStreamDataFormatConversionConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration resource property to the template. Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion: https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration resource property to the template. Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion: https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html .PARAMETER Enabled Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-enabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER InputFormatConfiguration Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-inputformatconfiguration UpdateType: Mutable Type: InputFormatConfiguration .PARAMETER OutputFormatConfiguration Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-outputformatconfiguration UpdateType: Mutable Type: OutputFormatConfiguration .PARAMETER SchemaConfiguration Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-schemaconfiguration UpdateType: Mutable Type: SchemaConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamDataFormatConversionConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] $InputFormatConfiguration, [parameter(Mandatory = $false)] $OutputFormatConfiguration, [parameter(Mandatory = $false)] $SchemaConfiguration ) Process { $obj = [KinesisFirehoseDeliveryStreamDataFormatConversionConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamDataFormatConversionConfiguration' function Add-VSKinesisFirehoseDeliveryStreamDeliveryStreamEncryptionConfigurationInput { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.DeliveryStreamEncryptionConfigurationInput resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.DeliveryStreamEncryptionConfigurationInput resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html .PARAMETER KeyARN Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn UpdateType: Mutable PrimitiveType: String .PARAMETER KeyType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keytype UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamDeliveryStreamEncryptionConfigurationInput])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $KeyARN, [parameter(Mandatory = $true)] [object] $KeyType ) Process { $obj = [KinesisFirehoseDeliveryStreamDeliveryStreamEncryptionConfigurationInput]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamDeliveryStreamEncryptionConfigurationInput' function Add-VSKinesisFirehoseDeliveryStreamDeserializer { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.Deserializer resource property to the template. The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe: https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON and the OpenX JSON SerDe: https://github.com/rcongiu/Hive-JSON-Serde. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.Deserializer resource property to the template. The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe: https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON and the OpenX JSON SerDe: https://github.com/rcongiu/Hive-JSON-Serde. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html .PARAMETER HiveJsonSerDe The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde UpdateType: Mutable Type: HiveJsonSerDe .PARAMETER OpenXJsonSerDe The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde UpdateType: Mutable Type: OpenXJsonSerDe .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamDeserializer])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $HiveJsonSerDe, [parameter(Mandatory = $false)] $OpenXJsonSerDe ) Process { $obj = [KinesisFirehoseDeliveryStreamDeserializer]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamDeserializer' function Add-VSKinesisFirehoseDeliveryStreamDynamicPartitioningConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.DynamicPartitioningConfiguration resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.DynamicPartitioningConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.html .PARAMETER Enabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.html#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-enabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER RetryOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.html#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-retryoptions UpdateType: Mutable Type: RetryOptions .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamDynamicPartitioningConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] $RetryOptions ) Process { $obj = [KinesisFirehoseDeliveryStreamDynamicPartitioningConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamDynamicPartitioningConfiguration' function Add-VSKinesisFirehoseDeliveryStreamElasticsearchBufferingHints { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints resource property to the template. The ElasticsearchBufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data while delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints resource property to the template. The ElasticsearchBufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data while delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. ElasticsearchBufferingHints is the property type for the BufferingHints property of the Amazon Kinesis Data Firehose DeliveryStream ElasticsearchDestinationConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html .PARAMETER IntervalInSeconds The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the IntervalInSeconds content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds UpdateType: Mutable PrimitiveType: Integer .PARAMETER SizeInMBs The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the SizeInMBs content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamElasticsearchBufferingHints])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IntervalInSeconds, [parameter(Mandatory = $false)] [object] $SizeInMBs ) Process { $obj = [KinesisFirehoseDeliveryStreamElasticsearchBufferingHints]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamElasticsearchBufferingHints' function Add-VSKinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration resource property to the template. The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data to. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration resource property to the template. The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data to. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html .PARAMETER BufferingHints Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints UpdateType: Mutable Type: ElasticsearchBufferingHints .PARAMETER CloudWatchLoggingOptions The Amazon CloudWatch Logs logging options for the delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions UpdateType: Mutable Type: CloudWatchLoggingOptions .PARAMETER DomainARN The Amazon Resource Name ARN of the Amazon ES domain that Kinesis Data Firehose delivers data to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn UpdateType: Mutable PrimitiveType: String .PARAMETER IndexName The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname UpdateType: Mutable PrimitiveType: String .PARAMETER IndexRotationPeriod The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination: https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation in the *Amazon Kinesis Data Firehose Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod UpdateType: Mutable PrimitiveType: String .PARAMETER ProcessingConfiguration The data processing configuration for the Kinesis Data Firehose delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration UpdateType: Mutable Type: ProcessingConfiguration .PARAMETER RetryOptions The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions UpdateType: Mutable Type: ElasticsearchRetryOptions .PARAMETER RoleARN The Amazon Resource Name ARN of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn UpdateType: Mutable PrimitiveType: String .PARAMETER S3BackupMode The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service Amazon S3. You can send Amazon S3 all documents all data or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationConfiguration.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode UpdateType: Mutable PrimitiveType: String .PARAMETER S3Configuration The S3 bucket where Kinesis Data Firehose backs up incoming data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration UpdateType: Mutable Type: S3DestinationConfiguration .PARAMETER ClusterEndpoint *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-clusterendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER TypeName The Elasticsearch type name that Amazon ES adds to documents when indexing data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename UpdateType: Mutable PrimitiveType: String .PARAMETER VpcConfiguration *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-vpcconfiguration UpdateType: Immutable Type: VpcConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $BufferingHints, [parameter(Mandatory = $false)] $CloudWatchLoggingOptions, [parameter(Mandatory = $false)] [object] $DomainARN, [parameter(Mandatory = $true)] [object] $IndexName, [parameter(Mandatory = $false)] [object] $IndexRotationPeriod, [parameter(Mandatory = $false)] $ProcessingConfiguration, [parameter(Mandatory = $false)] $RetryOptions, [parameter(Mandatory = $true)] [object] $RoleARN, [parameter(Mandatory = $false)] [object] $S3BackupMode, [parameter(Mandatory = $true)] $S3Configuration, [parameter(Mandatory = $false)] [object] $ClusterEndpoint, [parameter(Mandatory = $false)] [object] $TypeName, [parameter(Mandatory = $false)] $VpcConfiguration ) Process { $obj = [KinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration' function Add-VSKinesisFirehoseDeliveryStreamElasticsearchRetryOptions { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions resource property to the template. The ElasticsearchRetryOptions property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose can't deliver data to Amazon Elasticsearch Service (Amazon ES. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions resource property to the template. The ElasticsearchRetryOptions property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose can't deliver data to Amazon Elasticsearch Service (Amazon ES. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html .PARAMETER DurationInSeconds After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery including the first attempt. If Kinesis Data Firehose can't deliver the data within the specified time, it writes the data to the backup S3 bucket. For valid values, see the DurationInSeconds content for the ElasticsearchRetryOptions: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamElasticsearchRetryOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $DurationInSeconds ) Process { $obj = [KinesisFirehoseDeliveryStreamElasticsearchRetryOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamElasticsearchRetryOptions' function Add-VSKinesisFirehoseDeliveryStreamEncryptionConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration resource property to the template. The EncryptionConfiguration property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses when delivering data to Amazon Simple Storage Service (Amazon S3. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration resource property to the template. The EncryptionConfiguration property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses when delivering data to Amazon Simple Storage Service (Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html .PARAMETER KMSEncryptionConfig The AWS Key Management Service AWS KMS encryption key that Amazon S3 uses to encrypt your data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig UpdateType: Mutable Type: KMSEncryptionConfig .PARAMETER NoEncryptionConfig Disables encryption. For valid values, see the NoEncryptionConfig content for the EncryptionConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_EncryptionConfiguration.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamEncryptionConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $KMSEncryptionConfig, [parameter(Mandatory = $false)] [object] $NoEncryptionConfig ) Process { $obj = [KinesisFirehoseDeliveryStreamEncryptionConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamEncryptionConfiguration' function Add-VSKinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration resource property to the template. The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration resource property to the template. The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html .PARAMETER BucketARN The Amazon Resource Name ARN of the Amazon S3 bucket. For constraints, see ExtendedS3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn UpdateType: Mutable PrimitiveType: String .PARAMETER BufferingHints The buffering option. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints UpdateType: Mutable Type: BufferingHints .PARAMETER CloudWatchLoggingOptions The Amazon CloudWatch logging options for your delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions UpdateType: Mutable Type: CloudWatchLoggingOptions .PARAMETER CompressionFormat The compression format. If no value is specified, the default is UNCOMPRESSED. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat UpdateType: Mutable PrimitiveType: String .PARAMETER DataFormatConversionConfiguration The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dataformatconversionconfiguration UpdateType: Mutable Type: DataFormatConversionConfiguration .PARAMETER DynamicPartitioningConfiguration *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dynamicpartitioningconfiguration UpdateType: Mutable Type: DynamicPartitioningConfiguration .PARAMETER EncryptionConfiguration The encryption configuration for the Kinesis Data Firehose delivery stream. The default value is NoEncryption. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration UpdateType: Mutable Type: EncryptionConfiguration .PARAMETER ErrorOutputPrefix A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-erroroutputprefix UpdateType: Mutable PrimitiveType: String .PARAMETER Prefix The YYYY/MM/DD/HH time format prefix is automatically used for delivered Amazon S3 files. For more information, see ExtendedS3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix UpdateType: Mutable PrimitiveType: String .PARAMETER ProcessingConfiguration The data processing configuration for the Kinesis Data Firehose delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration UpdateType: Mutable Type: ProcessingConfiguration .PARAMETER RoleARN The Amazon Resource Name ARN of the AWS credentials. For constraints, see ExtendedS3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn UpdateType: Mutable PrimitiveType: String .PARAMETER S3BackupConfiguration The configuration for backup in Amazon S3. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration UpdateType: Mutable Type: S3DestinationConfiguration .PARAMETER S3BackupMode The Amazon S3 backup mode. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $BucketARN, [parameter(Mandatory = $false)] $BufferingHints, [parameter(Mandatory = $false)] $CloudWatchLoggingOptions, [parameter(Mandatory = $false)] [object] $CompressionFormat, [parameter(Mandatory = $false)] $DataFormatConversionConfiguration, [parameter(Mandatory = $false)] $DynamicPartitioningConfiguration, [parameter(Mandatory = $false)] $EncryptionConfiguration, [parameter(Mandatory = $false)] [object] $ErrorOutputPrefix, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $false)] $ProcessingConfiguration, [parameter(Mandatory = $true)] [object] $RoleARN, [parameter(Mandatory = $false)] $S3BackupConfiguration, [parameter(Mandatory = $false)] [object] $S3BackupMode ) Process { $obj = [KinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration' function Add-VSKinesisFirehoseDeliveryStreamHiveJsonSerDe { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe resource property to the template. The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe resource property to the template. The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html .PARAMETER TimestampFormats Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat: https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html#cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamHiveJsonSerDe])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $TimestampFormats ) Process { $obj = [KinesisFirehoseDeliveryStreamHiveJsonSerDe]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamHiveJsonSerDe' function Add-VSKinesisFirehoseDeliveryStreamHttpEndpointCommonAttribute { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointCommonAttribute resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointCommonAttribute resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html .PARAMETER AttributeName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributename UpdateType: Mutable PrimitiveType: String .PARAMETER AttributeValue Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributevalue UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamHttpEndpointCommonAttribute])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $AttributeName, [parameter(Mandatory = $true)] [object] $AttributeValue ) Process { $obj = [KinesisFirehoseDeliveryStreamHttpEndpointCommonAttribute]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamHttpEndpointCommonAttribute' function Add-VSKinesisFirehoseDeliveryStreamHttpEndpointConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointConfiguration resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html .PARAMETER Url Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-url UpdateType: Mutable PrimitiveType: String .PARAMETER AccessKey Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-accesskey UpdateType: Mutable PrimitiveType: String .PARAMETER Name Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-name UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamHttpEndpointConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Url, [parameter(Mandatory = $false)] [object] $AccessKey, [parameter(Mandatory = $false)] [object] $Name ) Process { $obj = [KinesisFirehoseDeliveryStreamHttpEndpointConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamHttpEndpointConfiguration' function Add-VSKinesisFirehoseDeliveryStreamHttpEndpointDestinationConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointDestinationConfiguration resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointDestinationConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html .PARAMETER RoleARN Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-rolearn UpdateType: Mutable PrimitiveType: String .PARAMETER EndpointConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-endpointconfiguration UpdateType: Mutable Type: HttpEndpointConfiguration .PARAMETER RequestConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-requestconfiguration UpdateType: Mutable Type: HttpEndpointRequestConfiguration .PARAMETER BufferingHints Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-bufferinghints UpdateType: Mutable Type: BufferingHints .PARAMETER CloudWatchLoggingOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-cloudwatchloggingoptions UpdateType: Mutable Type: CloudWatchLoggingOptions .PARAMETER ProcessingConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-processingconfiguration UpdateType: Mutable Type: ProcessingConfiguration .PARAMETER RetryOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-retryoptions UpdateType: Mutable Type: RetryOptions .PARAMETER S3BackupMode Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3backupmode UpdateType: Mutable PrimitiveType: String .PARAMETER S3Configuration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3configuration UpdateType: Mutable Type: S3DestinationConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamHttpEndpointDestinationConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $RoleARN, [parameter(Mandatory = $true)] $EndpointConfiguration, [parameter(Mandatory = $false)] $RequestConfiguration, [parameter(Mandatory = $false)] $BufferingHints, [parameter(Mandatory = $false)] $CloudWatchLoggingOptions, [parameter(Mandatory = $false)] $ProcessingConfiguration, [parameter(Mandatory = $false)] $RetryOptions, [parameter(Mandatory = $false)] [object] $S3BackupMode, [parameter(Mandatory = $true)] $S3Configuration ) Process { $obj = [KinesisFirehoseDeliveryStreamHttpEndpointDestinationConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamHttpEndpointDestinationConfiguration' function Add-VSKinesisFirehoseDeliveryStreamHttpEndpointRequestConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointRequestConfiguration resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.HttpEndpointRequestConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html .PARAMETER ContentEncoding Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-contentencoding UpdateType: Mutable PrimitiveType: String .PARAMETER CommonAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-commonattributes UpdateType: Mutable Type: List ItemType: HttpEndpointCommonAttribute DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamHttpEndpointRequestConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContentEncoding, [parameter(Mandatory = $false)] [object] $CommonAttributes ) Process { $obj = [KinesisFirehoseDeliveryStreamHttpEndpointRequestConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamHttpEndpointRequestConfiguration' function Add-VSKinesisFirehoseDeliveryStreamInputFormatConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration resource property to the template. Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration resource property to the template. Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html .PARAMETER Deserializer Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-inputformatconfiguration-deserializer UpdateType: Mutable Type: Deserializer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamInputFormatConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Deserializer ) Process { $obj = [KinesisFirehoseDeliveryStreamInputFormatConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamInputFormatConfiguration' function Add-VSKinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration resource property to the template. The KinesisStreamSourceConfiguration property type specifies the stream and role Amazon Resource Names (ARNs for a Kinesis stream used as the source for a delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration resource property to the template. The KinesisStreamSourceConfiguration property type specifies the stream and role Amazon Resource Names (ARNs for a Kinesis stream used as the source for a delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html .PARAMETER KinesisStreamARN The ARN of the source Kinesis data stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn UpdateType: Immutable PrimitiveType: String .PARAMETER RoleARN The ARN of the role that provides access to the source Kinesis data stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $KinesisStreamARN, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration' function Add-VSKinesisFirehoseDeliveryStreamKMSEncryptionConfig { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig resource property to the template. The KMSEncryptionConfig property type specifies the AWS Key Management Service (AWS KMS encryption key that Amazon Simple Storage Service (Amazon S3 uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig resource property to the template. The KMSEncryptionConfig property type specifies the AWS Key Management Service (AWS KMS encryption key that Amazon Simple Storage Service (Amazon S3 uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html .PARAMETER AWSKMSKeyARN The Amazon Resource Name ARN of the AWS KMS encryption key that Amazon S3 uses to encrypt data delivered by the Kinesis Data Firehose stream. The key must belong to the same region as the destination S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamKMSEncryptionConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $AWSKMSKeyARN ) Process { $obj = [KinesisFirehoseDeliveryStreamKMSEncryptionConfig]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamKMSEncryptionConfig' function Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe resource property to the template. The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe resource property to the template. The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html .PARAMETER CaseInsensitive When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive UpdateType: Mutable PrimitiveType: Boolean .PARAMETER ColumnToJsonKeyMappings Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-columntojsonkeymappings UpdateType: Mutable Type: Map PrimitiveItemType: String .PARAMETER ConvertDotsInJsonKeysToUnderscores When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option. The default is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-convertdotsinjsonkeystounderscores UpdateType: Mutable PrimitiveType: Boolean .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamOpenXJsonSerDe])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CaseInsensitive, [parameter(Mandatory = $false)] [IDictionary] $ColumnToJsonKeyMappings, [parameter(Mandatory = $false)] [object] $ConvertDotsInJsonKeysToUnderscores ) Process { $obj = [KinesisFirehoseDeliveryStreamOpenXJsonSerDe]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe' function Add-VSKinesisFirehoseDeliveryStreamOrcSerDe { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.OrcSerDe resource property to the template. A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC: https://orc.apache.org/docs/. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.OrcSerDe resource property to the template. A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC: https://orc.apache.org/docs/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html .PARAMETER BlockSizeBytes The Hadoop Distributed File System HDFS block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes UpdateType: Mutable PrimitiveType: Integer .PARAMETER BloomFilterColumns The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .PARAMETER BloomFilterFalsePositiveProbability The Bloom filter false positive probability FPP. The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability UpdateType: Mutable PrimitiveType: Double .PARAMETER Compression The compression code to use over data blocks. The default is SNAPPY. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-compression UpdateType: Mutable PrimitiveType: String .PARAMETER DictionaryKeyThreshold Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold UpdateType: Mutable PrimitiveType: Double .PARAMETER EnablePadding Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-enablepadding UpdateType: Mutable PrimitiveType: Boolean .PARAMETER FormatVersion The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-formatversion UpdateType: Mutable PrimitiveType: String .PARAMETER PaddingTolerance A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size. For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task. Kinesis Data Firehose ignores this parameter when EnablePadding is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance UpdateType: Mutable PrimitiveType: Double .PARAMETER RowIndexStride The number of rows between index entries. The default is 10,000 and the minimum is 1,000. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride UpdateType: Mutable PrimitiveType: Integer .PARAMETER StripeSizeBytes The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamOrcSerDe])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $BlockSizeBytes, [parameter(Mandatory = $false)] $BloomFilterColumns, [parameter(Mandatory = $false)] [object] $BloomFilterFalsePositiveProbability, [parameter(Mandatory = $false)] [object] $Compression, [parameter(Mandatory = $false)] [object] $DictionaryKeyThreshold, [parameter(Mandatory = $false)] [object] $EnablePadding, [parameter(Mandatory = $false)] [object] $FormatVersion, [parameter(Mandatory = $false)] [object] $PaddingTolerance, [parameter(Mandatory = $false)] [object] $RowIndexStride, [parameter(Mandatory = $false)] [object] $StripeSizeBytes ) Process { $obj = [KinesisFirehoseDeliveryStreamOrcSerDe]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamOrcSerDe' function Add-VSKinesisFirehoseDeliveryStreamOutputFormatConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration resource property to the template. Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration resource property to the template. Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html .PARAMETER Serializer Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-outputformatconfiguration-serializer UpdateType: Mutable Type: Serializer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamOutputFormatConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Serializer ) Process { $obj = [KinesisFirehoseDeliveryStreamOutputFormatConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamOutputFormatConfiguration' function Add-VSKinesisFirehoseDeliveryStreamParquetSerDe { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.ParquetSerDe resource property to the template. A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet: https://parquet.apache.org/documentation/latest/. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ParquetSerDe resource property to the template. A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet: https://parquet.apache.org/documentation/latest/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html .PARAMETER BlockSizeBytes The Hadoop Distributed File System HDFS block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes UpdateType: Mutable PrimitiveType: Integer .PARAMETER Compression The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-compression UpdateType: Mutable PrimitiveType: String .PARAMETER EnableDictionaryCompression Indicates whether to enable dictionary compression. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression UpdateType: Mutable PrimitiveType: Boolean .PARAMETER MaxPaddingBytes The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes UpdateType: Mutable PrimitiveType: Integer .PARAMETER PageSizeBytes The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit in terms of compression and encoding. The minimum value is 64 KiB and the default is 1 MiB. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes UpdateType: Mutable PrimitiveType: Integer .PARAMETER WriterVersion Indicates the version of row format to output. The possible values are V1 and V2. The default is V1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-writerversion UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamParquetSerDe])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $BlockSizeBytes, [parameter(Mandatory = $false)] [object] $Compression, [parameter(Mandatory = $false)] [object] $EnableDictionaryCompression, [parameter(Mandatory = $false)] [object] $MaxPaddingBytes, [parameter(Mandatory = $false)] [object] $PageSizeBytes, [parameter(Mandatory = $false)] [object] $WriterVersion ) Process { $obj = [KinesisFirehoseDeliveryStreamParquetSerDe]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamParquetSerDe' function Add-VSKinesisFirehoseDeliveryStreamProcessingConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration resource property to the template. The ProcessingConfiguration property configures data processing for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration resource property to the template. The ProcessingConfiguration property configures data processing for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html .PARAMETER Enabled Indicates whether data processing is enabled true or disabled false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER Processors The data processors. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-processors UpdateType: Mutable Type: List ItemType: Processor DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamProcessingConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] [object] $Processors ) Process { $obj = [KinesisFirehoseDeliveryStreamProcessingConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamProcessingConfiguration' function Add-VSKinesisFirehoseDeliveryStreamProcessor { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.Processor resource property to the template. The Processor property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.Processor resource property to the template. The Processor property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html .PARAMETER Parameters The processor parameters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-parameters UpdateType: Mutable Type: List ItemType: ProcessorParameter DuplicatesAllowed: False .PARAMETER Type The type of processor. Valid values: Lambda. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-type UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamProcessor])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Parameters, [parameter(Mandatory = $true)] [object] $Type ) Process { $obj = [KinesisFirehoseDeliveryStreamProcessor]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamProcessor' function Add-VSKinesisFirehoseDeliveryStreamProcessorParameter { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.ProcessorParameter resource property to the template. The ProcessorParameter property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ProcessorParameter resource property to the template. The ProcessorParameter property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html .PARAMETER ParameterName The name of the parameter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametername UpdateType: Mutable PrimitiveType: String .PARAMETER ParameterValue The parameter value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamProcessorParameter])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ParameterName, [parameter(Mandatory = $true)] [object] $ParameterValue ) Process { $obj = [KinesisFirehoseDeliveryStreamProcessorParameter]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamProcessorParameter' function Add-VSKinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration resource property to the template. The RedshiftDestinationConfiguration property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration resource property to the template. The RedshiftDestinationConfiguration property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html .PARAMETER CloudWatchLoggingOptions The CloudWatch logging options for your delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions UpdateType: Mutable Type: CloudWatchLoggingOptions .PARAMETER ClusterJDBCURL The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl UpdateType: Mutable PrimitiveType: String .PARAMETER CopyCommand Configures the Amazon Redshift COPY command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand UpdateType: Mutable Type: CopyCommand .PARAMETER Password The password for the Amazon Redshift user that you specified in the Username property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password UpdateType: Mutable PrimitiveType: String .PARAMETER ProcessingConfiguration The data processing configuration for the Kinesis Data Firehose delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration UpdateType: Mutable Type: ProcessingConfiguration .PARAMETER RetryOptions *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-retryoptions UpdateType: Mutable Type: RedshiftRetryOptions .PARAMETER RoleARN The ARN of the AWS Identity and Access Management IAM role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS if you enable data encryption. For more information, see Grant Kinesis Data Firehose Access to an Amazon Redshift Destination: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-rs in the *Amazon Kinesis Data Firehose Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn UpdateType: Mutable PrimitiveType: String .PARAMETER S3BackupConfiguration *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupconfiguration UpdateType: Mutable Type: S3DestinationConfiguration .PARAMETER S3BackupMode *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupmode UpdateType: Mutable PrimitiveType: String .PARAMETER S3Configuration The S3 bucket where Kinesis Data Firehose first delivers data. After the data is in the bucket, Kinesis Data Firehose uses the COPY command to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket's compression format, don't specify SNAPPY or ZIP because the Amazon Redshift COPY command doesn't support them. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration UpdateType: Mutable Type: S3DestinationConfiguration .PARAMETER Username The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have INSERT privileges for copying data from the Amazon S3 bucket to the cluster. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration])] [cmdletbinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword","Password")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPasswordParams","Password")] Param( [parameter(Mandatory = $false)] $CloudWatchLoggingOptions, [parameter(Mandatory = $true)] [object] $ClusterJDBCURL, [parameter(Mandatory = $true)] $CopyCommand, [parameter(Mandatory = $true)] [object] $Password, [parameter(Mandatory = $false)] $ProcessingConfiguration, [parameter(Mandatory = $false)] $RetryOptions, [parameter(Mandatory = $true)] [object] $RoleARN, [parameter(Mandatory = $false)] $S3BackupConfiguration, [parameter(Mandatory = $false)] [object] $S3BackupMode, [parameter(Mandatory = $true)] $S3Configuration, [parameter(Mandatory = $true)] [object] $Username ) Process { $obj = [KinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration' function Add-VSKinesisFirehoseDeliveryStreamRedshiftRetryOptions { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.RedshiftRetryOptions resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.RedshiftRetryOptions resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html .PARAMETER DurationInSeconds Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html#cfn-kinesisfirehose-deliverystream-redshiftretryoptions-durationinseconds UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamRedshiftRetryOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $DurationInSeconds ) Process { $obj = [KinesisFirehoseDeliveryStreamRedshiftRetryOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamRedshiftRetryOptions' function Add-VSKinesisFirehoseDeliveryStreamRetryOptions { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.RetryOptions resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.RetryOptions resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-retryoptions.html .PARAMETER DurationInSeconds Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-retryoptions.html#cfn-kinesisfirehose-deliverystream-retryoptions-durationinseconds UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamRetryOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $DurationInSeconds ) Process { $obj = [KinesisFirehoseDeliveryStreamRetryOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamRetryOptions' function Add-VSKinesisFirehoseDeliveryStreamS3DestinationConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration resource property to the template. The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3 destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration resource property to the template. The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3 destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html .PARAMETER BucketARN The Amazon Resource Name ARN of the Amazon S3 bucket to send data to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn UpdateType: Mutable PrimitiveType: String .PARAMETER BufferingHints Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints UpdateType: Mutable Type: BufferingHints .PARAMETER CloudWatchLoggingOptions The CloudWatch logging options for your delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions UpdateType: Mutable Type: CloudWatchLoggingOptions .PARAMETER CompressionFormat The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the CompressionFormat content for the S3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html data type in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat UpdateType: Mutable PrimitiveType: String .PARAMETER EncryptionConfiguration Configures Amazon Simple Storage Service Amazon S3 server-side encryption. Kinesis Data Firehose uses AWS Key Management Service AWS KMS to encrypt the data that it delivers to your Amazon S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration UpdateType: Mutable Type: EncryptionConfiguration .PARAMETER ErrorOutputPrefix A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-erroroutputprefix UpdateType: Mutable PrimitiveType: String .PARAMETER Prefix A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket. The prefix helps you identify the files that Kinesis Data Firehose delivered. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix UpdateType: Mutable PrimitiveType: String .PARAMETER RoleARN The ARN of an AWS Identity and Access Management IAM role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS if you enable data encryption. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 in the *Amazon Kinesis Data Firehose Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamS3DestinationConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $BucketARN, [parameter(Mandatory = $false)] $BufferingHints, [parameter(Mandatory = $false)] $CloudWatchLoggingOptions, [parameter(Mandatory = $false)] [object] $CompressionFormat, [parameter(Mandatory = $false)] $EncryptionConfiguration, [parameter(Mandatory = $false)] [object] $ErrorOutputPrefix, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisFirehoseDeliveryStreamS3DestinationConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamS3DestinationConfiguration' function Add-VSKinesisFirehoseDeliveryStreamSchemaConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration resource property to the template. Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration resource property to the template. Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html .PARAMETER CatalogId The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid UpdateType: Mutable PrimitiveType: String .PARAMETER DatabaseName Specifies the name of the AWS Glue database that contains the schema for the output data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename UpdateType: Mutable PrimitiveType: String .PARAMETER Region If you don't specify an AWS Region, the default is the current Region. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-region UpdateType: Mutable PrimitiveType: String .PARAMETER RoleARN The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-rolearn UpdateType: Mutable PrimitiveType: String .PARAMETER TableName Specifies the AWS Glue table that contains the column information that constitutes your data schema. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename UpdateType: Mutable PrimitiveType: String .PARAMETER VersionId Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamSchemaConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CatalogId, [parameter(Mandatory = $false)] [object] $DatabaseName, [parameter(Mandatory = $false)] [object] $Region, [parameter(Mandatory = $false)] [object] $RoleARN, [parameter(Mandatory = $false)] [object] $TableName, [parameter(Mandatory = $false)] [object] $VersionId ) Process { $obj = [KinesisFirehoseDeliveryStreamSchemaConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamSchemaConfiguration' function Add-VSKinesisFirehoseDeliveryStreamSerializer { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.Serializer resource property to the template. The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html and the Parquet SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.Serializer resource property to the template. The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html and the Parquet SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html .PARAMETER OrcSerDe A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC: https://orc.apache.org/docs/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-orcserde UpdateType: Mutable Type: OrcSerDe .PARAMETER ParquetSerDe A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet: https://parquet.apache.org/documentation/latest/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-parquetserde UpdateType: Mutable Type: ParquetSerDe .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamSerializer])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $OrcSerDe, [parameter(Mandatory = $false)] $ParquetSerDe ) Process { $obj = [KinesisFirehoseDeliveryStreamSerializer]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamSerializer' function Add-VSKinesisFirehoseDeliveryStreamSplunkDestinationConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration resource property to the template. The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration resource property to the template. The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html .PARAMETER CloudWatchLoggingOptions The Amazon CloudWatch logging options for your delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions UpdateType: Mutable Type: CloudWatchLoggingOptions .PARAMETER HECAcknowledgmentTimeoutInSeconds The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds UpdateType: Mutable PrimitiveType: Integer .PARAMETER HECEndpoint The HTTP Event Collector HEC endpoint to which Kinesis Data Firehose sends your data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER HECEndpointType This type can be either Raw or Event. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype UpdateType: Mutable PrimitiveType: String .PARAMETER HECToken This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken UpdateType: Mutable PrimitiveType: String .PARAMETER ProcessingConfiguration The data processing configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration UpdateType: Mutable Type: ProcessingConfiguration .PARAMETER RetryOptions The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions UpdateType: Mutable Type: SplunkRetryOptions .PARAMETER S3BackupMode Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode UpdateType: Mutable PrimitiveType: String .PARAMETER S3Configuration The configuration for the backup Amazon S3 location. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration UpdateType: Mutable Type: S3DestinationConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamSplunkDestinationConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $CloudWatchLoggingOptions, [parameter(Mandatory = $false)] [object] $HECAcknowledgmentTimeoutInSeconds, [parameter(Mandatory = $true)] [object] $HECEndpoint, [parameter(Mandatory = $true)] [object] $HECEndpointType, [parameter(Mandatory = $true)] [object] $HECToken, [parameter(Mandatory = $false)] $ProcessingConfiguration, [parameter(Mandatory = $false)] $RetryOptions, [parameter(Mandatory = $false)] [object] $S3BackupMode, [parameter(Mandatory = $true)] $S3Configuration ) Process { $obj = [KinesisFirehoseDeliveryStreamSplunkDestinationConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamSplunkDestinationConfiguration' function Add-VSKinesisFirehoseDeliveryStreamSplunkRetryOptions { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions resource property to the template. The SplunkRetryOptions property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions resource property to the template. The SplunkRetryOptions property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html .PARAMETER DurationInSeconds The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamSplunkRetryOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $DurationInSeconds ) Process { $obj = [KinesisFirehoseDeliveryStreamSplunkRetryOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamSplunkRetryOptions' function Add-VSKinesisFirehoseDeliveryStreamVpcConfiguration { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream.VpcConfiguration resource property to the template. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.VpcConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html .PARAMETER RoleARN Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-rolearn UpdateType: Immutable PrimitiveType: String .PARAMETER SubnetIds Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-subnetids UpdateType: Immutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .PARAMETER SecurityGroupIds Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-securitygroupids UpdateType: Immutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStreamVpcConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $RoleARN, [parameter(Mandatory = $true)] $SubnetIds, [parameter(Mandatory = $true)] $SecurityGroupIds ) Process { $obj = [KinesisFirehoseDeliveryStreamVpcConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSKinesisFirehoseDeliveryStreamVpcConfiguration' function New-VSKinesisFirehoseDeliveryStream { <# .SYNOPSIS Adds an AWS::KinesisFirehose::DeliveryStream resource to the template. The AWS::KinesisFirehose::DeliveryStream resource creates an Amazon Kinesis Data Firehose (Kinesis Data Firehose delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3, Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES destination. For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream: https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html in the *Amazon Kinesis Data Firehose Developer Guide*. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream resource to the template. The AWS::KinesisFirehose::DeliveryStream resource creates an Amazon Kinesis Data Firehose (Kinesis Data Firehose delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3, Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES destination. For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream: https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html in the *Amazon Kinesis Data Firehose Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeliveryStreamEncryptionConfigurationInput + CreateDeliveryStream: https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput UpdateType: Mutable Type: DeliveryStreamEncryptionConfigurationInput .PARAMETER DeliveryStreamName The name of the delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname UpdateType: Immutable PrimitiveType: String .PARAMETER DeliveryStreamType The delivery stream type. This can be one of the following values: + DirectPut: Provider applications access the delivery stream directly. + KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype UpdateType: Immutable PrimitiveType: String .PARAMETER ElasticsearchDestinationConfiguration An Amazon ES destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration UpdateType: Mutable Type: ElasticsearchDestinationConfiguration .PARAMETER ExtendedS3DestinationConfiguration An Amazon S3 destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration UpdateType: Mutable Type: ExtendedS3DestinationConfiguration .PARAMETER KinesisStreamSourceConfiguration When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html containing the Kinesis stream ARN and the role ARN for the source stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration UpdateType: Immutable Type: KinesisStreamSourceConfiguration .PARAMETER RedshiftDestinationConfiguration An Amazon Redshift destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration UpdateType: Mutable Type: RedshiftDestinationConfiguration .PARAMETER S3DestinationConfiguration The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service Amazon S3 destination to which Amazon Kinesis Data Firehose Kinesis Data Firehose delivers data. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration UpdateType: Mutable Type: S3DestinationConfiguration .PARAMETER SplunkDestinationConfiguration The configuration of a destination in Splunk for the delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration UpdateType: Mutable Type: SplunkDestinationConfiguration .PARAMETER HttpEndpointDestinationConfiguration + CreateDeliveryStream: https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration UpdateType: Mutable Type: HttpEndpointDestinationConfiguration .PARAMETER Tags + CreateDeliveryStream: https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html in the *Amazon Kinesis Data Firehose API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-tags UpdateType: Mutable Type: List ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([KinesisFirehoseDeliveryStream])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] $DeliveryStreamEncryptionConfigurationInput, [parameter(Mandatory = $false)] [object] $DeliveryStreamName, [parameter(Mandatory = $false)] [object] $DeliveryStreamType, [parameter(Mandatory = $false)] $ElasticsearchDestinationConfiguration, [parameter(Mandatory = $false)] $ExtendedS3DestinationConfiguration, [parameter(Mandatory = $false)] $KinesisStreamSourceConfiguration, [parameter(Mandatory = $false)] $RedshiftDestinationConfiguration, [parameter(Mandatory = $false)] $S3DestinationConfiguration, [parameter(Mandatory = $false)] $SplunkDestinationConfiguration, [parameter(Mandatory = $false)] $HttpEndpointDestinationConfiguration, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [KinesisFirehoseDeliveryStream]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSKinesisFirehoseDeliveryStream' |