VaporShell.KinesisAnalytics.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-VSKinesisAnalyticsApplicationCSVMappingParameters { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.CSVMappingParameters resource property to the template. Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.CSVMappingParameters resource property to the template. Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: "name1", "address1" "name2", "address2" .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html .PARAMETER RecordRowDelimiter Row delimiter. For example, in a CSV format, *'n'* is the typical row delimiter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordrowdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumnDelimiter Column delimiter. For example, in a CSV format, a comma "," is the typical column delimiter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordcolumndelimiter PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationCSVMappingParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $RecordRowDelimiter, [parameter(Mandatory = $true)] [object] $RecordColumnDelimiter ) Process { $obj = [KinesisAnalyticsApplicationCSVMappingParameters]::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-VSKinesisAnalyticsApplicationCSVMappingParameters' function Add-VSKinesisAnalyticsApplicationInput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.Input resource property to the template. When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.Input resource property to the template. When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html .PARAMETER NamePrefix Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more as per the InputParallelism count you specified in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-nameprefix PrimitiveType: String UpdateType: Mutable .PARAMETER InputSchema Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. Also used to describe the format of the reference data source. Type: InputSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputschema UpdateType: Mutable .PARAMETER KinesisStreamsInput If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. Type: KinesisStreamsInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisstreamsinput UpdateType: Mutable .PARAMETER KinesisFirehoseInput If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. Type: KinesisFirehoseInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisfirehoseinput UpdateType: Mutable .PARAMETER InputProcessingConfiguration The InputProcessingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html. Type: InputProcessingConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputprocessingconfiguration UpdateType: Mutable .PARAMETER InputParallelism Describes the number of in-application streams to create. Data from your source is routed to these in-application input streams. See Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. Type: InputParallelism Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputparallelism UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationInput])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $NamePrefix, [parameter(Mandatory = $true)] $InputSchema, [parameter(Mandatory = $false)] $KinesisStreamsInput, [parameter(Mandatory = $false)] $KinesisFirehoseInput, [parameter(Mandatory = $false)] $InputProcessingConfiguration, [parameter(Mandatory = $false)] $InputParallelism ) Process { $obj = [KinesisAnalyticsApplicationInput]::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-VSKinesisAnalyticsApplicationInput' function Add-VSKinesisAnalyticsApplicationInputLambdaProcessor { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.InputLambdaProcessor resource property to the template. An object that contains the Amazon Resource Name (ARN of the AWS Lambda: https://docs.aws.amazon.com/lambda/ function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputLambdaProcessor resource property to the template. An object that contains the Amazon Resource Name (ARN of the AWS Lambda: https://docs.aws.amazon.com/lambda/ function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html .PARAMETER ResourceARN The ARN of the AWS Lambda: https://docs.aws.amazon.com/lambda/ function that operates on records in the stream. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda: /general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN The ARN of the IAM role that is used to access the AWS Lambda function. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-rolearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationInputLambdaProcessor])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ResourceARN, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisAnalyticsApplicationInputLambdaProcessor]::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-VSKinesisAnalyticsApplicationInputLambdaProcessor' function Add-VSKinesisAnalyticsApplicationInputParallelism { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.InputParallelism resource property to the template. Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputParallelism resource property to the template. Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html .PARAMETER Count Number of in-application streams to create. For more information, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html#cfn-kinesisanalytics-application-inputparallelism-count PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationInputParallelism])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Count ) Process { $obj = [KinesisAnalyticsApplicationInputParallelism]::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-VSKinesisAnalyticsApplicationInputParallelism' function Add-VSKinesisAnalyticsApplicationInputProcessingConfiguration { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.InputProcessingConfiguration resource property to the template. Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda: https://docs.aws.amazon.com/lambda/. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputProcessingConfiguration resource property to the template. Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda: https://docs.aws.amazon.com/lambda/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html .PARAMETER InputLambdaProcessor The InputLambdaProcessor: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html that is used to preprocess the records in the stream before being processed by your application code. Type: InputLambdaProcessor Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html#cfn-kinesisanalytics-application-inputprocessingconfiguration-inputlambdaprocessor UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationInputProcessingConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $InputLambdaProcessor ) Process { $obj = [KinesisAnalyticsApplicationInputProcessingConfiguration]::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-VSKinesisAnalyticsApplicationInputProcessingConfiguration' function Add-VSKinesisAnalyticsApplicationInputSchema { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.InputSchema resource property to the template. Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputSchema resource property to the template. Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html .PARAMETER RecordEncoding Specifies the encoding of the records in the streaming source. For example, UTF-8. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordencoding PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumns A list of RecordColumn objects. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordcolumns ItemType: RecordColumn UpdateType: Mutable .PARAMETER RecordFormat Specifies the format of the records on the streaming source. Type: RecordFormat Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordformat UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationInputSchema])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $RecordEncoding, [parameter(Mandatory = $true)] [object] $RecordColumns, [parameter(Mandatory = $true)] $RecordFormat ) Process { $obj = [KinesisAnalyticsApplicationInputSchema]::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-VSKinesisAnalyticsApplicationInputSchema' function Add-VSKinesisAnalyticsApplicationJSONMappingParameters { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.JSONMappingParameters resource property to the template. Provides additional mapping information when JSON is the record format on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.JSONMappingParameters resource property to the template. Provides additional mapping information when JSON is the record format on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html .PARAMETER RecordRowPath Path to the top-level parent that contains the records. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html#cfn-kinesisanalytics-application-jsonmappingparameters-recordrowpath PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationJSONMappingParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $RecordRowPath ) Process { $obj = [KinesisAnalyticsApplicationJSONMappingParameters]::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-VSKinesisAnalyticsApplicationJSONMappingParameters' function Add-VSKinesisAnalyticsApplicationKinesisFirehoseInput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.KinesisFirehoseInput resource property to the template. Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.KinesisFirehoseInput resource property to the template. Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html .PARAMETER ResourceARN ARN of the input delivery stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-rolearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationKinesisFirehoseInput])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ResourceARN, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisAnalyticsApplicationKinesisFirehoseInput]::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-VSKinesisAnalyticsApplicationKinesisFirehoseInput' function Add-VSKinesisAnalyticsApplicationKinesisStreamsInput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.KinesisStreamsInput resource property to the template. Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.KinesisStreamsInput resource property to the template. Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html .PARAMETER ResourceARN ARN of the input Amazon Kinesis stream to read. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-rolearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationKinesisStreamsInput])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ResourceARN, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisAnalyticsApplicationKinesisStreamsInput]::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-VSKinesisAnalyticsApplicationKinesisStreamsInput' function Add-VSKinesisAnalyticsApplicationMappingParameters { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.MappingParameters resource property to the template. When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.MappingParameters resource property to the template. When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html .PARAMETER JSONMappingParameters Provides additional mapping information when JSON is the record format on the streaming source. Type: JSONMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-jsonmappingparameters UpdateType: Mutable .PARAMETER CSVMappingParameters Provides additional mapping information when the record format uses delimiters for example, CSV. Type: CSVMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-csvmappingparameters UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationMappingParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $JSONMappingParameters, [parameter(Mandatory = $false)] $CSVMappingParameters ) Process { $obj = [KinesisAnalyticsApplicationMappingParameters]::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-VSKinesisAnalyticsApplicationMappingParameters' function Add-VSKinesisAnalyticsApplicationOutputDestinationSchema { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema resource property to the template. Describes the data format when records are written to the destination. For more information, see Configuring Application Output: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema resource property to the template. Describes the data format when records are written to the destination. For more information, see Configuring Application Output: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-destinationschema.html .PARAMETER RecordFormatType Specifies the format of the records on the output stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-destinationschema.html#cfn-kinesisanalytics-applicationoutput-destinationschema-recordformattype PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationOutputDestinationSchema])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $RecordFormatType ) Process { $obj = [KinesisAnalyticsApplicationOutputDestinationSchema]::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-VSKinesisAnalyticsApplicationOutputDestinationSchema' function Add-VSKinesisAnalyticsApplicationOutputKinesisFirehoseOutput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput resource property to the template. When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput resource property to the template. When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html .PARAMETER ResourceARN ARN of the destination Amazon Kinesis Firehose delivery stream to write to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-rolearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationOutputKinesisFirehoseOutput])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ResourceARN, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisAnalyticsApplicationOutputKinesisFirehoseOutput]::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-VSKinesisAnalyticsApplicationOutputKinesisFirehoseOutput' function Add-VSKinesisAnalyticsApplicationOutputKinesisStreamsOutput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput resource property to the template. When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput resource property to the template. When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html .PARAMETER ResourceARN ARN of the destination Amazon Kinesis stream to write to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-rolearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationOutputKinesisStreamsOutput])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ResourceARN, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisAnalyticsApplicationOutputKinesisStreamsOutput]::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-VSKinesisAnalyticsApplicationOutputKinesisStreamsOutput' function Add-VSKinesisAnalyticsApplicationOutputLambdaOutput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput resource property to the template. When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput resource property to the template. When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html .PARAMETER ResourceARN Amazon Resource Name ARN of the destination Lambda function to write to. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda: /general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-rolearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationOutputLambdaOutput])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ResourceARN, [parameter(Mandatory = $true)] [object] $RoleARN ) Process { $obj = [KinesisAnalyticsApplicationOutputLambdaOutput]::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-VSKinesisAnalyticsApplicationOutputLambdaOutput' function Add-VSKinesisAnalyticsApplicationOutputOutput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationOutput.Output resource property to the template. Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.Output resource property to the template. Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. For limits on how many destinations an application can write and other limitations, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html .PARAMETER DestinationSchema Describes the data format when records are written to the destination. For more information, see Configuring Application Output: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. Type: DestinationSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-destinationschema UpdateType: Mutable .PARAMETER LambdaOutput Identifies an AWS Lambda function as the destination. Type: LambdaOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-lambdaoutput UpdateType: Mutable .PARAMETER KinesisFirehoseOutput Identifies an Amazon Kinesis Firehose delivery stream as the destination. Type: KinesisFirehoseOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisfirehoseoutput UpdateType: Mutable .PARAMETER KinesisStreamsOutput Identifies an Amazon Kinesis stream as the destination. Type: KinesisStreamsOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisstreamsoutput UpdateType: Mutable .PARAMETER Name Name of the in-application stream. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-name PrimitiveType: String UpdateType: Immutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationOutputOutput])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $DestinationSchema, [parameter(Mandatory = $false)] $LambdaOutput, [parameter(Mandatory = $false)] $KinesisFirehoseOutput, [parameter(Mandatory = $false)] $KinesisStreamsOutput, [parameter(Mandatory = $false)] [object] $Name ) Process { $obj = [KinesisAnalyticsApplicationOutputOutput]::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-VSKinesisAnalyticsApplicationOutputOutput' function Add-VSKinesisAnalyticsApplicationRecordColumn { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.RecordColumn resource property to the template. Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.RecordColumn resource property to the template. Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html .PARAMETER Mapping Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel is JSON. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-mapping PrimitiveType: String UpdateType: Mutable .PARAMETER SqlType Type of column created in the in-application input stream or reference table. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-sqltype PrimitiveType: String UpdateType: Mutable .PARAMETER Name Name of the column created in the in-application input stream or reference table. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-name PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationRecordColumn])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Mapping, [parameter(Mandatory = $true)] [object] $SqlType, [parameter(Mandatory = $true)] [object] $Name ) Process { $obj = [KinesisAnalyticsApplicationRecordColumn]::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-VSKinesisAnalyticsApplicationRecordColumn' function Add-VSKinesisAnalyticsApplicationRecordFormat { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application.RecordFormat resource property to the template. Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.RecordFormat resource property to the template. Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html .PARAMETER MappingParameters When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. Type: MappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-mappingparameters UpdateType: Mutable .PARAMETER RecordFormatType The type of record format. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-recordformattype PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationRecordFormat])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $MappingParameters, [parameter(Mandatory = $true)] [object] $RecordFormatType ) Process { $obj = [KinesisAnalyticsApplicationRecordFormat]::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-VSKinesisAnalyticsApplicationRecordFormat' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: "name1", "address1" "name2", "address2" .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html .PARAMETER RecordRowDelimiter Row delimiter. For example, in a CSV format, *'n'* is the typical row delimiter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordrowdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumnDelimiter Column delimiter. For example, in a CSV format, a comma "," is the typical column delimiter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordcolumndelimiter PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $RecordRowDelimiter, [parameter(Mandatory = $true)] [object] $RecordColumnDelimiter ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters]::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-VSKinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. Provides additional mapping information when JSON is the record format on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. Provides additional mapping information when JSON is the record format on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html .PARAMETER RecordRowPath Path to the top-level parent that contains the records. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters-recordrowpath PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $RecordRowPath ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters]::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-VSKinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceMappingParameters { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters resource property to the template. When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters resource property to the template. When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html .PARAMETER JSONMappingParameters Provides additional mapping information when JSON is the record format on the streaming source. Type: JSONMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-jsonmappingparameters UpdateType: Mutable .PARAMETER CSVMappingParameters Provides additional mapping information when the record format uses delimiters for example, CSV. Type: CSVMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-csvmappingparameters UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceMappingParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $JSONMappingParameters, [parameter(Mandatory = $false)] $CSVMappingParameters ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceMappingParameters]::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-VSKinesisAnalyticsApplicationReferenceDataSourceMappingParameters' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordColumn { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn resource property to the template. Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn resource property to the template. Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html .PARAMETER Mapping Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel is JSON. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-mapping PrimitiveType: String UpdateType: Mutable .PARAMETER SqlType Type of column created in the in-application input stream or reference table. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-sqltype PrimitiveType: String UpdateType: Mutable .PARAMETER Name Name of the column created in the in-application input stream or reference table. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-name PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceRecordColumn])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Mapping, [parameter(Mandatory = $true)] [object] $SqlType, [parameter(Mandatory = $true)] [object] $Name ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceRecordColumn]::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-VSKinesisAnalyticsApplicationReferenceDataSourceRecordColumn' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordFormat { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat resource property to the template. Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat resource property to the template. Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html .PARAMETER MappingParameters When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. Type: MappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-mappingparameters UpdateType: Mutable .PARAMETER RecordFormatType The type of record format. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-recordformattype PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceRecordFormat])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $MappingParameters, [parameter(Mandatory = $true)] [object] $RecordFormatType ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceRecordFormat]::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-VSKinesisAnalyticsApplicationReferenceDataSourceRecordFormat' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. Describes the reference data source by providing the source information (S3 bucket name and object key name, the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. Describes the reference data source by providing the source information (S3 bucket name and object key name, the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html .PARAMETER ReferenceSchema Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. Type: ReferenceSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-referenceschema UpdateType: Mutable .PARAMETER TableName Name of the in-application table to create. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-tablename PrimitiveType: String UpdateType: Mutable .PARAMETER S3ReferenceDataSource Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application. Type: S3ReferenceDataSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-s3referencedatasource UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $ReferenceSchema, [parameter(Mandatory = $false)] [object] $TableName, [parameter(Mandatory = $false)] $S3ReferenceDataSource ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource]::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-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceSchema { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html .PARAMETER RecordEncoding Specifies the encoding of the records in the reference source. For example, UTF-8. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordencoding PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumns A list of RecordColumn objects. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordcolumns ItemType: RecordColumn UpdateType: Mutable .PARAMETER RecordFormat Specifies the format of the records on the reference source. Type: RecordFormat Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordformat UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceReferenceSchema])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $RecordEncoding, [parameter(Mandatory = $true)] [object] $RecordColumns, [parameter(Mandatory = $true)] $RecordFormat ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceReferenceSchema]::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-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceSchema' function Add-VSKinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html operation to trigger reloading of data into your application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html .PARAMETER BucketARN Amazon Resource Name ARN of the S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER FileKey Object key name containing reference data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-filekey PrimitiveType: String UpdateType: Mutable .PARAMETER ReferenceRoleARN ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-referencerolearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([KinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $BucketARN, [parameter(Mandatory = $true)] [object] $FileKey, [parameter(Mandatory = $true)] [object] $ReferenceRoleARN ) Process { $obj = [KinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource]::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-VSKinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource' function New-VSKinesisAnalyticsApplication { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::Application resource to the template. The AWS::KinesisAnalytics::Application resource creates an Amazon Kinesis Data Analytics application. For more information, see the Amazon Kinesis Data Analytics Developer Guide: /kinesisanalytics/latest/dev/what-is.html. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application resource to the template. The AWS::KinesisAnalytics::Application resource creates an Amazon Kinesis Data Analytics application. For more information, see the Amazon Kinesis Data Analytics Developer Guide: /kinesisanalytics/latest/dev/what-is.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.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 ApplicationName Name of your Amazon Kinesis Analytics application for example, sample-app. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER Inputs Use this parameter to configure the application input. You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table you can think of it as a constantly updating table. For the streaming source, you provide its Amazon Resource Name ARN and format of data on the stream for example, JSON, CSV, etc.. You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf. To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-inputs ItemType: Input UpdateType: Mutable .PARAMETER ApplicationDescription Summary description of the application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationdescription PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationCode One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html. You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps. Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationcode PrimitiveType: String UpdateType: Mutable .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([KinesisAnalyticsApplication])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $ApplicationName, [parameter(Mandatory = $true)] [object] $Inputs, [parameter(Mandatory = $false)] [object] $ApplicationDescription, [parameter(Mandatory = $false)] [object] $ApplicationCode, [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 = [KinesisAnalyticsApplication]::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-VSKinesisAnalyticsApplication' function New-VSKinesisAnalyticsApplicationOutput { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationOutput resource to the template. Adds an external destination to your Amazon Kinesis Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput resource to the template. Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function, you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.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 ApplicationName Name of the application to which you want to add the output configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER Output An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function, and record the formation to use when writing to the destination. Type: Output Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-output UpdateType: Mutable .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([KinesisAnalyticsApplicationOutput])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $ApplicationName, [parameter(Mandatory = $true)] $Output, [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 = [KinesisAnalyticsApplicationOutput]::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-VSKinesisAnalyticsApplicationOutput' function New-VSKinesisAnalyticsApplicationReferenceDataSource { <# .SYNOPSIS Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource resource to the template. Adds a reference data source to an existing application. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource resource to the template. Adds a reference data source to an existing application. Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name, name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. For conceptual information, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. For the limits on data sources you can add to your application, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.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 ApplicationName Name of an existing application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER ReferenceDataSource The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf. Type: ReferenceDataSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource UpdateType: Mutable .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([KinesisAnalyticsApplicationReferenceDataSource])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $ApplicationName, [parameter(Mandatory = $true)] $ReferenceDataSource, [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 = [KinesisAnalyticsApplicationReferenceDataSource]::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-VSKinesisAnalyticsApplicationReferenceDataSource' |