published on Wednesday, Jul 15, 2026 by Pulumi
published on Wednesday, Jul 15, 2026 by Pulumi
This resource provides the Kafka Cluster Addon resource in Oracle Cloud Infrastructure Managed Kafka service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/kafka/latest/Addon
Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/managed_kafka
Installs a KafkaClusterAddon.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testKafkaClusterAddon = new oci.oci.ManagedKafkaKafkaClusterAddon("test_kafka_cluster_addon", {
addonType: kafkaClusterAddonAddonType,
authenticationMechanism: kafkaClusterAddonAuthenticationMechanism,
kafkaClusterId: testKafkaCluster.id,
name: kafkaClusterAddonName,
networkCidrs: kafkaClusterAddonNetworkCidrs,
description: kafkaClusterAddonDescription,
});
import pulumi
import pulumi_oci as oci
test_kafka_cluster_addon = oci.oci.ManagedKafkaKafkaClusterAddon("test_kafka_cluster_addon",
addon_type=kafka_cluster_addon_addon_type,
authentication_mechanism=kafka_cluster_addon_authentication_mechanism,
kafka_cluster_id=test_kafka_cluster["id"],
name=kafka_cluster_addon_name,
network_cidrs=kafka_cluster_addon_network_cidrs,
description=kafka_cluster_addon_description)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/oci"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oci.NewManagedKafkaKafkaClusterAddon(ctx, "test_kafka_cluster_addon", &oci.ManagedKafkaKafkaClusterAddonArgs{
AddonType: pulumi.Any(kafkaClusterAddonAddonType),
AuthenticationMechanism: pulumi.Any(kafkaClusterAddonAuthenticationMechanism),
KafkaClusterId: pulumi.Any(testKafkaCluster.Id),
Name: pulumi.Any(kafkaClusterAddonName),
NetworkCidrs: pulumi.Any(kafkaClusterAddonNetworkCidrs),
Description: pulumi.Any(kafkaClusterAddonDescription),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testKafkaClusterAddon = new Oci.Oci.ManagedKafkaKafkaClusterAddon("test_kafka_cluster_addon", new()
{
AddonType = kafkaClusterAddonAddonType,
AuthenticationMechanism = kafkaClusterAddonAuthenticationMechanism,
KafkaClusterId = testKafkaCluster.Id,
Name = kafkaClusterAddonName,
NetworkCidrs = kafkaClusterAddonNetworkCidrs,
Description = kafkaClusterAddonDescription,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.ManagedKafkaKafkaClusterAddon;
import com.pulumi.oci.oci.ManagedKafkaKafkaClusterAddonArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testKafkaClusterAddon = new ManagedKafkaKafkaClusterAddon("testKafkaClusterAddon", ManagedKafkaKafkaClusterAddonArgs.builder()
.addonType(kafkaClusterAddonAddonType)
.authenticationMechanism(kafkaClusterAddonAuthenticationMechanism)
.kafkaClusterId(testKafkaCluster.id())
.name(kafkaClusterAddonName)
.networkCidrs(kafkaClusterAddonNetworkCidrs)
.description(kafkaClusterAddonDescription)
.build());
}
}
resources:
testKafkaClusterAddon:
type: oci:oci:ManagedKafkaKafkaClusterAddon
name: test_kafka_cluster_addon
properties:
addonType: ${kafkaClusterAddonAddonType}
authenticationMechanism: ${kafkaClusterAddonAuthenticationMechanism}
kafkaClusterId: ${testKafkaCluster.id}
name: ${kafkaClusterAddonName}
networkCidrs: ${kafkaClusterAddonNetworkCidrs}
description: ${kafkaClusterAddonDescription}
pulumi {
required_providers {
oci = {
source = "pulumi/oci"
}
}
}
resource "oci_oci_managedkafkakafkaclusteraddon" "test_kafka_cluster_addon" {
addon_type = kafkaClusterAddonAddonType
authentication_mechanism = kafkaClusterAddonAuthenticationMechanism
kafka_cluster_id = testKafkaCluster.id
name = kafkaClusterAddonName
network_cidrs = kafkaClusterAddonNetworkCidrs
description = kafkaClusterAddonDescription
}
Create ManagedKafkaKafkaClusterAddon Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ManagedKafkaKafkaClusterAddon(name: string, args: ManagedKafkaKafkaClusterAddonArgs, opts?: CustomResourceOptions);@overload
def ManagedKafkaKafkaClusterAddon(resource_name: str,
args: ManagedKafkaKafkaClusterAddonArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ManagedKafkaKafkaClusterAddon(resource_name: str,
opts: Optional[ResourceOptions] = None,
addon_type: Optional[str] = None,
authentication_mechanism: Optional[str] = None,
kafka_cluster_id: Optional[str] = None,
network_cidrs: Optional[Sequence[str]] = None,
description: Optional[str] = None,
name: Optional[str] = None)func NewManagedKafkaKafkaClusterAddon(ctx *Context, name string, args ManagedKafkaKafkaClusterAddonArgs, opts ...ResourceOption) (*ManagedKafkaKafkaClusterAddon, error)public ManagedKafkaKafkaClusterAddon(string name, ManagedKafkaKafkaClusterAddonArgs args, CustomResourceOptions? opts = null)
public ManagedKafkaKafkaClusterAddon(String name, ManagedKafkaKafkaClusterAddonArgs args)
public ManagedKafkaKafkaClusterAddon(String name, ManagedKafkaKafkaClusterAddonArgs args, CustomResourceOptions options)
type: oci:oci:ManagedKafkaKafkaClusterAddon
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "oci_oci_managed_kafka_kafka_cluster_addon" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ManagedKafkaKafkaClusterAddonArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ManagedKafkaKafkaClusterAddonArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ManagedKafkaKafkaClusterAddonArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ManagedKafkaKafkaClusterAddonArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ManagedKafkaKafkaClusterAddonArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var managedKafkaKafkaClusterAddonResource = new Oci.Oci.ManagedKafkaKafkaClusterAddon("managedKafkaKafkaClusterAddonResource", new()
{
AddonType = "string",
AuthenticationMechanism = "string",
KafkaClusterId = "string",
NetworkCidrs = new[]
{
"string",
},
Description = "string",
Name = "string",
});
example, err := oci.NewManagedKafkaKafkaClusterAddon(ctx, "managedKafkaKafkaClusterAddonResource", &oci.ManagedKafkaKafkaClusterAddonArgs{
AddonType: pulumi.String("string"),
AuthenticationMechanism: pulumi.String("string"),
KafkaClusterId: pulumi.String("string"),
NetworkCidrs: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "oci_oci_managed_kafka_kafka_cluster_addon" "managedKafkaKafkaClusterAddonResource" {
lifecycle {
create_before_destroy = true
}
addon_type = "string"
authentication_mechanism = "string"
kafka_cluster_id = "string"
network_cidrs = ["string"]
description = "string"
name = "string"
}
var managedKafkaKafkaClusterAddonResource = new ManagedKafkaKafkaClusterAddon("managedKafkaKafkaClusterAddonResource", ManagedKafkaKafkaClusterAddonArgs.builder()
.addonType("string")
.authenticationMechanism("string")
.kafkaClusterId("string")
.networkCidrs("string")
.description("string")
.name("string")
.build());
managed_kafka_kafka_cluster_addon_resource = oci.oci.ManagedKafkaKafkaClusterAddon("managedKafkaKafkaClusterAddonResource",
addon_type="string",
authentication_mechanism="string",
kafka_cluster_id="string",
network_cidrs=["string"],
description="string",
name="string")
const managedKafkaKafkaClusterAddonResource = new oci.oci.ManagedKafkaKafkaClusterAddon("managedKafkaKafkaClusterAddonResource", {
addonType: "string",
authenticationMechanism: "string",
kafkaClusterId: "string",
networkCidrs: ["string"],
description: "string",
name: "string",
});
type: oci:oci:ManagedKafkaKafkaClusterAddon
properties:
addonType: string
authenticationMechanism: string
description: string
kafkaClusterId: string
name: string
networkCidrs:
- string
ManagedKafkaKafkaClusterAddon Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ManagedKafkaKafkaClusterAddon resource accepts the following input properties:
- Addon
Type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- Authentication
Mechanism string - Authentication mechanism.
- Kafka
Cluster stringId - The OCID of the KafkaCluster.
- Network
Cidrs List<string> (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Description string
- (Updatable) A brief description of the add on being installed.
- Name string
- A unique user-friendly name. Avoid entering confidential information.
- Addon
Type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- Authentication
Mechanism string - Authentication mechanism.
- Kafka
Cluster stringId - The OCID of the KafkaCluster.
- Network
Cidrs []string (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Description string
- (Updatable) A brief description of the add on being installed.
- Name string
- A unique user-friendly name. Avoid entering confidential information.
- addon_
type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication_
mechanism string - Authentication mechanism.
- kafka_
cluster_ stringid - The OCID of the KafkaCluster.
- network_
cidrs list(string) (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- description string
- (Updatable) A brief description of the add on being installed.
- name string
- A unique user-friendly name. Avoid entering confidential information.
- addon
Type String - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication
Mechanism String - Authentication mechanism.
- kafka
Cluster StringId - The OCID of the KafkaCluster.
- network
Cidrs List<String> (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- description String
- (Updatable) A brief description of the add on being installed.
- name String
- A unique user-friendly name. Avoid entering confidential information.
- addon
Type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication
Mechanism string - Authentication mechanism.
- kafka
Cluster stringId - The OCID of the KafkaCluster.
- network
Cidrs string[] (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- description string
- (Updatable) A brief description of the add on being installed.
- name string
- A unique user-friendly name. Avoid entering confidential information.
- addon_
type str - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication_
mechanism str - Authentication mechanism.
- kafka_
cluster_ strid - The OCID of the KafkaCluster.
- network_
cidrs Sequence[str] (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- description str
- (Updatable) A brief description of the add on being installed.
- name str
- A unique user-friendly name. Avoid entering confidential information.
- addon
Type String - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication
Mechanism String - Authentication mechanism.
- kafka
Cluster StringId - The OCID of the KafkaCluster.
- network
Cidrs List<String> (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- description String
- (Updatable) A brief description of the add on being installed.
- name String
- A unique user-friendly name. Avoid entering confidential information.
Outputs
All input properties are implicitly available as output properties. Additionally, the ManagedKafkaKafkaClusterAddon resource produces the following output properties:
- Bootstrap
Url string - The bootstrap url of the kafka cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the KafkaCluster.
- Time
Created string - The time the addon was created.
- Time
Updated string - The time the addon was updated.
- Bootstrap
Url string - The bootstrap url of the kafka cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the KafkaCluster.
- Time
Created string - The time the addon was created.
- Time
Updated string - The time the addon was updated.
- bootstrap_
url string - The bootstrap url of the kafka cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The current state of the KafkaCluster.
- time_
created string - The time the addon was created.
- time_
updated string - The time the addon was updated.
- bootstrap
Url String - The bootstrap url of the kafka cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the KafkaCluster.
- time
Created String - The time the addon was created.
- time
Updated String - The time the addon was updated.
- bootstrap
Url string - The bootstrap url of the kafka cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The current state of the KafkaCluster.
- time
Created string - The time the addon was created.
- time
Updated string - The time the addon was updated.
- bootstrap_
url str - The bootstrap url of the kafka cluster.
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- The current state of the KafkaCluster.
- time_
created str - The time the addon was created.
- time_
updated str - The time the addon was updated.
- bootstrap
Url String - The bootstrap url of the kafka cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the KafkaCluster.
- time
Created String - The time the addon was created.
- time
Updated String - The time the addon was updated.
Look up Existing ManagedKafkaKafkaClusterAddon Resource
Get an existing ManagedKafkaKafkaClusterAddon resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ManagedKafkaKafkaClusterAddonState, opts?: CustomResourceOptions): ManagedKafkaKafkaClusterAddon@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
addon_type: Optional[str] = None,
authentication_mechanism: Optional[str] = None,
bootstrap_url: Optional[str] = None,
description: Optional[str] = None,
kafka_cluster_id: Optional[str] = None,
name: Optional[str] = None,
network_cidrs: Optional[Sequence[str]] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> ManagedKafkaKafkaClusterAddonfunc GetManagedKafkaKafkaClusterAddon(ctx *Context, name string, id IDInput, state *ManagedKafkaKafkaClusterAddonState, opts ...ResourceOption) (*ManagedKafkaKafkaClusterAddon, error)public static ManagedKafkaKafkaClusterAddon Get(string name, Input<string> id, ManagedKafkaKafkaClusterAddonState? state, CustomResourceOptions? opts = null)public static ManagedKafkaKafkaClusterAddon get(String name, Output<String> id, ManagedKafkaKafkaClusterAddonState state, CustomResourceOptions options)resources: _: type: oci:oci:ManagedKafkaKafkaClusterAddon get: id: ${id}import {
to = oci_oci_managed_kafka_kafka_cluster_addon.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Addon
Type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- Authentication
Mechanism string - Authentication mechanism.
- Bootstrap
Url string - The bootstrap url of the kafka cluster.
- Description string
- (Updatable) A brief description of the add on being installed.
- Kafka
Cluster stringId - The OCID of the KafkaCluster.
- Name string
- A unique user-friendly name. Avoid entering confidential information.
- Network
Cidrs List<string> (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current state of the KafkaCluster.
- Time
Created string - The time the addon was created.
- Time
Updated string - The time the addon was updated.
- Addon
Type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- Authentication
Mechanism string - Authentication mechanism.
- Bootstrap
Url string - The bootstrap url of the kafka cluster.
- Description string
- (Updatable) A brief description of the add on being installed.
- Kafka
Cluster stringId - The OCID of the KafkaCluster.
- Name string
- A unique user-friendly name. Avoid entering confidential information.
- Network
Cidrs []string (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current state of the KafkaCluster.
- Time
Created string - The time the addon was created.
- Time
Updated string - The time the addon was updated.
- addon_
type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication_
mechanism string - Authentication mechanism.
- bootstrap_
url string - The bootstrap url of the kafka cluster.
- description string
- (Updatable) A brief description of the add on being installed.
- kafka_
cluster_ stringid - The OCID of the KafkaCluster.
- name string
- A unique user-friendly name. Avoid entering confidential information.
- network_
cidrs list(string) (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state string
- The current state of the KafkaCluster.
- time_
created string - The time the addon was created.
- time_
updated string - The time the addon was updated.
- addon
Type String - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication
Mechanism String - Authentication mechanism.
- bootstrap
Url String - The bootstrap url of the kafka cluster.
- description String
- (Updatable) A brief description of the add on being installed.
- kafka
Cluster StringId - The OCID of the KafkaCluster.
- name String
- A unique user-friendly name. Avoid entering confidential information.
- network
Cidrs List<String> (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current state of the KafkaCluster.
- time
Created String - The time the addon was created.
- time
Updated String - The time the addon was updated.
- addon
Type string - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication
Mechanism string - Authentication mechanism.
- bootstrap
Url string - The bootstrap url of the kafka cluster.
- description string
- (Updatable) A brief description of the add on being installed.
- kafka
Cluster stringId - The OCID of the KafkaCluster.
- name string
- A unique user-friendly name. Avoid entering confidential information.
- network
Cidrs string[] (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state string
- The current state of the KafkaCluster.
- time
Created string - The time the addon was created.
- time
Updated string - The time the addon was updated.
- addon_
type str - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication_
mechanism str - Authentication mechanism.
- bootstrap_
url str - The bootstrap url of the kafka cluster.
- description str
- (Updatable) A brief description of the add on being installed.
- kafka_
cluster_ strid - The OCID of the KafkaCluster.
- name str
- A unique user-friendly name. Avoid entering confidential information.
- network_
cidrs Sequence[str] (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state str
- The current state of the KafkaCluster.
- time_
created str - The time the addon was created.
- time_
updated str - The time the addon was updated.
- addon
Type String - (Updatable) This is Addon Type of Oracle Cloud Infrastructure kafka cluster
- authentication
Mechanism String - Authentication mechanism.
- bootstrap
Url String - The bootstrap url of the kafka cluster.
- description String
- (Updatable) A brief description of the add on being installed.
- kafka
Cluster StringId - The OCID of the KafkaCluster.
- name String
- A unique user-friendly name. Avoid entering confidential information.
- network
Cidrs List<String> (Updatable) A list of CIDR's for ingress/egress traffic.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current state of the KafkaCluster.
- time
Created String - The time the addon was created.
- time
Updated String - The time the addon was updated.
Import
KafkaClusterAddons can be imported using the id, e.g.
$ pulumi import oci:oci/managedKafkaKafkaClusterAddon:ManagedKafkaKafkaClusterAddon test_kafka_cluster_addon "kafkaClusters/{kafkaClusterId}/addons/{addonName}"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
published on Wednesday, Jul 15, 2026 by Pulumi