Describe Cluster Operation V2

kafka_describe_cluster_operation_v2

R Documentation

Returns a description of the cluster operation specified by the ARN

Description

Returns a description of the cluster operation specified by the ARN.

Usage

kafka_describe_cluster_operation_v2(ClusterOperationArn)

Arguments

ClusterOperationArn

[required] ARN of the cluster operation to describe.

Value

A list with the following syntax:

list(
  ClusterOperationInfo = list(
    ClusterArn = "string",
    ClusterType = "PROVISIONED"|"SERVERLESS",
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    ErrorInfo = list(
      ErrorCode = "string",
      ErrorString = "string"
    ),
    OperationArn = "string",
    OperationState = "string",
    OperationType = "string",
    Provisioned = list(
      OperationSteps = list(
        list(
          StepInfo = list(
            StepStatus = "string"
          ),
          StepName = "string"
        )
      ),
      SourceClusterInfo = list(
        BrokerEBSVolumeInfo = list(
          list(
            KafkaBrokerNodeId = "string",
            ProvisionedThroughput = list(
              Enabled = TRUE|FALSE,
              VolumeThroughput = 123
            ),
            VolumeSizeGB = 123
          )
        ),
        ConfigurationInfo = list(
          Arn = "string",
          Revision = 123
        ),
        NumberOfBrokerNodes = 123,
        EnhancedMonitoring = "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|"PER_TOPIC_PER_PARTITION",
        OpenMonitoring = list(
          Prometheus = list(
            JmxExporter = list(
              EnabledInBroker = TRUE|FALSE
            ),
            NodeExporter = list(
              EnabledInBroker = TRUE|FALSE
            )
          )
        ),
        KafkaVersion = "string",
        LoggingInfo = list(
          BrokerLogs = list(
            CloudWatchLogs = list(
              Enabled = TRUE|FALSE,
              LogGroup = "string"
            ),
            Firehose = list(
              DeliveryStream = "string",
              Enabled = TRUE|FALSE
            ),
            S3 = list(
              Bucket = "string",
              Enabled = TRUE|FALSE,
              Prefix = "string"
            )
          )
        ),
        InstanceType = "string",
        ClientAuthentication = list(
          Sasl = list(
            Scram = list(
              Enabled = TRUE|FALSE
            ),
            Iam = list(
              Enabled = TRUE|FALSE
            )
          ),
          Tls = list(
            CertificateAuthorityArnList = list(
              "string"
            ),
            Enabled = TRUE|FALSE
          ),
          Unauthenticated = list(
            Enabled = TRUE|FALSE
          )
        ),
        EncryptionInfo = list(
          EncryptionAtRest = list(
            DataVolumeKMSKeyId = "string"
          ),
          EncryptionInTransit = list(
            ClientBroker = "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
            InCluster = TRUE|FALSE
          )
        ),
        ConnectivityInfo = list(
          PublicAccess = list(
            Type = "string"
          ),
          VpcConnectivity = list(
            ClientAuthentication = list(
              Sasl = list(
                Scram = list(
                  Enabled = TRUE|FALSE
                ),
                Iam = list(
                  Enabled = TRUE|FALSE
                )
              ),
              Tls = list(
                Enabled = TRUE|FALSE
              )
            )
          )
        ),
        StorageMode = "LOCAL"|"TIERED",
        BrokerCountUpdateInfo = list(
          CreatedBrokerIds = list(
            123.0
          ),
          DeletedBrokerIds = list(
            123.0
          )
        )
      ),
      TargetClusterInfo = list(
        BrokerEBSVolumeInfo = list(
          list(
            KafkaBrokerNodeId = "string",
            ProvisionedThroughput = list(
              Enabled = TRUE|FALSE,
              VolumeThroughput = 123
            ),
            VolumeSizeGB = 123
          )
        ),
        ConfigurationInfo = list(
          Arn = "string",
          Revision = 123
        ),
        NumberOfBrokerNodes = 123,
        EnhancedMonitoring = "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|"PER_TOPIC_PER_PARTITION",
        OpenMonitoring = list(
          Prometheus = list(
            JmxExporter = list(
              EnabledInBroker = TRUE|FALSE
            ),
            NodeExporter = list(
              EnabledInBroker = TRUE|FALSE
            )
          )
        ),
        KafkaVersion = "string",
        LoggingInfo = list(
          BrokerLogs = list(
            CloudWatchLogs = list(
              Enabled = TRUE|FALSE,
              LogGroup = "string"
            ),
            Firehose = list(
              DeliveryStream = "string",
              Enabled = TRUE|FALSE
            ),
            S3 = list(
              Bucket = "string",
              Enabled = TRUE|FALSE,
              Prefix = "string"
            )
          )
        ),
        InstanceType = "string",
        ClientAuthentication = list(
          Sasl = list(
            Scram = list(
              Enabled = TRUE|FALSE
            ),
            Iam = list(
              Enabled = TRUE|FALSE
            )
          ),
          Tls = list(
            CertificateAuthorityArnList = list(
              "string"
            ),
            Enabled = TRUE|FALSE
          ),
          Unauthenticated = list(
            Enabled = TRUE|FALSE
          )
        ),
        EncryptionInfo = list(
          EncryptionAtRest = list(
            DataVolumeKMSKeyId = "string"
          ),
          EncryptionInTransit = list(
            ClientBroker = "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
            InCluster = TRUE|FALSE
          )
        ),
        ConnectivityInfo = list(
          PublicAccess = list(
            Type = "string"
          ),
          VpcConnectivity = list(
            ClientAuthentication = list(
              Sasl = list(
                Scram = list(
                  Enabled = TRUE|FALSE
                ),
                Iam = list(
                  Enabled = TRUE|FALSE
                )
              ),
              Tls = list(
                Enabled = TRUE|FALSE
              )
            )
          )
        ),
        StorageMode = "LOCAL"|"TIERED",
        BrokerCountUpdateInfo = list(
          CreatedBrokerIds = list(
            123.0
          ),
          DeletedBrokerIds = list(
            123.0
          )
        )
      ),
      VpcConnectionInfo = list(
        VpcConnectionArn = "string",
        Owner = "string",
        UserIdentity = list(
          Type = "AWSACCOUNT"|"AWSSERVICE",
          PrincipalId = "string"
        ),
        CreationTime = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    Serverless = list(
      VpcConnectionInfo = list(
        CreationTime = as.POSIXct(
          "2015-01-01"
        ),
        Owner = "string",
        UserIdentity = list(
          Type = "AWSACCOUNT"|"AWSSERVICE",
          PrincipalId = "string"
        ),
        VpcConnectionArn = "string"
      )
    )
  )
)

Request syntax

svc$describe_cluster_operation_v2(
  ClusterOperationArn = "string"
)