Class KafkaCluster

A KafkaCluster is a description of a KafkaCluster.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance

object

KafkaCluster

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ManagedkafkaService.Models

Assembly: OCI.DotNetSDK.Managedkafka.dll

Syntax

public class KafkaCluster

Properties

AccessSubnets

Declaration

[Required(ErrorMessage = "AccessSubnets is required.")]
[JsonProperty(PropertyName = "accessSubnets")]
public List<SubnetSet> AccessSubnets { get; set; }

Property Value

Type	Description
List<SubnetSet>	Subnets where broker/coordinator VNICs will be created.

Remarks

Required

BrokerShape

Declaration

[Required(ErrorMessage = "BrokerShape is required.")]
[JsonProperty(PropertyName = "brokerShape")]
public BrokerShape BrokerShape { get; set; }

Property Value

Type	Description
BrokerShape

Remarks

Required

ClientCertificateBundle

Declaration

[JsonProperty(PropertyName = "clientCertificateBundle")]
public string ClientCertificateBundle { get; set; }

Property Value

Type	Description
string	CA certificate bundle for mTLS broker authentication.

ClusterConfigId

Declaration

[Required(ErrorMessage = "ClusterConfigId is required.")]
[JsonProperty(PropertyName = "clusterConfigId")]
public string ClusterConfigId { get; set; }

Property Value

Type	Description
string	The OCID of Kafka Cluster configuration object

Remarks

Required

ClusterConfigVersion

Declaration

[Required(ErrorMessage = "ClusterConfigVersion is required.")]
[JsonProperty(PropertyName = "clusterConfigVersion")]
public int? ClusterConfigVersion { get; set; }

Property Value

Type	Description
int?	The version of configuration object

Remarks

Required

ClusterType

Declaration

[Required(ErrorMessage = "ClusterType is required.")]
[JsonProperty(PropertyName = "clusterType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KafkaCluster.ClusterTypeEnum? ClusterType { get; set; }

Property Value

Type	Description
KafkaCluster.ClusterTypeEnum?	Type of the cluster to spin up. DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on a single node PRODUCTION - Minimum allowed broker count is 3

Remarks

Required

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

CoordinationType

Declaration

[JsonProperty(PropertyName = "coordinationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KafkaCluster.CoordinationTypeEnum? CoordinationType { get; set; }

Property Value

Type	Description
KafkaCluster.CoordinationTypeEnum?	Kafka coordination type. Set of available types depends on Kafka version

DefinedTags

Declaration

[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable.

Remarks

Required

FreeformTags

Declaration

[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the KafkaCluster.

Remarks

Required

KafkaBootstrapUrls

Declaration

[JsonProperty(PropertyName = "kafkaBootstrapUrls")]
public List<BootstrapUrl> KafkaBootstrapUrls { get; set; }

Property Value

Type	Description
List<BootstrapUrl>	Bootstrap URL that can be used to connect to Kafka

KafkaVersion

Declaration

[Required(ErrorMessage = "KafkaVersion is required.")]
[JsonProperty(PropertyName = "kafkaVersion")]
public string KafkaVersion { get; set; }

Property Value

Type	Description
string	Version of Kafka to use to spin up the cluster

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message that describes the current state of the KafkaCluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KafkaCluster.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
KafkaCluster.LifecycleStateEnum?	The current state of the KafkaCluster.

Remarks

Required

SecretId

Declaration

[JsonProperty(PropertyName = "secretId")]
public string SecretId { get; set; }

Property Value

Type	Description
string	The OCID of the secret that contains superuser password.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the KafkaCluster was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the KafkaCluster was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z