KafkaCluster¶

class oci.managed_kafka.models.KafkaCluster(**kwargs)¶

Bases: object

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.

Attributes

`CLUSTER_TYPE_DEVELOPMENT`	A constant which can be used with the cluster_type property of a KafkaCluster.
`CLUSTER_TYPE_PRODUCTION`	A constant which can be used with the cluster_type property of a KafkaCluster.
`COORDINATION_TYPE_KRAFT`	A constant which can be used with the coordination_type property of a KafkaCluster.
`COORDINATION_TYPE_ZOOKEEPER`	A constant which can be used with the coordination_type property of a KafkaCluster.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a KafkaCluster.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a KafkaCluster.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a KafkaCluster.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a KafkaCluster.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a KafkaCluster.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a KafkaCluster.
`access_subnets`	[Required] Gets the access_subnets of this KafkaCluster.
`broker_shape`	[Required] Gets the broker_shape of this KafkaCluster.
`client_certificate_bundle`	Gets the client_certificate_bundle of this KafkaCluster.
`cluster_config_id`	[Required] Gets the cluster_config_id of this KafkaCluster.
`cluster_config_version`	[Required] Gets the cluster_config_version of this KafkaCluster.
`cluster_type`	[Required] Gets the cluster_type of this KafkaCluster.
`compartment_id`	[Required] Gets the compartment_id of this KafkaCluster.
`coordination_type`	Gets the coordination_type of this KafkaCluster.
`defined_tags`	[Required] Gets the defined_tags of this KafkaCluster.
`display_name`	[Required] Gets the display_name of this KafkaCluster.
`freeform_tags`	[Required] Gets the freeform_tags of this KafkaCluster.
`id`	[Required] Gets the id of this KafkaCluster.
`kafka_bootstrap_urls`	Gets the kafka_bootstrap_urls of this KafkaCluster.
`kafka_version`	[Required] Gets the kafka_version of this KafkaCluster.
`lifecycle_details`	Gets the lifecycle_details of this KafkaCluster.
`lifecycle_state`	[Required] Gets the lifecycle_state of this KafkaCluster.
`secret_id`	Gets the secret_id of this KafkaCluster.
`system_tags`	Gets the system_tags of this KafkaCluster.
`time_created`	[Required] Gets the time_created of this KafkaCluster.
`time_updated`	Gets the time_updated of this KafkaCluster.

Methods

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

CLUSTER_TYPE_DEVELOPMENT = 'DEVELOPMENT'¶: A constant which can be used with the cluster_type property of a KafkaCluster. This constant has a value of “DEVELOPMENT”

CLUSTER_TYPE_PRODUCTION = 'PRODUCTION'¶: A constant which can be used with the cluster_type property of a KafkaCluster. This constant has a value of “PRODUCTION”

COORDINATION_TYPE_KRAFT = 'KRAFT'¶: A constant which can be used with the coordination_type property of a KafkaCluster. This constant has a value of “KRAFT”

COORDINATION_TYPE_ZOOKEEPER = 'ZOOKEEPER'¶: A constant which can be used with the coordination_type property of a KafkaCluster. This constant has a value of “ZOOKEEPER”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a KafkaCluster. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a KafkaCluster. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a KafkaCluster. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a KafkaCluster. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a KafkaCluster. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a KafkaCluster. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this KafkaCluster.
display_name (str) – The value to assign to the display_name property of this KafkaCluster.
compartment_id (str) – The value to assign to the compartment_id property of this KafkaCluster.
time_created (datetime) – The value to assign to the time_created property of this KafkaCluster.
time_updated (datetime) – The value to assign to the time_updated property of this KafkaCluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this KafkaCluster. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this KafkaCluster.
access_subnets (list[oci.managed_kafka.models.SubnetSet]) – The value to assign to the access_subnets property of this KafkaCluster.
client_certificate_bundle (str) – The value to assign to the client_certificate_bundle property of this KafkaCluster.
kafka_version (str) – The value to assign to the kafka_version property of this KafkaCluster.
cluster_type (str) – The value to assign to the cluster_type property of this KafkaCluster. Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
broker_shape (oci.managed_kafka.models.BrokerShape) – The value to assign to the broker_shape property of this KafkaCluster.
cluster_config_id (str) – The value to assign to the cluster_config_id property of this KafkaCluster.
cluster_config_version (int) – The value to assign to the cluster_config_version property of this KafkaCluster.
kafka_bootstrap_urls (list[oci.managed_kafka.models.BootstrapUrl]) – The value to assign to the kafka_bootstrap_urls property of this KafkaCluster.
coordination_type (str) – The value to assign to the coordination_type property of this KafkaCluster. Allowed values for this property are: “ZOOKEEPER”, “KRAFT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
secret_id (str) – The value to assign to the secret_id property of this KafkaCluster.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KafkaCluster.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KafkaCluster.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this KafkaCluster.

access_subnets¶

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

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

broker_shape¶

[Required] Gets the broker_shape of this KafkaCluster.

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

client_certificate_bundle¶

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

Returns:	The client_certificate_bundle of this KafkaCluster.
Return type:	str

cluster_config_id¶

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

Returns:	The cluster_config_id of this KafkaCluster.
Return type:	str

cluster_config_version¶

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

Returns:	The cluster_config_version of this KafkaCluster.
Return type:	int

cluster_type¶

[Required] Gets the cluster_type of this KafkaCluster. 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

Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The cluster_type of this KafkaCluster.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this KafkaCluster. The OCID of the compartment.

Returns:	The compartment_id of this KafkaCluster.
Return type:	str

coordination_type¶

Gets the coordination_type of this KafkaCluster. Kafka coordination type. Set of available types depends on Kafka version

Allowed values for this property are: “ZOOKEEPER”, “KRAFT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The coordination_type of this KafkaCluster.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this KafkaCluster. 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 KafkaCluster.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this KafkaCluster. A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:	The display_name of this KafkaCluster.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this KafkaCluster. 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 KafkaCluster.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this KafkaCluster. The OCID of the KafkaCluster.

Returns:	The id of this KafkaCluster.
Return type:	str

kafka_bootstrap_urls¶

Gets the kafka_bootstrap_urls of this KafkaCluster. Bootstrap URL that can be used to connect to Kafka

Returns:	The kafka_bootstrap_urls of this KafkaCluster.
Return type:	list[oci.managed_kafka.models.BootstrapUrl]

kafka_version¶

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

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

lifecycle_details¶

Gets the lifecycle_details of this KafkaCluster. 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.

Returns:	The lifecycle_details of this KafkaCluster.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this KafkaCluster. The current state of the KafkaCluster.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this KafkaCluster.
Return type:	str

secret_id¶

Gets the secret_id of this KafkaCluster. The OCID of the secret that contains superuser password.

Returns:	The secret_id of this KafkaCluster.
Return type:	str

system_tags¶

Gets the system_tags of this KafkaCluster. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this KafkaCluster.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this KafkaCluster. The date and time the KafkaCluster was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this KafkaCluster.
Return type:	datetime

time_updated¶

Gets the time_updated of this KafkaCluster. The date and time the KafkaCluster was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this KafkaCluster.
Return type:	datetime