describe-cluster-operation¶
Description¶
Returns a description of the cluster operation specified by the ARN.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-cluster-operation
--cluster-operation-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--cluster-operation-arn (string)
The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
ClusterOperationInfo -> (structure)
Cluster operation information
ClientRequestId -> (string)
The ID of the API request that triggered this operation.
ClusterArn -> (string)
ARN of the cluster.
CreationTime -> (timestamp)
The time that the operation was created.
EndTime -> (timestamp)
The time at which the operation finished.
ErrorInfo -> (structure)
Describes the error if the operation fails.
ErrorCode -> (string)
A number describing the error programmatically.
ErrorString -> (string)
An optional field to provide more details about the error.
OperationArn -> (string)
ARN of the cluster operation.
OperationState -> (string)
State of the cluster operation.
OperationSteps -> (list)
Steps completed during the operation.
(structure)
Step taken during a cluster operation.
StepInfo -> (structure)
Information about the step and its status.
StepStatus -> (string)
The steps current status.
StepName -> (string)
The name of the step.
OperationType -> (string)
Type of the cluster operation.
SourceClusterInfo -> (structure)
Information about cluster attributes before a cluster is updated.
BrokerEBSVolumeInfo -> (list)
Specifies the size of the EBS volume and the ID of the associated broker.
(structure)
Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
KafkaBrokerNodeId -> (string)
The ID of the broker to update.
VolumeSizeGB -> (integer)
Size of the EBS volume to update.
ConfigurationInfo -> (structure)
Information about the changes in the configuration of the brokers.
Arn -> (string)
ARN of the configuration to use.
Revision -> (long)
The revision of the configuration to use.
NumberOfBrokerNodes -> (integer)
The number of broker nodes in the cluster.
EnhancedMonitoring -> (string)
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring -> (structure)
The settings for open monitoring.
Prometheus -> (structure)
Prometheus settings.
JmxExporter -> (structure)
Indicates whether you want to enable or disable the JMX Exporter.
EnabledInBroker -> (boolean)
Indicates whether you want to enable or disable the JMX Exporter.
NodeExporter -> (structure)
Indicates whether you want to enable or disable the Node Exporter.
EnabledInBroker -> (boolean)
Indicates whether you want to enable or disable the Node Exporter.
KafkaVersion -> (string)
The Kafka version.
LoggingInfo -> (structure)
You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
BrokerLogs -> (structure)
CloudWatchLogs -> (structure)
Enabled -> (boolean)
LogGroup -> (string)
Firehose -> (structure)
DeliveryStream -> (string)
Enabled -> (boolean)
S3 -> (structure)
Bucket -> (string)
Enabled -> (boolean)
Prefix -> (string)
InstanceType -> (string)
Information about the Amazon MSK broker type.
ClientAuthentication -> (structure)
Includes all client authentication information.
Sasl -> (structure)
Details for ClientAuthentication using SASL.
Scram -> (structure)
Details for SASL/SCRAM client authentication.
Enabled -> (boolean)
SASL/SCRAM authentication is enabled or not.
Iam -> (structure)
Indicates whether IAM access control is enabled.
Enabled -> (boolean)
Indicates whether IAM access control is enabled.
Tls -> (structure)
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList -> (list)
List of ACM Certificate Authority ARNs.
(string)
Enabled -> (boolean)
Specifies whether you want to enable or disable TLS authentication.
Unauthenticated -> (structure)
Contains information about unauthenticated traffic to the cluster.
Enabled -> (boolean)
Specifies whether you want to enable or disable unauthenticated traffic to your cluster.
EncryptionInfo -> (structure)
Includes all encryption-related information.
EncryptionAtRest -> (structure)
The data-volume encryption details.
DataVolumeKMSKeyId -> (string)
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.
EncryptionInTransit -> (structure)
The details for encryption in transit.
ClientBroker -> (string)
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
TLS means that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT means that client-broker communication is enabled in plaintext only.
The default value is TLS_PLAINTEXT.
InCluster -> (boolean)
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.
The default value is true.
TargetClusterInfo -> (structure)
Information about cluster attributes after a cluster is updated.
BrokerEBSVolumeInfo -> (list)
Specifies the size of the EBS volume and the ID of the associated broker.
(structure)
Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
KafkaBrokerNodeId -> (string)
The ID of the broker to update.
VolumeSizeGB -> (integer)
Size of the EBS volume to update.
ConfigurationInfo -> (structure)
Information about the changes in the configuration of the brokers.
Arn -> (string)
ARN of the configuration to use.
Revision -> (long)
The revision of the configuration to use.
NumberOfBrokerNodes -> (integer)
The number of broker nodes in the cluster.
EnhancedMonitoring -> (string)
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring -> (structure)
The settings for open monitoring.
Prometheus -> (structure)
Prometheus settings.
JmxExporter -> (structure)
Indicates whether you want to enable or disable the JMX Exporter.
EnabledInBroker -> (boolean)
Indicates whether you want to enable or disable the JMX Exporter.
NodeExporter -> (structure)
Indicates whether you want to enable or disable the Node Exporter.
EnabledInBroker -> (boolean)
Indicates whether you want to enable or disable the Node Exporter.
KafkaVersion -> (string)
The Kafka version.
LoggingInfo -> (structure)
You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
BrokerLogs -> (structure)
CloudWatchLogs -> (structure)
Enabled -> (boolean)
LogGroup -> (string)
Firehose -> (structure)
DeliveryStream -> (string)
Enabled -> (boolean)
S3 -> (structure)
Bucket -> (string)
Enabled -> (boolean)
Prefix -> (string)
InstanceType -> (string)
Information about the Amazon MSK broker type.
ClientAuthentication -> (structure)
Includes all client authentication information.
Sasl -> (structure)
Details for ClientAuthentication using SASL.
Scram -> (structure)
Details for SASL/SCRAM client authentication.
Enabled -> (boolean)
SASL/SCRAM authentication is enabled or not.
Iam -> (structure)
Indicates whether IAM access control is enabled.
Enabled -> (boolean)
Indicates whether IAM access control is enabled.
Tls -> (structure)
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList -> (list)
List of ACM Certificate Authority ARNs.
(string)
Enabled -> (boolean)
Specifies whether you want to enable or disable TLS authentication.
Unauthenticated -> (structure)
Contains information about unauthenticated traffic to the cluster.
Enabled -> (boolean)
Specifies whether you want to enable or disable unauthenticated traffic to your cluster.
EncryptionInfo -> (structure)
Includes all encryption-related information.
EncryptionAtRest -> (structure)
The data-volume encryption details.
DataVolumeKMSKeyId -> (string)
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.
EncryptionInTransit -> (structure)
The details for encryption in transit.
ClientBroker -> (string)
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
TLS means that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT means that client-broker communication is enabled in plaintext only.
The default value is TLS_PLAINTEXT.
InCluster -> (boolean)
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.
The default value is true.