1. Packages
  2. Vkcs Provider
  3. API Docs
  4. KubernetesAddon
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.KubernetesAddon

Explore with Pulumi AI

Provides a kubernetes cluster addon resource. This can be used to create, modify and delete kubernetes cluster addons.

New since v0.3.0.

Create KubernetesAddon Resource

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

Constructor syntax

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

@overload
def KubernetesAddon(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    addon_id: Optional[str] = None,
                    cluster_id: Optional[str] = None,
                    namespace: Optional[str] = None,
                    configuration_values: Optional[str] = None,
                    name: Optional[str] = None,
                    region: Optional[str] = None,
                    timeouts: Optional[KubernetesAddonTimeoutsArgs] = None)
func NewKubernetesAddon(ctx *Context, name string, args KubernetesAddonArgs, opts ...ResourceOption) (*KubernetesAddon, error)
public KubernetesAddon(string name, KubernetesAddonArgs args, CustomResourceOptions? opts = null)
public KubernetesAddon(String name, KubernetesAddonArgs args)
public KubernetesAddon(String name, KubernetesAddonArgs args, CustomResourceOptions options)
type: vkcs:KubernetesAddon
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. KubernetesAddonArgs
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. KubernetesAddonArgs
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. KubernetesAddonArgs
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. KubernetesAddonArgs
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. KubernetesAddonArgs
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 kubernetesAddonResource = new Vkcs.KubernetesAddon("kubernetesAddonResource", new()
{
    AddonId = "string",
    ClusterId = "string",
    Namespace = "string",
    ConfigurationValues = "string",
    Name = "string",
    Region = "string",
    Timeouts = new Vkcs.Inputs.KubernetesAddonTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});
Copy
example, err := vkcs.NewKubernetesAddon(ctx, "kubernetesAddonResource", &vkcs.KubernetesAddonArgs{
AddonId: pulumi.String("string"),
ClusterId: pulumi.String("string"),
Namespace: pulumi.String("string"),
ConfigurationValues: pulumi.String("string"),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
Timeouts: &.KubernetesAddonTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
Copy
var kubernetesAddonResource = new KubernetesAddon("kubernetesAddonResource", KubernetesAddonArgs.builder()
    .addonId("string")
    .clusterId("string")
    .namespace("string")
    .configurationValues("string")
    .name("string")
    .region("string")
    .timeouts(KubernetesAddonTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());
Copy
kubernetes_addon_resource = vkcs.KubernetesAddon("kubernetesAddonResource",
    addon_id="string",
    cluster_id="string",
    namespace="string",
    configuration_values="string",
    name="string",
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })
Copy
const kubernetesAddonResource = new vkcs.KubernetesAddon("kubernetesAddonResource", {
    addonId: "string",
    clusterId: "string",
    namespace: "string",
    configurationValues: "string",
    name: "string",
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});
Copy
type: vkcs:KubernetesAddon
properties:
    addonId: string
    clusterId: string
    configurationValues: string
    name: string
    namespace: string
    region: string
    timeouts:
        create: string
        delete: string
Copy

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

AddonId This property is required. string
required string → The id of the addon. Changing this creates a new addon.
ClusterId This property is required. string
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
Namespace This property is required. string
required string → The namespace name where the addon will be installed.
ConfigurationValues string
optional string → Configuration code for the addon. Changing this creates a new addon.
Name string
optional string → The name of the application. Changing this creates a new addon.
Region string
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
Timeouts KubernetesAddonTimeouts
AddonId This property is required. string
required string → The id of the addon. Changing this creates a new addon.
ClusterId This property is required. string
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
Namespace This property is required. string
required string → The namespace name where the addon will be installed.
ConfigurationValues string
optional string → Configuration code for the addon. Changing this creates a new addon.
Name string
optional string → The name of the application. Changing this creates a new addon.
Region string
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
Timeouts KubernetesAddonTimeoutsArgs
addonId This property is required. String
required string → The id of the addon. Changing this creates a new addon.
clusterId This property is required. String
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
namespace This property is required. String
required string → The namespace name where the addon will be installed.
configurationValues String
optional string → Configuration code for the addon. Changing this creates a new addon.
name String
optional string → The name of the application. Changing this creates a new addon.
region String
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts KubernetesAddonTimeouts
addonId This property is required. string
required string → The id of the addon. Changing this creates a new addon.
clusterId This property is required. string
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
namespace This property is required. string
required string → The namespace name where the addon will be installed.
configurationValues string
optional string → Configuration code for the addon. Changing this creates a new addon.
name string
optional string → The name of the application. Changing this creates a new addon.
region string
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts KubernetesAddonTimeouts
addon_id This property is required. str
required string → The id of the addon. Changing this creates a new addon.
cluster_id This property is required. str
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
namespace This property is required. str
required string → The namespace name where the addon will be installed.
configuration_values str
optional string → Configuration code for the addon. Changing this creates a new addon.
name str
optional string → The name of the application. Changing this creates a new addon.
region str
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts KubernetesAddonTimeoutsArgs
addonId This property is required. String
required string → The id of the addon. Changing this creates a new addon.
clusterId This property is required. String
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
namespace This property is required. String
required string → The namespace name where the addon will be installed.
configurationValues String
optional string → Configuration code for the addon. Changing this creates a new addon.
name String
optional string → The name of the application. Changing this creates a new addon.
region String
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing KubernetesAddon Resource

Get an existing KubernetesAddon 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?: KubernetesAddonState, opts?: CustomResourceOptions): KubernetesAddon
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addon_id: Optional[str] = None,
        cluster_id: Optional[str] = None,
        configuration_values: Optional[str] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        region: Optional[str] = None,
        timeouts: Optional[KubernetesAddonTimeoutsArgs] = None) -> KubernetesAddon
func GetKubernetesAddon(ctx *Context, name string, id IDInput, state *KubernetesAddonState, opts ...ResourceOption) (*KubernetesAddon, error)
public static KubernetesAddon Get(string name, Input<string> id, KubernetesAddonState? state, CustomResourceOptions? opts = null)
public static KubernetesAddon get(String name, Output<String> id, KubernetesAddonState state, CustomResourceOptions options)
resources:  _:    type: vkcs:KubernetesAddon    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:
AddonId string
required string → The id of the addon. Changing this creates a new addon.
ClusterId string
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
ConfigurationValues string
optional string → Configuration code for the addon. Changing this creates a new addon.
Name string
optional string → The name of the application. Changing this creates a new addon.
Namespace string
required string → The namespace name where the addon will be installed.
Region string
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
Timeouts KubernetesAddonTimeouts
AddonId string
required string → The id of the addon. Changing this creates a new addon.
ClusterId string
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
ConfigurationValues string
optional string → Configuration code for the addon. Changing this creates a new addon.
Name string
optional string → The name of the application. Changing this creates a new addon.
Namespace string
required string → The namespace name where the addon will be installed.
Region string
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
Timeouts KubernetesAddonTimeoutsArgs
addonId String
required string → The id of the addon. Changing this creates a new addon.
clusterId String
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
configurationValues String
optional string → Configuration code for the addon. Changing this creates a new addon.
name String
optional string → The name of the application. Changing this creates a new addon.
namespace String
required string → The namespace name where the addon will be installed.
region String
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts KubernetesAddonTimeouts
addonId string
required string → The id of the addon. Changing this creates a new addon.
clusterId string
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
configurationValues string
optional string → Configuration code for the addon. Changing this creates a new addon.
name string
optional string → The name of the application. Changing this creates a new addon.
namespace string
required string → The namespace name where the addon will be installed.
region string
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts KubernetesAddonTimeouts
addon_id str
required string → The id of the addon. Changing this creates a new addon.
cluster_id str
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
configuration_values str
optional string → Configuration code for the addon. Changing this creates a new addon.
name str
optional string → The name of the application. Changing this creates a new addon.
namespace str
required string → The namespace name where the addon will be installed.
region str
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts KubernetesAddonTimeoutsArgs
addonId String
required string → The id of the addon. Changing this creates a new addon.
clusterId String
required string → The ID of the kubernetes cluster. Changing this creates a new addon.
configurationValues String
optional string → Configuration code for the addon. Changing this creates a new addon.
name String
optional string → The name of the application. Changing this creates a new addon.
namespace String
required string → The namespace name where the addon will be installed.
region String
optional string → The region in which to obtain the Container Infra Addons client. If omitted, the region argument of the provider is used. Changing this creates a new addon.
timeouts Property Map

Supporting Types

KubernetesAddonTimeouts
, KubernetesAddonTimeoutsArgs

Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Import

Cluster addons can be imported using the id in the form <cluster-id>/<cluster-addon-id>, e.g.

$ pulumi import vkcs:index/kubernetesAddon:KubernetesAddon addon 141a1f77-0e89-4b63-8d75-1b4ae496f862/a94c8ae2-0cac-4795-9253-d23ce2a70f86
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
vkcs vk-cs/terraform-provider-vkcs
License
Notes
This Pulumi package is based on the vkcs Terraform Provider.