Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. vke
  5. Addon
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.vke.Addon

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

Provides a resource to manage vke addon

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";

const foo = new volcengine.vke.Addon("foo", {
    clusterId: "cccctv1vqtofp49d96ujg",
    config: "{\"xxx\":\"true\"}",
    deployMode: "Unmanaged",
    deployNodeType: "Node",
    version: "v0.1.3",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.vke.Addon("foo",
    cluster_id="cccctv1vqtofp49d96ujg",
    config="{\"xxx\":\"true\"}",
    deploy_mode="Unmanaged",
    deploy_node_type="Node",
    version="v0.1.3")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vke"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vke.NewAddon(ctx, "foo", &vke.AddonArgs{
			ClusterId:      pulumi.String("cccctv1vqtofp49d96ujg"),
			Config:         pulumi.String("{\"xxx\":\"true\"}"),
			DeployMode:     pulumi.String("Unmanaged"),
			DeployNodeType: pulumi.String("Node"),
			Version:        pulumi.String("v0.1.3"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Vke.Addon("foo", new()
    {
        ClusterId = "cccctv1vqtofp49d96ujg",
        Config = "{\"xxx\":\"true\"}",
        DeployMode = "Unmanaged",
        DeployNodeType = "Node",
        Version = "v0.1.3",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vke.Addon;
import com.pulumi.volcengine.vke.AddonArgs;
import java.util.List;
import java.util.ArrayList;
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 foo = new Addon("foo", AddonArgs.builder()        
            .clusterId("cccctv1vqtofp49d96ujg")
            .config("{\"xxx\":\"true\"}")
            .deployMode("Unmanaged")
            .deployNodeType("Node")
            .version("v0.1.3")
            .build());

    }
}
Copy
resources:
  foo:
    type: volcengine:vke:Addon
    properties:
      clusterId: cccctv1vqtofp49d96ujg
      config: '{"xxx":"true"}'
      deployMode: Unmanaged
      deployNodeType: Node
      version: v0.1.3
Copy

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,
          cluster_id: Optional[str] = None,
          config: Optional[str] = None,
          deploy_mode: Optional[str] = None,
          deploy_node_type: Optional[str] = None,
          name: Optional[str] = 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: volcengine:vke: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 Volcengine.Vke.Addon("addonResource", new()
{
    ClusterId = "string",
    Config = "string",
    DeployMode = "string",
    DeployNodeType = "string",
    Name = "string",
    Version = "string",
});
Copy
example, err := vke.NewAddon(ctx, "addonResource", &vke.AddonArgs{
	ClusterId:      pulumi.String("string"),
	Config:         pulumi.String("string"),
	DeployMode:     pulumi.String("string"),
	DeployNodeType: pulumi.String("string"),
	Name:           pulumi.String("string"),
	Version:        pulumi.String("string"),
})
Copy
var addonResource = new Addon("addonResource", AddonArgs.builder()
    .clusterId("string")
    .config("string")
    .deployMode("string")
    .deployNodeType("string")
    .name("string")
    .version("string")
    .build());
Copy
addon_resource = volcengine.vke.Addon("addonResource",
    cluster_id="string",
    config="string",
    deploy_mode="string",
    deploy_node_type="string",
    name="string",
    version="string")
Copy
const addonResource = new volcengine.vke.Addon("addonResource", {
    clusterId: "string",
    config: "string",
    deployMode: "string",
    deployNodeType: "string",
    name: "string",
    version: "string",
});
Copy
type: volcengine:vke:Addon
properties:
    clusterId: string
    config: string
    deployMode: string
    deployNodeType: string
    name: string
    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:

ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The cluster id of the addon.
Config string
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
DeployMode Changes to this property will trigger replacement. string
The deploy mode.
DeployNodeType Changes to this property will trigger replacement. string
The deploy node type.
Name Changes to this property will trigger replacement. string
The name of the addon.
Version string
The version info of the cluster.
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The cluster id of the addon.
Config string
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
DeployMode Changes to this property will trigger replacement. string
The deploy mode.
DeployNodeType Changes to this property will trigger replacement. string
The deploy node type.
Name Changes to this property will trigger replacement. string
The name of the addon.
Version string
The version info of the cluster.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The cluster id of the addon.
config String
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deployMode Changes to this property will trigger replacement. String
The deploy mode.
deployNodeType Changes to this property will trigger replacement. String
The deploy node type.
name Changes to this property will trigger replacement. String
The name of the addon.
version String
The version info of the cluster.
clusterId
This property is required.
Changes to this property will trigger replacement.
string
The cluster id of the addon.
config string
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deployMode Changes to this property will trigger replacement. string
The deploy mode.
deployNodeType Changes to this property will trigger replacement. string
The deploy node type.
name Changes to this property will trigger replacement. string
The name of the addon.
version string
The version info of the cluster.
cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The cluster id of the addon.
config str
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deploy_mode Changes to this property will trigger replacement. str
The deploy mode.
deploy_node_type Changes to this property will trigger replacement. str
The deploy node type.
name Changes to this property will trigger replacement. str
The name of the addon.
version str
The version info of the cluster.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The cluster id of the addon.
config String
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deployMode Changes to this property will trigger replacement. String
The deploy mode.
deployNodeType Changes to this property will trigger replacement. String
The deploy node type.
name Changes to this property will trigger replacement. String
The name of the addon.
version String
The version info of the cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the Addon 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 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,
        cluster_id: Optional[str] = None,
        config: Optional[str] = None,
        deploy_mode: Optional[str] = None,
        deploy_node_type: Optional[str] = None,
        name: 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: volcengine:vke: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:
ClusterId Changes to this property will trigger replacement. string
The cluster id of the addon.
Config string
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
DeployMode Changes to this property will trigger replacement. string
The deploy mode.
DeployNodeType Changes to this property will trigger replacement. string
The deploy node type.
Name Changes to this property will trigger replacement. string
The name of the addon.
Version string
The version info of the cluster.
ClusterId Changes to this property will trigger replacement. string
The cluster id of the addon.
Config string
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
DeployMode Changes to this property will trigger replacement. string
The deploy mode.
DeployNodeType Changes to this property will trigger replacement. string
The deploy node type.
Name Changes to this property will trigger replacement. string
The name of the addon.
Version string
The version info of the cluster.
clusterId Changes to this property will trigger replacement. String
The cluster id of the addon.
config String
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deployMode Changes to this property will trigger replacement. String
The deploy mode.
deployNodeType Changes to this property will trigger replacement. String
The deploy node type.
name Changes to this property will trigger replacement. String
The name of the addon.
version String
The version info of the cluster.
clusterId Changes to this property will trigger replacement. string
The cluster id of the addon.
config string
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deployMode Changes to this property will trigger replacement. string
The deploy mode.
deployNodeType Changes to this property will trigger replacement. string
The deploy node type.
name Changes to this property will trigger replacement. string
The name of the addon.
version string
The version info of the cluster.
cluster_id Changes to this property will trigger replacement. str
The cluster id of the addon.
config str
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deploy_mode Changes to this property will trigger replacement. str
The deploy mode.
deploy_node_type Changes to this property will trigger replacement. str
The deploy node type.
name Changes to this property will trigger replacement. str
The name of the addon.
version str
The version info of the cluster.
clusterId Changes to this property will trigger replacement. String
The cluster id of the addon.
config String
The config info of addon. Please notice that ingress-nginx component prohibits updating config, can only works on the web console.
deployMode Changes to this property will trigger replacement. String
The deploy mode.
deployNodeType Changes to this property will trigger replacement. String
The deploy node type.
name Changes to this property will trigger replacement. String
The name of the addon.
version String
The version info of the cluster.

Import

VkeAddon can be imported using the clusterId:Name, e.g.

$ pulumi import volcengine:vke/addon:Addon default cc9l74mvqtofjnoj5****:nginx-ingress
Copy

Notice

Some kind of VKEAddon can not be removed from volcengine, and it will make a forbidden error when try to destroy.

If you want to remove it from terraform state, please use command

$ terraform state rm volcengine_vke_addon.${name}

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

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine