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.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </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="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="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKClusterListCmdlet"> <summary> Returns a list of all the MSK clusters in the current Region.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </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="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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </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="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationListCmdlet"> <summary> Returns a list of all the MSK configurations in this Region.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </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="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKConfigurationRevisionListCmdlet"> <summary> Returns a list of all the MSK configurations in this Region.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MSK.GetMSKNodeListCmdlet"> <summary> Returns a list of the broker nodes in the cluster.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </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="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.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.EnhancedMonitoring"> <summary> <para> <para>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.</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.NumberOfBrokerNode"> <summary> <para> <para>The number of broker nodes in the cluster.</para> </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.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> </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.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.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.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </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.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.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.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> |