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 Managed Streaming for Kafka Connect CreateConnector API operation.

Syntax

New-MSKCConnector
-ConnectorName <String>
-KafkaClusterClientAuthentication_AuthenticationType <KafkaClusterClientAuthenticationType>
-ApacheKafkaCluster_BootstrapServer <String>
-S3_Bucket <String>
-ConnectorConfiguration <Hashtable>
-ConnectorDescription <String>
-ScaleInPolicy_CpuUtilizationPercentage <Int32>
-ScaleOutPolicy_CpuUtilizationPercentage <Int32>
-Firehose_DeliveryStream <String>
-CloudWatchLogs_Enabled <Boolean>
-Firehose_Enabled <Boolean>
-S3_Enabled <Boolean>
-KafkaClusterEncryptionInTransit_EncryptionType <KafkaClusterEncryptionInTransitType>
-KafkaConnectVersion <String>
-CloudWatchLogs_LogGroup <String>
-AutoScaling_MaxWorkerCount <Int32>
-AutoScaling_McuCount <Int32>
-ProvisionedCapacity_McuCount <Int32>
-AutoScaling_MinWorkerCount <Int32>
-Plugin <Plugin[]>
-S3_Prefix <String>
-WorkerConfiguration_Revision <Int64>
-Vpc_SecurityGroup <String[]>
-ServiceExecutionRoleArn <String>
-Vpc_Subnet <String[]>
-Tag <Hashtable>
-WorkerConfiguration_WorkerConfigurationArn <String>
-ProvisionedCapacity_WorkerCount <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonKafkaConnectConfig>

Description

Creates a connector using the specified properties.

Parameters

-ApacheKafkaCluster_BootstrapServer <String>
The bootstrap servers of the cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKafkaCluster_ApacheKafkaCluster_BootstrapServers
-AutoScaling_MaxWorkerCount <Int32>
The maximum number of workers allocated to the connector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacity_AutoScaling_MaxWorkerCount
-AutoScaling_McuCount <Int32>
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacity_AutoScaling_McuCount
-AutoScaling_MinWorkerCount <Int32>
The minimum number of workers allocated to the connector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacity_AutoScaling_MinWorkerCount
-ClientConfig <AmazonKafkaConnectConfig>
Amazon.PowerShell.Cmdlets.MSKC.AmazonKafkaConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudWatchLogs_Enabled <Boolean>
Whether log delivery to Amazon CloudWatch Logs is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDelivery_WorkerLogDelivery_CloudWatchLogs_Enabled
-CloudWatchLogs_LogGroup <String>
The name of the CloudWatch log group that is the destination for log delivery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDelivery_WorkerLogDelivery_CloudWatchLogs_LogGroup
-ConnectorConfiguration <Hashtable>
A map of keys to values that represent the configuration for the connector. 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)
-ConnectorDescription <String>
A summary description of the connector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectorName <String>
The name of the connector.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Firehose_DeliveryStream <String>
The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDelivery_WorkerLogDelivery_Firehose_DeliveryStream
-Firehose_Enabled <Boolean>
Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDelivery_WorkerLogDelivery_Firehose_Enabled
-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)
-KafkaClusterClientAuthentication_AuthenticationType <KafkaClusterClientAuthenticationType>
The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KafkaClusterEncryptionInTransit_EncryptionType <KafkaClusterEncryptionInTransitType>
The type of encryption in transit to the Apache Kafka cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KafkaConnectVersion <String>
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Plugin <Plugin[]>
Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.Specifies which plugin to use for the connector. You must specify a single-element list containing one customPlugin object. 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)
AliasesPlugins
-ProvisionedCapacity_McuCount <Int32>
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacity_ProvisionedCapacity_McuCount
-ProvisionedCapacity_WorkerCount <Int32>
The number of workers that are allocated to the connector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacity_ProvisionedCapacity_WorkerCount
-S3_Bucket <String>
The name of the S3 bucket that is the destination for log delivery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDelivery_WorkerLogDelivery_S3_Bucket
-S3_Enabled <Boolean>
Specifies whether connector logs get sent to the specified Amazon S3 destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDelivery_WorkerLogDelivery_S3_Enabled
-S3_Prefix <String>
The S3 prefix that is the destination for log delivery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDelivery_WorkerLogDelivery_S3_Prefix
-ScaleInPolicy_CpuUtilizationPercentage <Int32>
Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacity_AutoScaling_ScaleInPolicy_CpuUtilizationPercentage
-ScaleOutPolicy_CpuUtilizationPercentage <Int32>
The CPU utilization percentage threshold at which you want connector scale out to be triggered.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacity_AutoScaling_ScaleOutPolicy_CpuUtilizationPercentage
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KafkaConnect.Model.CreateConnectorResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.CreateConnectorResponse 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 used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags you want to attach to the connector. 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
-Vpc_SecurityGroup <String[]>
The security groups for the connector. 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)
AliasesKafkaCluster_ApacheKafkaCluster_Vpc_SecurityGroups
-Vpc_Subnet <String[]>
The subnets for the connector. 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)
AliasesKafkaCluster_ApacheKafkaCluster_Vpc_Subnets
-WorkerConfiguration_Revision <Int64>
The revision of the worker configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkerConfiguration_WorkerConfigurationArn <String>
The Amazon Resource Name (ARN) of the worker configuration.
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

Amazon.KafkaConnect.Model.CreateConnectorResponse
This cmdlet returns an Amazon.KafkaConnect.Model.CreateConnectorResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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