CreateKafkaClusterDetails

class oci.managed_kafka.models.CreateKafkaClusterDetails(**kwargs)

Bases: object

The data to create a KafkaCluster.

Methods

__init__(**kwargs) Initializes a new CreateKafkaClusterDetails object with values from keyword arguments.

Attributes

access_subnets [Required] Gets the access_subnets of this CreateKafkaClusterDetails.
broker_shape [Required] Gets the broker_shape of this CreateKafkaClusterDetails.
client_certificate_bundle Gets the client_certificate_bundle of this CreateKafkaClusterDetails.
cluster_config_id [Required] Gets the cluster_config_id of this CreateKafkaClusterDetails.
cluster_config_version [Required] Gets the cluster_config_version of this CreateKafkaClusterDetails.
cluster_type [Required] Gets the cluster_type of this CreateKafkaClusterDetails.
compartment_id [Required] Gets the compartment_id of this CreateKafkaClusterDetails.
coordination_type [Required] Gets the coordination_type of this CreateKafkaClusterDetails.
defined_tags Gets the defined_tags of this CreateKafkaClusterDetails.
display_name Gets the display_name of this CreateKafkaClusterDetails.
freeform_tags Gets the freeform_tags of this CreateKafkaClusterDetails.
kafka_version [Required] Gets the kafka_version of this CreateKafkaClusterDetails.
__init__(**kwargs)

Initializes a new CreateKafkaClusterDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • display_name (str) – The value to assign to the display_name property of this CreateKafkaClusterDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateKafkaClusterDetails.
  • access_subnets (list[oci.managed_kafka.models.SubnetSet]) – The value to assign to the access_subnets property of this CreateKafkaClusterDetails.
  • client_certificate_bundle (str) – The value to assign to the client_certificate_bundle property of this CreateKafkaClusterDetails.
  • kafka_version (str) – The value to assign to the kafka_version property of this CreateKafkaClusterDetails.
  • cluster_type (str) – The value to assign to the cluster_type property of this CreateKafkaClusterDetails.
  • broker_shape (oci.managed_kafka.models.BrokerShape) – The value to assign to the broker_shape property of this CreateKafkaClusterDetails.
  • cluster_config_id (str) – The value to assign to the cluster_config_id property of this CreateKafkaClusterDetails.
  • cluster_config_version (int) – The value to assign to the cluster_config_version property of this CreateKafkaClusterDetails.
  • coordination_type (str) – The value to assign to the coordination_type property of this CreateKafkaClusterDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateKafkaClusterDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateKafkaClusterDetails.
access_subnets

[Required] Gets the access_subnets of this CreateKafkaClusterDetails. Subnets where broker/coordinator VNICs will be created.

Returns:The access_subnets of this CreateKafkaClusterDetails.
Return type:list[oci.managed_kafka.models.SubnetSet]
broker_shape

[Required] Gets the broker_shape of this CreateKafkaClusterDetails.

Returns:The broker_shape of this CreateKafkaClusterDetails.
Return type:oci.managed_kafka.models.BrokerShape
client_certificate_bundle

Gets the client_certificate_bundle of this CreateKafkaClusterDetails. CA certificate bundle for mTLS broker authentication.

Returns:The client_certificate_bundle of this CreateKafkaClusterDetails.
Return type:str
cluster_config_id

[Required] Gets the cluster_config_id of this CreateKafkaClusterDetails. The OCID of Kafka Cluster configuration object

Returns:The cluster_config_id of this CreateKafkaClusterDetails.
Return type:str
cluster_config_version

[Required] Gets the cluster_config_version of this CreateKafkaClusterDetails. The version of configuration object

Returns:The cluster_config_version of this CreateKafkaClusterDetails.
Return type:int
cluster_type

[Required] Gets the cluster_type of this CreateKafkaClusterDetails. Type of the cluster to spin up. DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node PRODUCTION - Minimum allowed broker count is 3

Returns:The cluster_type of this CreateKafkaClusterDetails.
Return type:str
compartment_id

[Required] Gets the compartment_id of this CreateKafkaClusterDetails. The OCID of the compartment to create the KafkaCluster in.

Returns:The compartment_id of this CreateKafkaClusterDetails.
Return type:str
coordination_type

[Required] Gets the coordination_type of this CreateKafkaClusterDetails. Kafka coordination type. Set of available types depends on Kafka version

Returns:The coordination_type of this CreateKafkaClusterDetails.
Return type:str
defined_tags

Gets the defined_tags of this CreateKafkaClusterDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:The defined_tags of this CreateKafkaClusterDetails.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this CreateKafkaClusterDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this CreateKafkaClusterDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateKafkaClusterDetails. 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”}

Returns:The freeform_tags of this CreateKafkaClusterDetails.
Return type:dict(str, str)
kafka_version

[Required] Gets the kafka_version of this CreateKafkaClusterDetails. Version of Kafka to use to spin up the cluster

Returns:The kafka_version of this CreateKafkaClusterDetails.
Return type:str