AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Kinesis Analytics AddApplicationReferenceDataSource API operation.

Syntax

Add-KINAApplicationReferenceDataSource
-ApplicationName <String>
-S3ReferenceDataSource_BucketARN <String>
-CurrentApplicationVersionId <Int64>
-S3ReferenceDataSource_FileKey <String>
-CSVMappingParameters_RecordColumnDelimiter <String>
-ReferenceSchema_RecordColumn <RecordColumn[]>
-ReferenceSchema_RecordEncoding <String>
-RecordFormat_RecordFormatType <RecordFormatType>
-CSVMappingParameters_RecordRowDelimiter <String>
-JSONMappingParameters_RecordRowPath <String>
-S3ReferenceDataSource_ReferenceRoleARN <String>
-ReferenceDataSource_TableName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonKinesisAnalyticsConfig>

Description

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. 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. For the limits on data sources you can add to your application, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Parameters

-ApplicationName <String>
Name of an existing application.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonKinesisAnalyticsConfig>
Amazon.PowerShell.Cmdlets.KINA.AmazonKinesisAnalyticsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CSVMappingParameters_RecordColumnDelimiter <String>
Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_ReferenceSchema_RecordFormat_MappingParameters_CSVMappingParameters_RecordColumnDelimiter
-CSVMappingParameters_RecordRowDelimiter <String>
Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_ReferenceSchema_RecordFormat_MappingParameters_CSVMappingParameters_RecordRowDelimiter
-CurrentApplicationVersionId <Int64>
Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JSONMappingParameters_RecordRowPath <String>
Path to the top-level parent that contains the records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_ReferenceSchema_RecordFormat_MappingParameters_JSONMappingParameters_RecordRowPath
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ApplicationName parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecordFormat_RecordFormatType <RecordFormatType>
The type of record format.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_ReferenceSchema_RecordFormat_RecordFormatType
-ReferenceDataSource_TableName <String>
Name of the in-application table to create.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReferenceSchema_RecordColumn <RecordColumn[]>
A list of RecordColumn objects.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_ReferenceSchema_RecordColumns
-ReferenceSchema_RecordEncoding <String>
Specifies the encoding of the records in the streaming source. For example, UTF-8.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_ReferenceSchema_RecordEncoding
-S3ReferenceDataSource_BucketARN <String>
Amazon Resource Name (ARN) of the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_S3ReferenceDataSource_BucketARN
-S3ReferenceDataSource_FileKey <String>
Object key name containing reference data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_S3ReferenceDataSource_FileKey
-S3ReferenceDataSource_ReferenceRoleARN <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReferenceDataSource_S3ReferenceDataSource_ReferenceRoleARN
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisAnalytics.Model.AddApplicationReferenceDataSourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.KinesisAnalytics.Model.AddApplicationReferenceDataSourceResponse
This cmdlet does not generate any output.The service response (type Amazon.KinesisAnalytics.Model.AddApplicationReferenceDataSourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
SQL Reference
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z