AWS.Tools.Kafka.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Kafka</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MSK.AddMSKResourceTagCmdlet"> <summary> Adds tags to the specified MSK resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.AddMSKResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.AddMSKResourceTagCmdlet.Tag"> <summary> <para> <para>The key-value pair for the resource tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.AddMSKResourceTagCmdlet.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.Kafka.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.AddMSKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.AddMSKResourceTagCmdlet.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.MSK.GetMSKBootstrapBrokerCmdlet"> <summary> A list of brokers that a client application can use to bootstrap. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKBootstrapBrokerCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKBootstrapBrokerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BootstrapBrokerString'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.GetBootstrapBrokersResponse). Specifying the name of a property of type Amazon.Kafka.Model.GetBootstrapBrokersResponse 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.MSK.GetMSKBootstrapBrokerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterCmdlet"> <summary> Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterInfo'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.DescribeClusterResponse). Specifying the name of a property of type Amazon.Kafka.Model.DescribeClusterResponse 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.MSK.GetMSKClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterListCmdlet"> <summary> Returns a list of all the MSK clusters in the current 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterListCmdlet.ClusterNameFilter"> <summary> <para> <para>Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</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.MSK.GetMSKClusterListCmdlet.NextToken"> <summary> <para> <para>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListClustersResponse). Specifying the name of a property of type Amazon.Kafka.Model.ListClustersResponse 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.MSK.GetMSKClusterListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationCmdlet"> <summary> Returns a description of the cluster operation specified by the ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationCmdlet.ClusterOperationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterOperationInfo'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.DescribeClusterOperationResponse). Specifying the name of a property of type Amazon.Kafka.Model.DescribeClusterOperationResponse 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.MSK.GetMSKClusterOperationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterOperationArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterOperationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationListCmdlet"> <summary> Returns a list of all the operations that have been performed on the specified MSK cluster.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationListCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</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.MSK.GetMSKClusterOperationListCmdlet.NextToken"> <summary> <para> <para>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterOperationInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListClusterOperationsResponse). Specifying the name of a property of type Amazon.Kafka.Model.ListClusterOperationsResponse 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.MSK.GetMSKClusterOperationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterOperationListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKClustersV2ListCmdlet"> <summary> Returns a list of all the MSK clusters in the current 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClustersV2ListCmdlet.ClusterNameFilter"> <summary> <para> <para>Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClustersV2ListCmdlet.ClusterTypeFilter"> <summary> <para> <para>Specify either PROVISIONED or SERVERLESS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClustersV2ListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClustersV2ListCmdlet.NextToken"> <summary> <para> <para>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClustersV2ListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListClustersV2Response). Specifying the name of a property of type Amazon.Kafka.Model.ListClustersV2Response 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.MSK.GetMSKClustersV2ListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterV2Cmdlet"> <summary> Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterV2Cmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterV2Cmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterInfo'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.DescribeClusterV2Response). Specifying the name of a property of type Amazon.Kafka.Model.DescribeClusterV2Response 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.MSK.GetMSKClusterV2Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKCompatibleKafkaVersionCmdlet"> <summary> Gets the Apache Kafka versions to which you can update the MSK cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKCompatibleKafkaVersionCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKCompatibleKafkaVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CompatibleKafkaVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.GetCompatibleKafkaVersionsResponse). Specifying the name of a property of type Amazon.Kafka.Model.GetCompatibleKafkaVersionsResponse 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.MSK.GetMSKCompatibleKafkaVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationCmdlet"> <summary> Returns a description of this MSK configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationCmdlet.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.Kafka.Model.DescribeConfigurationResponse). Specifying the name of a property of type Amazon.Kafka.Model.DescribeConfigurationResponse 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.MSK.GetMSKConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationListCmdlet"> <summary> Returns a list of all the MSK configurations in this 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</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.MSK.GetMSKConfigurationListCmdlet.NextToken"> <summary> <para> <para>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListConfigurationsResponse). Specifying the name of a property of type Amazon.Kafka.Model.ListConfigurationsResponse 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.MSK.GetMSKConfigurationListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionCmdlet"> <summary> Returns a description of this revision of the configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionCmdlet.Revision"> <summary> <para> <para>A string that uniquely identifies a revision of an MSK configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionCmdlet.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.Kafka.Model.DescribeConfigurationRevisionResponse). Specifying the name of a property of type Amazon.Kafka.Model.DescribeConfigurationRevisionResponse 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.MSK.GetMSKConfigurationRevisionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionListCmdlet"> <summary> Returns a list of all the MSK configurations in this 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionListCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</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.MSK.GetMSKConfigurationRevisionListCmdlet.NextToken"> <summary> <para> <para>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Revisions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListConfigurationRevisionsResponse). Specifying the name of a property of type Amazon.Kafka.Model.ListConfigurationRevisionsResponse 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.MSK.GetMSKConfigurationRevisionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKKafkaVersionListCmdlet"> <summary> Returns a list of Apache Kafka versions.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKKafkaVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKKafkaVersionListCmdlet.NextToken"> <summary> <para> <para>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKKafkaVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KafkaVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListKafkaVersionsResponse). Specifying the name of a property of type Amazon.Kafka.Model.ListKafkaVersionsResponse 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.MSK.GetMSKKafkaVersionListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKNodeListCmdlet"> <summary> Returns a list of the broker nodes in the cluster.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKNodeListCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKNodeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</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.MSK.GetMSKNodeListCmdlet.NextToken"> <summary> <para> <para>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKNodeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NodeInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListNodesResponse). Specifying the name of a property of type Amazon.Kafka.Model.ListNodesResponse 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.MSK.GetMSKNodeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKNodeListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKResourceTagCmdlet"> <summary> Returns a list of the tags associated with the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKResourceTagCmdlet.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.Kafka.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Kafka.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="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKScramSecretListCmdlet"> <summary> Returns a list of the Scram Secrets associated with an Amazon MSK cluster.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKScramSecretListCmdlet.ClusterArn"> <summary> <para> <para>The arn of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKScramSecretListCmdlet.MaxResult"> <summary> <para> <para>The maxResults of the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKScramSecretListCmdlet.NextToken"> <summary> <para> <para>The nextToken of the query.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKScramSecretListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecretArnList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.ListScramSecretsResponse). Specifying the name of a property of type Amazon.Kafka.Model.ListScramSecretsResponse 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.MSK.GetMSKScramSecretListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.GetMSKScramSecretListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet"> <summary> Creates a new MSK cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.ConfigurationInfo_Arn"> <summary> <para> <para>ARN of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.BrokerNodeGroupInfo"> <summary> <para> <para>Information about the broker nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.S3_Bucket"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Tls_CertificateAuthorityArnList"> <summary> <para> <para>List of ACM Certificate Authority ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.EncryptionInTransit_ClientBroker"> <summary> <para> <para>Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.</para><para> TLS means that client-broker communication is enabled with TLS only.</para><para> TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.</para><para> PLAINTEXT means that client-broker communication is enabled in plaintext only.</para><para>The default value is TLS_PLAINTEXT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.EncryptionAtRest_DataVolumeKMSKeyId"> <summary> <para> <para>The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Firehose_DeliveryStream"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Iam_Enabled"> <summary> <para> <para>Indicates whether IAM access control is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Scram_Enabled"> <summary> <para> <para>SASL/SCRAM authentication is enabled or not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Tls_Enabled"> <summary> <para> <para>Specifies whether you want to turn on or turn off TLS authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Unauthenticated_Enabled"> <summary> <para> <para>Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.CloudWatchLogs_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Firehose_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.S3_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.JmxExporter_EnabledInBroker"> <summary> <para> <para>Indicates whether you want to turn on or turn off the JMX Exporter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.NodeExporter_EnabledInBroker"> <summary> <para> <para>Indicates whether you want to turn on or turn off the Node Exporter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.EnhancedMonitoring"> <summary> <para> <para>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.EncryptionInTransit_InCluster"> <summary> <para> <para>When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.</para><para>The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.KafkaVersion"> <summary> <para> <para>The version of Apache Kafka.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.CloudWatchLogs_LogGroup"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.NumberOfBrokerNode"> <summary> <para> <para>The number of broker nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.S3_Prefix"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.ConfigurationInfo_Revision"> <summary> <para> <para>The revision of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.Tag"> <summary> <para> <para>Create tags when creating the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.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.Kafka.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.Kafka.Model.CreateClusterResponse 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.MSK.NewMSKClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterCmdlet.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.MSK.NewMSKClusterV2Cmdlet"> <summary> Creates a new MSK cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.ConfigurationInfo_Arn"> <summary> <para> <para>ARN of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Provisioned_BrokerNodeGroupInfo"> <summary> <para> <para>Information about the brokers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.S3_Bucket"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Tls_CertificateAuthorityArnList"> <summary> <para> <para>List of ACM Certificate Authority ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.EncryptionInTransit_ClientBroker"> <summary> <para> <para>Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.</para><para> TLS means that client-broker communication is enabled with TLS only.</para><para> TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.</para><para> PLAINTEXT means that client-broker communication is enabled in plaintext only.</para><para>The default value is TLS_PLAINTEXT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.ClusterName"> <summary> <para> <para>The name of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.EncryptionAtRest_DataVolumeKMSKeyId"> <summary> <para> <para>The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Firehose_DeliveryStream"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Provisioned_ClientAuthentication_Sasl_Iam_Enabled"> <summary> <para> <para>Indicates whether IAM access control is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Scram_Enabled"> <summary> <para> <para>SASL/SCRAM authentication is enabled or not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Tls_Enabled"> <summary> <para> <para>Specifies whether you want to turn on or turn off TLS authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Unauthenticated_Enabled"> <summary> <para> <para>Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.CloudWatchLogs_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Firehose_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.S3_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Serverless_ClientAuthentication_Sasl_Iam_Enabled"> <summary> <para> <para>Indicates whether IAM access control is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.JmxExporter_EnabledInBroker"> <summary> <para> <para>Indicates whether you want to turn on or turn off the JMX Exporter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.NodeExporter_EnabledInBroker"> <summary> <para> <para>Indicates whether you want to turn on or turn off the Node Exporter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Provisioned_EnhancedMonitoring"> <summary> <para> <para>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.EncryptionInTransit_InCluster"> <summary> <para> <para>When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.</para><para>The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Provisioned_KafkaVersion"> <summary> <para> <para>The Apache Kafka version that you want for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.CloudWatchLogs_LogGroup"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Provisioned_NumberOfBrokerNode"> <summary> <para> <para>The number of broker nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.S3_Prefix"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.ConfigurationInfo_Revision"> <summary> <para> <para>The revision of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Tag"> <summary> <para> <para>A map of tags that you want the cluster to have.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.Serverless_VpcConfig"> <summary> <para> <para>The configuration of the Amazon VPCs for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.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.Kafka.Model.CreateClusterV2Response). Specifying the name of a property of type Amazon.Kafka.Model.CreateClusterV2Response 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.MSK.NewMSKClusterV2Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKClusterV2Cmdlet.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.MSK.NewMSKConfigurationCmdlet"> <summary> Creates a new MSK configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKConfigurationCmdlet.Description"> <summary> <para> <para>The description of the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKConfigurationCmdlet.KafkaVersion"> <summary> <para> <para>The versions of Apache Kafka with which you can use this MSK configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKConfigurationCmdlet.Name"> <summary> <para> <para>The name of the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKConfigurationCmdlet.ServerProperty"> <summary> <para> <para>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKConfigurationCmdlet.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.Kafka.Model.CreateConfigurationResponse). Specifying the name of a property of type Amazon.Kafka.Model.CreateConfigurationResponse 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.MSK.NewMSKConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.NewMSKConfigurationCmdlet.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.MSK.RegisterMSKAssociateScramSecretCmdlet"> <summary> Associates one or more Scram Secrets with an Amazon MSK cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RegisterMSKAssociateScramSecretCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RegisterMSKAssociateScramSecretCmdlet.SecretArnList"> <summary> <para> <para>List of AWS Secrets Manager secret ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RegisterMSKAssociateScramSecretCmdlet.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.Kafka.Model.BatchAssociateScramSecretResponse). Specifying the name of a property of type Amazon.Kafka.Model.BatchAssociateScramSecretResponse 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.MSK.RegisterMSKAssociateScramSecretCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RegisterMSKAssociateScramSecretCmdlet.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.MSK.RemoveMSKClusterCmdlet"> <summary> Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKClusterCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKClusterCmdlet.CurrentVersion"> <summary> <para> <para>The current version of the MSK cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKClusterCmdlet.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.Kafka.Model.DeleteClusterResponse). Specifying the name of a property of type Amazon.Kafka.Model.DeleteClusterResponse 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.MSK.RemoveMSKClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKClusterCmdlet.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.MSK.RemoveMSKConfigurationCmdlet"> <summary> Deletes an MSK Configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKConfigurationCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKConfigurationCmdlet.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.Kafka.Model.DeleteConfigurationResponse). Specifying the name of a property of type Amazon.Kafka.Model.DeleteConfigurationResponse 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.MSK.RemoveMSKConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKConfigurationCmdlet.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.MSK.RemoveMSKResourceTagCmdlet"> <summary> Removes the tags associated with the keys that are provided in the query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKResourceTagCmdlet.TagKey"> <summary> <para> <para>Tag keys must be unique for a given cluster. In addition, the following restrictions apply:</para><ul><li><para>Each tag key must be unique. If you add a tag with a key that's already in use, your new tag overwrites the existing key-value pair. </para></li><li><para>You can't start a tag key with aws: because this prefix is reserved for use by AWS. AWS creates tags that begin with this prefix on your behalf, but you can't edit or delete them.</para></li><li><para>Tag keys must be between 1 and 128 Unicode characters in length.</para></li><li><para>Tag keys must consist of the following characters: Unicode letters, digits, white space, and the following special characters: _ . / = + - @.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKResourceTagCmdlet.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.Kafka.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RemoveMSKResourceTagCmdlet.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.MSK.RestartMSKBrokerCmdlet"> <summary> Reboots brokers. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RestartMSKBrokerCmdlet.BrokerId"> <summary> <para> <para>The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RestartMSKBrokerCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RestartMSKBrokerCmdlet.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.Kafka.Model.RebootBrokerResponse). Specifying the name of a property of type Amazon.Kafka.Model.RebootBrokerResponse 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.MSK.RestartMSKBrokerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.RestartMSKBrokerCmdlet.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.MSK.UnregisterMSKDisassociateScramSecretCmdlet"> <summary> Disassociates one or more Scram Secrets from an Amazon MSK cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UnregisterMSKDisassociateScramSecretCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UnregisterMSKDisassociateScramSecretCmdlet.SecretArnList"> <summary> <para> <para>List of AWS Secrets Manager secret ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UnregisterMSKDisassociateScramSecretCmdlet.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.Kafka.Model.BatchDisassociateScramSecretResponse). Specifying the name of a property of type Amazon.Kafka.Model.BatchDisassociateScramSecretResponse 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.MSK.UnregisterMSKDisassociateScramSecretCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UnregisterMSKDisassociateScramSecretCmdlet.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.MSK.UpdateMSKBrokerCountCmdlet"> <summary> Updates the number of broker nodes in the cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerCountCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerCountCmdlet.CurrentVersion"> <summary> <para> <para>The version of cluster to update from. A successful operation will then generate a new version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerCountCmdlet.TargetNumberOfBrokerNode"> <summary> <para> <para>The number of broker nodes that you want the cluster to have after this operation completes successfully.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerCountCmdlet.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.Kafka.Model.UpdateBrokerCountResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateBrokerCountResponse 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.MSK.UpdateMSKBrokerCountCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerCountCmdlet.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.MSK.UpdateMSKBrokerStorageCmdlet"> <summary> Updates the EBS storage associated with MSK brokers. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerStorageCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerStorageCmdlet.CurrentVersion"> <summary> <para> <para>The version of cluster to update from. A successful operation will then generate a new version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerStorageCmdlet.TargetBrokerEBSVolumeInfo"> <summary> <para> <para>Describes the target volume size and the ID of the broker to apply the update to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerStorageCmdlet.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.Kafka.Model.UpdateBrokerStorageResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateBrokerStorageResponse 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.MSK.UpdateMSKBrokerStorageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerStorageCmdlet.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.MSK.UpdateMSKBrokerTypeCmdlet"> <summary> Updates EC2 instance type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerTypeCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerTypeCmdlet.CurrentVersion"> <summary> <para> <para>The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerTypeCmdlet.TargetInstanceType"> <summary> <para> <para>The Amazon MSK broker type that you want all of the brokers in this cluster to be.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerTypeCmdlet.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.Kafka.Model.UpdateBrokerTypeResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateBrokerTypeResponse 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.MSK.UpdateMSKBrokerTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKBrokerTypeCmdlet.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.MSK.UpdateMSKClusterConfigurationCmdlet"> <summary> Updates the cluster with the configuration that is specified in the request body. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterConfigurationCmdlet.ConfigurationInfo_Arn"> <summary> <para> <para>ARN of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterConfigurationCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterConfigurationCmdlet.CurrentVersion"> <summary> <para> <para>The version of the cluster that needs to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterConfigurationCmdlet.ConfigurationInfo_Revision"> <summary> <para> <para>The revision of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterConfigurationCmdlet.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.Kafka.Model.UpdateClusterConfigurationResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateClusterConfigurationResponse 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.MSK.UpdateMSKClusterConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterConfigurationCmdlet.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.MSK.UpdateMSKClusterKafkaVersionCmdlet"> <summary> Updates the Apache Kafka version for the cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterKafkaVersionCmdlet.ConfigurationInfo_Arn"> <summary> <para> <para>ARN of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterKafkaVersionCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterKafkaVersionCmdlet.CurrentVersion"> <summary> <para> <para>Current cluster version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterKafkaVersionCmdlet.ConfigurationInfo_Revision"> <summary> <para> <para>The revision of the configuration to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterKafkaVersionCmdlet.TargetKafkaVersion"> <summary> <para> <para>Target Kafka version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterKafkaVersionCmdlet.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.Kafka.Model.UpdateClusterKafkaVersionResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateClusterKafkaVersionResponse 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.MSK.UpdateMSKClusterKafkaVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKClusterKafkaVersionCmdlet.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.MSK.UpdateMSKConfigurationCmdlet"> <summary> Updates an MSK configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConfigurationCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConfigurationCmdlet.Description"> <summary> <para> <para>The description of the configuration revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConfigurationCmdlet.ServerProperty"> <summary> <para> <para>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConfigurationCmdlet.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.Kafka.Model.UpdateConfigurationResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateConfigurationResponse 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.MSK.UpdateMSKConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConfigurationCmdlet.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.MSK.UpdateMSKConnectivityCmdlet"> <summary> Updates the cluster's connectivity configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConnectivityCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConnectivityCmdlet.CurrentVersion"> <summary> <para> <para>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConnectivityCmdlet.PublicAccess_Type"> <summary> <para> <para>The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConnectivityCmdlet.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.Kafka.Model.UpdateConnectivityResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateConnectivityResponse 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.MSK.UpdateMSKConnectivityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKConnectivityCmdlet.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.MSK.UpdateMSKMonitoringCmdlet"> <summary> Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.S3_Bucket"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.CurrentVersion"> <summary> <para> <para>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.Firehose_DeliveryStream"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.CloudWatchLogs_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.Firehose_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.S3_Enabled"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.JmxExporter_EnabledInBroker"> <summary> <para> <para>Indicates whether you want to turn on or turn off the JMX Exporter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.NodeExporter_EnabledInBroker"> <summary> <para> <para>Indicates whether you want to turn on or turn off the Node Exporter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.EnhancedMonitoring"> <summary> <para> <para>Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.CloudWatchLogs_LogGroup"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.S3_Prefix"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.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.Kafka.Model.UpdateMonitoringResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateMonitoringResponse 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.MSK.UpdateMSKMonitoringCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKMonitoringCmdlet.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.MSK.UpdateMSKSecurityCmdlet"> <summary> Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.Tls_CertificateAuthorityArnList"> <summary> <para> <para>List of ACM Certificate Authority ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.EncryptionInTransit_ClientBroker"> <summary> <para> <para>Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.</para><para> TLS means that client-broker communication is enabled with TLS only.</para><para> TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.</para><para> PLAINTEXT means that client-broker communication is enabled in plaintext only.</para><para>The default value is TLS_PLAINTEXT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.CurrentVersion"> <summary> <para> <para>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.EncryptionAtRest_DataVolumeKMSKeyId"> <summary> <para> <para>The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.Iam_Enabled"> <summary> <para> <para>Indicates whether IAM access control is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.Scram_Enabled"> <summary> <para> <para>SASL/SCRAM authentication is enabled or not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.Tls_Enabled"> <summary> <para> <para>Specifies whether you want to turn on or turn off TLS authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.Unauthenticated_Enabled"> <summary> <para> <para>Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.EncryptionInTransit_InCluster"> <summary> <para> <para>When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.</para><para>The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.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.Kafka.Model.UpdateSecurityResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateSecurityResponse 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.MSK.UpdateMSKSecurityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MSK.UpdateMSKSecurityCmdlet.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> |