AWS.Tools.KafkaConnect.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.KafkaConnect</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.AddMSKCResourceTagCmdlet"> <summary> Attaches tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.AddMSKCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to which you want to attach tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.AddMSKCResourceTagCmdlet.Tag"> <summary> <para> <para>The tags that you want to attach to the resource.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.AddMSKCResourceTagCmdlet.Select"> <summary> 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.KafkaConnect.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.AddMSKCResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorCmdlet"> <summary> Returns summary information about the connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorCmdlet.ConnectorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the connector that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorCmdlet.Select"> <summary> 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.DescribeConnectorResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.DescribeConnectorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorListCmdlet"> <summary> Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorListCmdlet.ConnectorNamePrefix"> <summary> <para> <para>The name prefix that you want to use to search for and list connectors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of connectors to list in one response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorListCmdlet.NextToken"> <summary> <para> <para>If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connectors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KafkaConnect.Model.ListConnectorsResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.ListConnectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationCmdlet"> <summary> Returns information about the specified connector's operations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationCmdlet.ConnectorOperationArn"> <summary> <para> <para>ARN of the connector operation to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationCmdlet.Select"> <summary> 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.DescribeConnectorOperationResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.DescribeConnectorOperationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationListCmdlet"> <summary> Lists information about a connector's operation(s).<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationListCmdlet.ConnectorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the connector for which to list operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of connector operations to fetch in one get request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationListCmdlet.NextToken"> <summary> <para> <para>If the response is truncated, it includes a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConnectorOperations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KafkaConnect.Model.ListConnectorOperationsResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.ListConnectorOperationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCConnectorOperationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginCmdlet"> <summary> A summary description of the custom plugin. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginCmdlet.CustomPluginArn"> <summary> <para> <para>Returns information about a custom plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginCmdlet.Select"> <summary> 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.DescribeCustomPluginResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.DescribeCustomPluginResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginListCmdlet"> <summary> Returns a list of all of the custom plugins in this account and Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginListCmdlet.NamePrefix"> <summary> <para> <para>Lists custom plugin names that start with the specified text string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of custom plugins to list in one response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginListCmdlet.NextToken"> <summary> <para> <para>If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CustomPlugins'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KafkaConnect.Model.ListCustomPluginsResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.ListCustomPluginsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCCustomPluginListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCResourceTagCmdlet"> <summary> Lists all the tags attached to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which you want to list all attached tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KafkaConnect.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationCmdlet"> <summary> Returns information about a worker configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationCmdlet.WorkerConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationCmdlet.Select"> <summary> 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.DescribeWorkerConfigurationResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.DescribeWorkerConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationListCmdlet"> <summary> Returns a list of all of the worker configurations in this account and Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationListCmdlet.NamePrefix"> <summary> <para> <para>Lists worker configuration names that start with the specified text string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of worker configurations to list in one response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationListCmdlet.NextToken"> <summary> <para> <para>If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkerConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KafkaConnect.Model.ListWorkerConfigurationsResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.ListWorkerConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.GetMSKCWorkerConfigurationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet"> <summary> Creates a connector using the specified properties. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.KafkaClusterClientAuthentication_AuthenticationType"> <summary> <para> <para>The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ApacheKafkaCluster_BootstrapServer"> <summary> <para> <para>The bootstrap servers of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.S3_Bucket"> <summary> <para> <para>The name of the S3 bucket that is the destination for log delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ConnectorConfiguration"> <summary> <para> <para>A map of keys to values that represent the configuration for the connector.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ConnectorDescription"> <summary> <para> <para>A summary description of the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ConnectorName"> <summary> <para> <para>The name of the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ScaleInPolicy_CpuUtilizationPercentage"> <summary> <para> <para>Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ScaleOutPolicy_CpuUtilizationPercentage"> <summary> <para> <para>The CPU utilization percentage threshold at which you want connector scale out to be triggered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Firehose_DeliveryStream"> <summary> <para> <para>The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.CloudWatchLogs_Enabled"> <summary> <para> <para>Whether log delivery to Amazon CloudWatch Logs is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Firehose_Enabled"> <summary> <para> <para>Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.S3_Enabled"> <summary> <para> <para>Specifies whether connector logs get sent to the specified Amazon S3 destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.KafkaClusterEncryptionInTransit_EncryptionType"> <summary> <para> <para>The type of encryption in transit to the Apache Kafka cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.KafkaConnectVersion"> <summary> <para> <para>The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.CloudWatchLogs_LogGroup"> <summary> <para> <para>The name of the CloudWatch log group that is the destination for log delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.AutoScaling_MaxWorkerCount"> <summary> <para> <para>The maximum number of workers allocated to the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.AutoScaling_McuCount"> <summary> <para> <para>The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ProvisionedCapacity_McuCount"> <summary> <para> <para>The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.AutoScaling_MinWorkerCount"> <summary> <para> <para>The minimum number of workers allocated to the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Plugin"> <summary> <para> <important><para>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.</para></important><para>Specifies which plugin to use for the connector. You must specify a single-element list containing one <c>customPlugin</c> object.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.S3_Prefix"> <summary> <para> <para>The S3 prefix that is the destination for log delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.WorkerConfiguration_Revision"> <summary> <para> <para>The revision of the worker configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Vpc_SecurityGroup"> <summary> <para> <para>The security groups for the connector.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ServiceExecutionRoleArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Vpc_Subnet"> <summary> <para> <para>The subnets for the connector.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Tag"> <summary> <para> <para>The tags you want to attach to the connector.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.WorkerConfiguration_WorkerConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the worker configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.ProvisionedCapacity_WorkerCount"> <summary> <para> <para>The number of workers that are allocated to the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCConnectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet"> <summary> Creates a custom plugin using the specified properties. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.S3Location_BucketArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.ContentType"> <summary> <para> <para>The type of the plugin file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.Description"> <summary> <para> <para>A summary description of the custom plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.S3Location_FileKey"> <summary> <para> <para>The file key for an object in an S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.Name"> <summary> <para> <para>The name of the custom plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.S3Location_ObjectVersion"> <summary> <para> <para>The version of an object in an S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.Tag"> <summary> <para> <para>The tags you want to attach to the custom plugin.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.Select"> <summary> 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.CreateCustomPluginResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.CreateCustomPluginResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCCustomPluginCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCWorkerConfigurationCmdlet"> <summary> Creates a worker configuration using the specified properties. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCWorkerConfigurationCmdlet.Description"> <summary> <para> <para>A summary description of the worker configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCWorkerConfigurationCmdlet.Name"> <summary> <para> <para>The name of the worker configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCWorkerConfigurationCmdlet.PropertiesFileContent"> <summary> <para> <para>Base64 encoded contents of connect-distributed.properties file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCWorkerConfigurationCmdlet.Tag"> <summary> <para> <para>The tags you want to attach to the worker configuration.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCWorkerConfigurationCmdlet.Select"> <summary> 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.CreateWorkerConfigurationResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.CreateWorkerConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.NewMSKCWorkerConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCConnectorCmdlet"> <summary> Deletes the specified connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCConnectorCmdlet.ConnectorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the connector that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCConnectorCmdlet.CurrentVersion"> <summary> <para> <para>The current version of the connector that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCConnectorCmdlet.Select"> <summary> 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.DeleteConnectorResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.DeleteConnectorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCConnectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCCustomPluginCmdlet"> <summary> Deletes a custom plugin. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCCustomPluginCmdlet.CustomPluginArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the custom plugin that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCCustomPluginCmdlet.Select"> <summary> 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.DeleteCustomPluginResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.DeleteCustomPluginResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCCustomPluginCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCResourceTagCmdlet"> <summary> Removes tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource from which you want to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags that you want to remove from the resource.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCResourceTagCmdlet.Select"> <summary> 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.KafkaConnect.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCWorkerConfigurationCmdlet"> <summary> Deletes the specified worker configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCWorkerConfigurationCmdlet.WorkerConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the worker configuration that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCWorkerConfigurationCmdlet.Select"> <summary> 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.DeleteWorkerConfigurationResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.DeleteWorkerConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.RemoveMSKCWorkerConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet"> <summary> Updates the specified connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.ConnectorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the connector that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.ConnectorConfiguration"> <summary> <para> <para>A map of keys to values that represent the configuration for the connector.</para><para /> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.ScaleInPolicy_CpuUtilizationPercentage"> <summary> <para> <para>The target CPU utilization percentage threshold at which you want connector scale in to be triggered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.ScaleOutPolicy_CpuUtilizationPercentage"> <summary> <para> <para>The target CPU utilization percentage threshold at which you want connector scale out to be triggered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.CurrentVersion"> <summary> <para> <para>The current version of the connector that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.AutoScaling_MaxWorkerCount"> <summary> <para> <para>The target maximum number of workers allocated to the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.AutoScaling_McuCount"> <summary> <para> <para>The target number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.ProvisionedCapacity_McuCount"> <summary> <para> <para>The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.AutoScaling_MinWorkerCount"> <summary> <para> <para>The target minimum number of workers allocated to the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.ProvisionedCapacity_WorkerCount"> <summary> <para> <para>The number of workers that are allocated to the connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.Select"> <summary> 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.UpdateConnectorResponse). Specifying the name of a property of type Amazon.KafkaConnect.Model.UpdateConnectorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSKC.UpdateMSKCConnectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |