Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. vke
  5. getAddons
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.vke.getAddons

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of vke addons

    Example Usage

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

const default = volcengine.vke.getAddons({
    clusterIds: ["cccctv1vqtofp49d96ujg"],
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.vke.get_addons(cluster_ids=["cccctv1vqtofp49d96ujg"])

    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.GetAddons(ctx, &vke.GetAddonsArgs{
			ClusterIds: []string{
				"cccctv1vqtofp49d96ujg",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Vke.GetAddons.Invoke(new()
    {
        ClusterIds = new[]
        {
            "cccctv1vqtofp49d96ujg",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vke.VkeFunctions;
import com.pulumi.volcengine.vke.inputs.GetAddonsArgs;
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) {
        final var default = VkeFunctions.getAddons(GetAddonsArgs.builder()
            .clusterIds("cccctv1vqtofp49d96ujg")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:vke:getAddons
      Arguments:
        clusterIds:
          - cccctv1vqtofp49d96ujg

    Using getAddons

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAddons(args: GetAddonsArgs, opts?: InvokeOptions): Promise<GetAddonsResult>
function getAddonsOutput(args: GetAddonsOutputArgs, opts?: InvokeOptions): Output<GetAddonsResult>
    def get_addons(cluster_ids: Optional[Sequence[str]] = None,
               create_client_token: Optional[str] = None,
               deploy_modes: Optional[Sequence[str]] = None,
               deploy_node_types: Optional[Sequence[str]] = None,
               name_regex: Optional[str] = None,
               names: Optional[Sequence[str]] = None,
               output_file: Optional[str] = None,
               statuses: Optional[Sequence[GetAddonsStatus]] = None,
               update_client_token: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetAddonsResult
def get_addons_output(cluster_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               create_client_token: Optional[pulumi.Input[str]] = None,
               deploy_modes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               deploy_node_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               statuses: Optional[pulumi.Input[Sequence[pulumi.Input[GetAddonsStatusArgs]]]] = None,
               update_client_token: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetAddonsResult]
    func GetAddons(ctx *Context, args *GetAddonsArgs, opts ...InvokeOption) (*GetAddonsResult, error)
func GetAddonsOutput(ctx *Context, args *GetAddonsOutputArgs, opts ...InvokeOption) GetAddonsResultOutput

    > Note: This function is named GetAddons in the Go SDK.

    public static class GetAddons 
{
    public static Task<GetAddonsResult> InvokeAsync(GetAddonsArgs args, InvokeOptions? opts = null)
    public static Output<GetAddonsResult> Invoke(GetAddonsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAddonsResult> getAddons(GetAddonsArgs args, InvokeOptions options)
public static Output<GetAddonsResult> getAddons(GetAddonsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:vke/getAddons:getAddons
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterIds List<string>
    The IDs of Cluster.
    CreateClientToken string
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    DeployModes List<string>
    The deploy model, the value is Managed or Unmanaged.
    DeployNodeTypes List<string>
    The deploy node types, the value is Node or VirtualNode. Only effected when deploy_mode is Unmanaged.
    NameRegex string
    A Name Regex of addon.
    Names List<string>
    The Names of addons.
    OutputFile string
    File name where to save data source results.
    Statuses List<GetAddonsStatus>
    Array of addon states to filter.
    UpdateClientToken string
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    ClusterIds []string
    The IDs of Cluster.
    CreateClientToken string
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    DeployModes []string
    The deploy model, the value is Managed or Unmanaged.
    DeployNodeTypes []string
    The deploy node types, the value is Node or VirtualNode. Only effected when deploy_mode is Unmanaged.
    NameRegex string
    A Name Regex of addon.
    Names []string
    The Names of addons.
    OutputFile string
    File name where to save data source results.
    Statuses []GetAddonsStatus
    Array of addon states to filter.
    UpdateClientToken string
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    clusterIds List<String>
    The IDs of Cluster.
    createClientToken String
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    deployModes List<String>
    The deploy model, the value is Managed or Unmanaged.
    deployNodeTypes List<String>
    The deploy node types, the value is Node or VirtualNode. Only effected when deploy_mode is Unmanaged.
    nameRegex String
    A Name Regex of addon.
    names List<String>
    The Names of addons.
    outputFile String
    File name where to save data source results.
    statuses List<GetAddonsStatus>
    Array of addon states to filter.
    updateClientToken String
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    clusterIds string[]
    The IDs of Cluster.
    createClientToken string
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    deployModes string[]
    The deploy model, the value is Managed or Unmanaged.
    deployNodeTypes string[]
    The deploy node types, the value is Node or VirtualNode. Only effected when deploy_mode is Unmanaged.
    nameRegex string
    A Name Regex of addon.
    names string[]
    The Names of addons.
    outputFile string
    File name where to save data source results.
    statuses GetAddonsStatus[]
    Array of addon states to filter.
    updateClientToken string
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    cluster_ids Sequence[str]
    The IDs of Cluster.
    create_client_token str
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    deploy_modes Sequence[str]
    The deploy model, the value is Managed or Unmanaged.
    deploy_node_types Sequence[str]
    The deploy node types, the value is Node or VirtualNode. Only effected when deploy_mode is Unmanaged.
    name_regex str
    A Name Regex of addon.
    names Sequence[str]
    The Names of addons.
    output_file str
    File name where to save data source results.
    statuses Sequence[GetAddonsStatus]
    Array of addon states to filter.
    update_client_token str
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    clusterIds List<String>
    The IDs of Cluster.
    createClientToken String
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    deployModes List<String>
    The deploy model, the value is Managed or Unmanaged.
    deployNodeTypes List<String>
    The deploy node types, the value is Node or VirtualNode. Only effected when deploy_mode is Unmanaged.
    nameRegex String
    A Name Regex of addon.
    names List<String>
    The Names of addons.
    outputFile String
    File name where to save data source results.
    statuses List<Property Map>
    Array of addon states to filter.
    updateClientToken String
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.

    getAddons Result

    The following output properties are available:

    Addons List<GetAddonsAddon>
    The collection of addon query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of addon query.
    ClusterIds List<string>
    CreateClientToken string
    DeployModes List<string>
    DeployNodeTypes List<string>
    NameRegex string
    Names List<string>
    OutputFile string
    Statuses List<GetAddonsStatus>
    UpdateClientToken string
    Addons []GetAddonsAddon
    The collection of addon query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of addon query.
    ClusterIds []string
    CreateClientToken string
    DeployModes []string
    DeployNodeTypes []string
    NameRegex string
    Names []string
    OutputFile string
    Statuses []GetAddonsStatus
    UpdateClientToken string
    addons List<GetAddonsAddon>
    The collection of addon query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of addon query.
    clusterIds List<String>
    createClientToken String
    deployModes List<String>
    deployNodeTypes List<String>
    nameRegex String
    names List<String>
    outputFile String
    statuses List<GetAddonsStatus>
    updateClientToken String
    addons GetAddonsAddon[]
    The collection of addon query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of addon query.
    clusterIds string[]
    createClientToken string
    deployModes string[]
    deployNodeTypes string[]
    nameRegex string
    names string[]
    outputFile string
    statuses GetAddonsStatus[]
    updateClientToken string
    addons Sequence[GetAddonsAddon]
    The collection of addon query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of addon query.
    cluster_ids Sequence[str]
    create_client_token str
    deploy_modes Sequence[str]
    deploy_node_types Sequence[str]
    name_regex str
    names Sequence[str]
    output_file str
    statuses Sequence[GetAddonsStatus]
    update_client_token str
    addons List<Property Map>
    The collection of addon query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of addon query.
    clusterIds List<String>
    createClientToken String
    deployModes List<String>
    deployNodeTypes List<String>
    nameRegex String
    names List<String>
    outputFile String
    statuses List<Property Map>
    updateClientToken String

    Supporting Types

    GetAddonsAddon

    ClusterId string
    The ID of the Cluster.
    Config string
    The config of addon.
    CreateTime string
    Addon creation time. UTC+0 time in standard RFC3339 format.
    DeployMode string
    The deploy mode.
    DeployNodeType string
    The deploy node type.
    Name string
    The name of the cluster.
    Status GetAddonsAddonStatus
    The status of the addon.
    UpdateTime string
    The last time a request was accepted by the addon and executed or completed. UTC+0 time in standard RFC3339 format.
    Version string
    The name of the cluster.
    CreateClientToken string
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    UpdateClientToken string
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    ClusterId string
    The ID of the Cluster.
    Config string
    The config of addon.
    CreateTime string
    Addon creation time. UTC+0 time in standard RFC3339 format.
    DeployMode string
    The deploy mode.
    DeployNodeType string
    The deploy node type.
    Name string
    The name of the cluster.
    Status GetAddonsAddonStatus
    The status of the addon.
    UpdateTime string
    The last time a request was accepted by the addon and executed or completed. UTC+0 time in standard RFC3339 format.
    Version string
    The name of the cluster.
    CreateClientToken string
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    UpdateClientToken string
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    clusterId String
    The ID of the Cluster.
    config String
    The config of addon.
    createTime String
    Addon creation time. UTC+0 time in standard RFC3339 format.
    deployMode String
    The deploy mode.
    deployNodeType String
    The deploy node type.
    name String
    The name of the cluster.
    status GetAddonsAddonStatus
    The status of the addon.
    updateTime String
    The last time a request was accepted by the addon and executed or completed. UTC+0 time in standard RFC3339 format.
    version String
    The name of the cluster.
    createClientToken String
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    updateClientToken String
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    clusterId string
    The ID of the Cluster.
    config string
    The config of addon.
    createTime string
    Addon creation time. UTC+0 time in standard RFC3339 format.
    deployMode string
    The deploy mode.
    deployNodeType string
    The deploy node type.
    name string
    The name of the cluster.
    status GetAddonsAddonStatus
    The status of the addon.
    updateTime string
    The last time a request was accepted by the addon and executed or completed. UTC+0 time in standard RFC3339 format.
    version string
    The name of the cluster.
    createClientToken string
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    updateClientToken string
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    cluster_id str
    The ID of the Cluster.
    config str
    The config of addon.
    create_time str
    Addon creation time. UTC+0 time in standard RFC3339 format.
    deploy_mode str
    The deploy mode.
    deploy_node_type str
    The deploy node type.
    name str
    The name of the cluster.
    status GetAddonsAddonStatus
    The status of the addon.
    update_time str
    The last time a request was accepted by the addon and executed or completed. UTC+0 time in standard RFC3339 format.
    version str
    The name of the cluster.
    create_client_token str
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    update_client_token str
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    clusterId String
    The ID of the Cluster.
    config String
    The config of addon.
    createTime String
    Addon creation time. UTC+0 time in standard RFC3339 format.
    deployMode String
    The deploy mode.
    deployNodeType String
    The deploy node type.
    name String
    The name of the cluster.
    status Property Map
    The status of the addon.
    updateTime String
    The last time a request was accepted by the addon and executed or completed. UTC+0 time in standard RFC3339 format.
    version String
    The name of the cluster.
    createClientToken String
    ClientToken when the addon is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
    updateClientToken String
    The ClientToken when the last addon update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.

    GetAddonsAddonStatus

    Conditions List<GetAddonsAddonStatusCondition>
    The state condition in the current primary state of the cluster, that is, the reason for entering the primary state.
    Phase string
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    Conditions []GetAddonsAddonStatusCondition
    The state condition in the current primary state of the cluster, that is, the reason for entering the primary state.
    Phase string
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditions List<GetAddonsAddonStatusCondition>
    The state condition in the current primary state of the cluster, that is, the reason for entering the primary state.
    phase String
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditions GetAddonsAddonStatusCondition[]
    The state condition in the current primary state of the cluster, that is, the reason for entering the primary state.
    phase string
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditions Sequence[GetAddonsAddonStatusCondition]
    The state condition in the current primary state of the cluster, that is, the reason for entering the primary state.
    phase str
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditions List<Property Map>
    The state condition in the current primary state of the cluster, that is, the reason for entering the primary state.
    phase String
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.

    GetAddonsAddonStatusCondition

    Type string
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    Type string
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    type String
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    type string
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    type str
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    type String
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.

    GetAddonsStatus

    ConditionsType string
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    Phase string
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    ConditionsType string
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    Phase string
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditionsType String
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    phase String
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditionsType string
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    phase string
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditions_type str
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    phase str
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.
    conditionsType String
    The state condition in the current main state of the addon, that is, the reason for entering the main state, there can be multiple reasons, the value contains Progressing, Ok, Degraded,Unknown, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, NameConflict, ResourceCleanupFailed, ClusterVersionUpgrading.
    phase String
    The status of addon. the value contains Creating, Running, Updating, Deleting, Failed.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine