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 CreateChannel API operation.

Syntax

New-KINChannel
-S3DestinationConfiguration_DeadLetterQueueS3Configuration_BucketARN <String>
-S3DestinationConfiguration_StorageConfiguration_BucketARN <String>
-S3TablesDestinationConfiguration_DeadLetterQueueS3Configuration_BucketARN <String>
-ChannelName <String>
-S3DestinationConfiguration_StorageConfiguration_CompressionType <S3CompressionType>
-S3DestinationConfiguration_DataFreshnessInSecond <Int32>
-S3TablesDestinationConfiguration_DataFreshnessInSecond <Int32>
-LoggingConfiguration_CloudWatchLogs_Enabled <Boolean>
-EncryptionConfiguration_EncryptionType <ChannelEncryptionType>
-S3DestinationConfiguration_DeadLetterQueueS3Configuration_ErrorOutputPrefix <String>
-S3TablesDestinationConfiguration_DeadLetterQueueS3Configuration_ErrorOutputPrefix <String>
-S3DestinationConfiguration_DeadLetterQueueS3Configuration_ExpectedBucketOwner <String>
-S3DestinationConfiguration_StorageConfiguration_ExpectedBucketOwner <String>
-S3TablesDestinationConfiguration_DeadLetterQueueS3Configuration_ExpectedBucketOwner <String>
-EncryptionConfiguration_KeyId <String>
-LoggingConfiguration_CloudWatchLogs_LogGroupName <String>
-LoggingConfiguration_CloudWatchLogs_LogStreamName <String>
-S3DestinationConfiguration_StorageConfiguration_OutputKeyTemplate <String>
-S3TablesDestinationConfiguration_S3TablesConfigurationList <S3TablesConfiguration[]>
-ServiceExecutionRoleARN <String>
-S3DestinationConfiguration_StorageConfiguration_StorageClass <S3StorageClass>
-StreamConfigurationList <ChannelStreamConfiguration[]>
-Tag <Hashtable>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonKinesisConfig>

Description

Creates a channel that delivers records from a Kinesis data stream to a destination. A channel reads records from the specified stream and writes them to streaming tables on Apache Iceberg (Amazon S3 Tables) or to a general purpose Amazon S3 bucket. You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both. To use this operation, you must have permission to pass the specified service execution IAM role to Amazon Kinesis Data Streams (the iam:PassRole permission on that role). Creating a channel is an asynchronous operation. Upon receiving the request, Amazon Kinesis Data Streams returns immediately with the channel in the CREATING state. After provisioning is complete, Amazon Kinesis Data Streams sets the state to ACTIVE. You can use DescribeChannel to check the current state. This operation is only supported for data streams with the on-demand capacity mode. This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

Parameters

-ChannelName <String>
The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonKinesisConfig>
Amazon.PowerShell.Cmdlets.KIN.AmazonKinesisClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfiguration_EncryptionType <ChannelEncryptionType>
The encryption type. The only valid value is KMS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfiguration_KeyId <String>
The identifier of the customer managed Amazon Web Services KMS key. You cannot use the Amazon Kinesis Data Streams service key (aws/kinesis).
Required?False
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)
-LoggingConfiguration_CloudWatchLogs_Enabled <Boolean>
Specifies whether logging to Amazon CloudWatch Logs is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoggingConfiguration_CloudWatchLogs_LogGroupName <String>
The name of the Amazon CloudWatch Logs log group. Defaults to /aws/kinesis/{channelName}/{channelId}.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoggingConfiguration_CloudWatchLogs_LogStreamName <String>
The name of the Amazon CloudWatch Logs log stream. Defaults to DestinationDelivery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_DataFreshnessInSecond <Int32>
The maximum age, in seconds, of undelivered data before the channel delivers it to the destination. The default value is 300 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesS3DestinationConfiguration_DataFreshnessInSeconds
-S3DestinationConfiguration_DeadLetterQueueS3Configuration_BucketARN <String>
The Amazon Resource Name (ARN) of the dead-letter queue Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_DeadLetterQueueS3Configuration_ErrorOutputPrefix <String>
The Amazon S3 key prefix for error records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_DeadLetterQueueS3Configuration_ExpectedBucketOwner <String>
The Amazon Web Services account ID of the expected owner of the dead-letter queue bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_StorageConfiguration_BucketARN <String>
The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_StorageConfiguration_CompressionType <S3CompressionType>
The compression applied to delivered objects. Valid values:
  • NONE - No compression.
  • GZIP - gzip compression.
  • ZSTD - Zstandard compression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_StorageConfiguration_ExpectedBucketOwner <String>
The Amazon Web Services account ID of the expected owner of the destination bucket. This value helps prevent delivery to an unintended bucket if ownership changes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_StorageConfiguration_OutputKeyTemplate <String>
The template used to construct the Amazon S3 object key for delivered objects. If not specified, a default template is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfiguration_StorageConfiguration_StorageClass <S3StorageClass>
The Amazon S3 storage class for delivered objects. Valid values:
  • STANDARD - The default storage class, for frequently accessed data.
  • INTELLIGENT_TIERING - Automatically moves objects to the most cost-effective access tier based on usage patterns.
  • GLACIER_IR - Low-cost storage for rarely accessed data that requires millisecond retrieval.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3TablesDestinationConfiguration_DataFreshnessInSecond <Int32>
The maximum age, in seconds, of undelivered data before the channel delivers it to the destination. The default value is 300 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesS3TablesDestinationConfiguration_DataFreshnessInSeconds
-S3TablesDestinationConfiguration_DeadLetterQueueS3Configuration_BucketARN <String>
The Amazon Resource Name (ARN) of the dead-letter queue Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3TablesDestinationConfiguration_DeadLetterQueueS3Configuration_ErrorOutputPrefix <String>
The Amazon S3 key prefix for error records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3TablesDestinationConfiguration_DeadLetterQueueS3Configuration_ExpectedBucketOwner <String>
The Amazon Web Services account ID of the expected owner of the dead-letter queue bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3TablesDestinationConfiguration_S3TablesConfigurationList <S3TablesConfiguration[]>
The list of streaming table configurations. Currently, one table is supported per channel. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ChannelDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kinesis.Model.CreateChannelResponse). Specifying the name of a property of type Amazon.Kinesis.Model.CreateChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceExecutionRoleARN <String>
The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamConfigurationList <ChannelStreamConfiguration[]>
The source stream configuration for the channel. Currently, one stream is supported per channel. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A set of key-value pairs to assign to the channel. A tag consists of a required key and an optional value. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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

Amazon.Kinesis.Model.ChannelDescription or Amazon.Kinesis.Model.CreateChannelResponse
This cmdlet returns an Amazon.Kinesis.Model.ChannelDescription object. The service call response (type Amazon.Kinesis.Model.CreateChannelResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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