Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ContainerEngine
  5. Addon
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.ContainerEngine.Addon

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Addon resource in Oracle Cloud Infrastructure Container Engine service.

Install the specified addon for a cluster.

Create Addon Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Addon(name: string, args: AddonArgs, opts?: CustomResourceOptions);
@overload
def Addon(resource_name: str,
          args: AddonArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Addon(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          addon_name: Optional[str] = None,
          cluster_id: Optional[str] = None,
          remove_addon_resources_on_delete: Optional[bool] = None,
          configurations: Optional[Sequence[_containerengine.AddonConfigurationArgs]] = None,
          override_existing: Optional[bool] = None,
          version: Optional[str] = None)
func NewAddon(ctx *Context, name string, args AddonArgs, opts ...ResourceOption) (*Addon, error)
public Addon(string name, AddonArgs args, CustomResourceOptions? opts = null)
public Addon(String name, AddonArgs args)
public Addon(String name, AddonArgs args, CustomResourceOptions options)

type: oci:ContainerEngine:Addon
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AddonArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AddonArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AddonArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AddonArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AddonArgs
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 addonResource = new Oci.ContainerEngine.Addon("addonResource", new()
{
    AddonName = "string",
    ClusterId = "string",
    RemoveAddonResourcesOnDelete = false,
    Configurations = new[]
    {
        new Oci.ContainerEngine.Inputs.AddonConfigurationArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    OverrideExisting = false,
    Version = "string",
});
Copy
example, err := containerengine.NewAddon(ctx, "addonResource", &containerengine.AddonArgs{
	AddonName:                    pulumi.String("string"),
	ClusterId:                    pulumi.String("string"),
	RemoveAddonResourcesOnDelete: pulumi.Bool(false),
	Configurations: containerengine.AddonConfigurationArray{
		&containerengine.AddonConfigurationArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	OverrideExisting: pulumi.Bool(false),
	Version:          pulumi.String("string"),
})
Copy
var addonResource = new Addon("addonResource", AddonArgs.builder()
    .addonName("string")
    .clusterId("string")
    .removeAddonResourcesOnDelete(false)
    .configurations(AddonConfigurationArgs.builder()
        .key("string")
        .value("string")
        .build())
    .overrideExisting(false)
    .version("string")
    .build());
Copy
addon_resource = oci.container_engine.Addon("addonResource",
    addon_name="string",
    cluster_id="string",
    remove_addon_resources_on_delete=False,
    configurations=[{
        "key": "string",
        "value": "string",
    }],
    override_existing=False,
    version="string")
Copy
const addonResource = new oci.containerengine.Addon("addonResource", {
    addonName: "string",
    clusterId: "string",
    removeAddonResourcesOnDelete: false,
    configurations: [{
        key: "string",
        value: "string",
    }],
    overrideExisting: false,
    version: "string",
});
Copy
type: oci:ContainerEngine:Addon
properties:
    addonName: string
    clusterId: string
    configurations:
        - key: string
          value: string
    overrideExisting: false
    removeAddonResourcesOnDelete: false
    version: string
Copy

Addon 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 Addon resource accepts the following input properties:

AddonName
This property is required.
Changes to this property will trigger replacement.
string
The name of the addon.
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cluster.
RemoveAddonResourcesOnDelete This property is required. bool
Whether to remove addon resource in deletion.
Configurations List<AddonConfiguration>
(Updatable) Addon configuration details
OverrideExisting bool
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
Version string

(Updatable) The version of addon to be installed.

** 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

AddonName
This property is required.
Changes to this property will trigger replacement.
string
The name of the addon.
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cluster.
RemoveAddonResourcesOnDelete This property is required. bool
Whether to remove addon resource in deletion.
Configurations []AddonConfigurationArgs
(Updatable) Addon configuration details
OverrideExisting bool
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
Version string

(Updatable) The version of addon to be installed.

** 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

addonName
This property is required.
Changes to this property will trigger replacement.
String
The name of the addon.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the cluster.
removeAddonResourcesOnDelete This property is required. Boolean
Whether to remove addon resource in deletion.
configurations List<AddonConfiguration>
(Updatable) Addon configuration details
overrideExisting Boolean
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
version String

(Updatable) The version of addon to be installed.

** 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

addonName
This property is required.
Changes to this property will trigger replacement.
string
The name of the addon.
clusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cluster.
removeAddonResourcesOnDelete This property is required. boolean
Whether to remove addon resource in deletion.
configurations AddonConfiguration[]
(Updatable) Addon configuration details
overrideExisting boolean
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
version string

(Updatable) The version of addon to be installed.

** 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

addon_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the addon.
cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the cluster.
remove_addon_resources_on_delete This property is required. bool
Whether to remove addon resource in deletion.
configurations Sequence[containerengine.AddonConfigurationArgs]
(Updatable) Addon configuration details
override_existing bool
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
version str

(Updatable) The version of addon to be installed.

** 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

addonName
This property is required.
Changes to this property will trigger replacement.
String
The name of the addon.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the cluster.
removeAddonResourcesOnDelete This property is required. Boolean
Whether to remove addon resource in deletion.
configurations List<Property Map>
(Updatable) Addon configuration details
overrideExisting Boolean
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
version String

(Updatable) The version of addon to be installed.

** 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

Outputs

All input properties are implicitly available as output properties. Additionally, the Addon resource produces the following output properties:

AddonErrors List<AddonAddonError>
The error info of the addon.
CurrentInstalledVersion string
current installed version of the addon
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the addon.
TimeCreated string
The time the cluster was created.
AddonErrors []AddonAddonError
The error info of the addon.
CurrentInstalledVersion string
current installed version of the addon
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the addon.
TimeCreated string
The time the cluster was created.
addonErrors List<AddonAddonError>
The error info of the addon.
currentInstalledVersion String
current installed version of the addon
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the addon.
timeCreated String
The time the cluster was created.
addonErrors AddonAddonError[]
The error info of the addon.
currentInstalledVersion string
current installed version of the addon
id string
The provider-assigned unique ID for this managed resource.
state string
The state of the addon.
timeCreated string
The time the cluster was created.
addon_errors Sequence[containerengine.AddonAddonError]
The error info of the addon.
current_installed_version str
current installed version of the addon
id str
The provider-assigned unique ID for this managed resource.
state str
The state of the addon.
time_created str
The time the cluster was created.
addonErrors List<Property Map>
The error info of the addon.
currentInstalledVersion String
current installed version of the addon
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the addon.
timeCreated String
The time the cluster was created.

Look up Existing Addon Resource

Get an existing Addon 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?: AddonState, opts?: CustomResourceOptions): Addon
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addon_errors: Optional[Sequence[_containerengine.AddonAddonErrorArgs]] = None,
        addon_name: Optional[str] = None,
        cluster_id: Optional[str] = None,
        configurations: Optional[Sequence[_containerengine.AddonConfigurationArgs]] = None,
        current_installed_version: Optional[str] = None,
        override_existing: Optional[bool] = None,
        remove_addon_resources_on_delete: Optional[bool] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        version: Optional[str] = None) -> Addon
func GetAddon(ctx *Context, name string, id IDInput, state *AddonState, opts ...ResourceOption) (*Addon, error)
public static Addon Get(string name, Input<string> id, AddonState? state, CustomResourceOptions? opts = null)
public static Addon get(String name, Output<String> id, AddonState state, CustomResourceOptions options)
resources:  _:    type: oci:ContainerEngine:Addon    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AddonErrors List<AddonAddonError>
The error info of the addon.
AddonName Changes to this property will trigger replacement. string
The name of the addon.
ClusterId Changes to this property will trigger replacement. string
The OCID of the cluster.
Configurations List<AddonConfiguration>
(Updatable) Addon configuration details
CurrentInstalledVersion string
current installed version of the addon
OverrideExisting bool
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
RemoveAddonResourcesOnDelete bool
Whether to remove addon resource in deletion.
State string
The state of the addon.
TimeCreated string
The time the cluster was created.
Version string

(Updatable) The version of addon to be installed.

** 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

AddonErrors []AddonAddonErrorArgs
The error info of the addon.
AddonName Changes to this property will trigger replacement. string
The name of the addon.
ClusterId Changes to this property will trigger replacement. string
The OCID of the cluster.
Configurations []AddonConfigurationArgs
(Updatable) Addon configuration details
CurrentInstalledVersion string
current installed version of the addon
OverrideExisting bool
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
RemoveAddonResourcesOnDelete bool
Whether to remove addon resource in deletion.
State string
The state of the addon.
TimeCreated string
The time the cluster was created.
Version string

(Updatable) The version of addon to be installed.

** 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

addonErrors List<AddonAddonError>
The error info of the addon.
addonName Changes to this property will trigger replacement. String
The name of the addon.
clusterId Changes to this property will trigger replacement. String
The OCID of the cluster.
configurations List<AddonConfiguration>
(Updatable) Addon configuration details
currentInstalledVersion String
current installed version of the addon
overrideExisting Boolean
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
removeAddonResourcesOnDelete Boolean
Whether to remove addon resource in deletion.
state String
The state of the addon.
timeCreated String
The time the cluster was created.
version String

(Updatable) The version of addon to be installed.

** 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

addonErrors AddonAddonError[]
The error info of the addon.
addonName Changes to this property will trigger replacement. string
The name of the addon.
clusterId Changes to this property will trigger replacement. string
The OCID of the cluster.
configurations AddonConfiguration[]
(Updatable) Addon configuration details
currentInstalledVersion string
current installed version of the addon
overrideExisting boolean
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
removeAddonResourcesOnDelete boolean
Whether to remove addon resource in deletion.
state string
The state of the addon.
timeCreated string
The time the cluster was created.
version string

(Updatable) The version of addon to be installed.

** 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

addon_errors Sequence[containerengine.AddonAddonErrorArgs]
The error info of the addon.
addon_name Changes to this property will trigger replacement. str
The name of the addon.
cluster_id Changes to this property will trigger replacement. str
The OCID of the cluster.
configurations Sequence[containerengine.AddonConfigurationArgs]
(Updatable) Addon configuration details
current_installed_version str
current installed version of the addon
override_existing bool
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
remove_addon_resources_on_delete bool
Whether to remove addon resource in deletion.
state str
The state of the addon.
time_created str
The time the cluster was created.
version str

(Updatable) The version of addon to be installed.

** 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

addonErrors List<Property Map>
The error info of the addon.
addonName Changes to this property will trigger replacement. String
The name of the addon.
clusterId Changes to this property will trigger replacement. String
The OCID of the cluster.
configurations List<Property Map>
(Updatable) Addon configuration details
currentInstalledVersion String
current installed version of the addon
overrideExisting Boolean
Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
removeAddonResourcesOnDelete Boolean
Whether to remove addon resource in deletion.
state String
The state of the addon.
timeCreated String
The time the cluster was created.
version String

(Updatable) The version of addon to be installed.

** 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

Supporting Types

AddonAddonError
, AddonAddonErrorArgs

Code string
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
Message string
A human-readable error string of the upstream error.
Status string
The status of the HTTP response encountered in the upstream error.
Code string
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
Message string
A human-readable error string of the upstream error.
Status string
The status of the HTTP response encountered in the upstream error.
code String
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
message String
A human-readable error string of the upstream error.
status String
The status of the HTTP response encountered in the upstream error.
code string
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
message string
A human-readable error string of the upstream error.
status string
The status of the HTTP response encountered in the upstream error.
code str
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
message str
A human-readable error string of the upstream error.
status str
The status of the HTTP response encountered in the upstream error.
code String
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
message String
A human-readable error string of the upstream error.
status String
The status of the HTTP response encountered in the upstream error.

AddonConfiguration
, AddonConfigurationArgs

Key string
(Updatable) configuration key name
Value string
(Updatable) configuration value name
Key string
(Updatable) configuration key name
Value string
(Updatable) configuration value name
key String
(Updatable) configuration key name
value String
(Updatable) configuration value name
key string
(Updatable) configuration key name
value string
(Updatable) configuration value name
key str
(Updatable) configuration key name
value str
(Updatable) configuration value name
key String
(Updatable) configuration key name
value String
(Updatable) configuration value name

Import

Addons can be imported using the id, e.g.

$ pulumi import oci:ContainerEngine/addon:Addon test_addon "clusters/{clusterId}/addons/{addonName}"
Copy

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 oci Terraform Provider.
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci