Alibaba Cloud v3.66.0, Nov 15 24

Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

alicloud.cs.KubernetesAddon

Explore with Pulumi AI

Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-alicloud

Example Usage

Basic Usage

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: KubernetesAddonInitArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def KubernetesAddon(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cluster_id: Optional[str] = None,
                    cleanup_cloud_resources: Optional[bool] = None,
                    config: Optional[str] = None,
                    name: Optional[str] = None,
                    version: Optional[str] = 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: alicloud:cs:KubernetesAddon
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args KubernetesAddonArgs: 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 KubernetesAddonInitArgs: 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 KubernetesAddonArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KubernetesAddonArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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 AliCloud.CS.KubernetesAddon("kubernetesAddonResource", new()
{
    ClusterId = "string",
    CleanupCloudResources = false,
    Config = "string",
    Name = "string",
    Version = "string",
});

example, err := cs.NewKubernetesAddon(ctx, "kubernetesAddonResource", &cs.KubernetesAddonArgs{
	ClusterId:             pulumi.String("string"),
	CleanupCloudResources: pulumi.Bool(false),
	Config:                pulumi.String("string"),
	Name:                  pulumi.String("string"),
	Version:               pulumi.String("string"),
})

var kubernetesAddonResource = new KubernetesAddon("kubernetesAddonResource", KubernetesAddonArgs.builder()
    .clusterId("string")
    .cleanupCloudResources(false)
    .config("string")
    .name("string")
    .version("string")
    .build());

kubernetes_addon_resource = alicloud.cs.KubernetesAddon("kubernetesAddonResource",
    cluster_id="string",
    cleanup_cloud_resources=False,
    config="string",
    name="string",
    version="string")

const kubernetesAddonResource = new alicloud.cs.KubernetesAddon("kubernetesAddonResource", {
    clusterId: "string",
    cleanupCloudResources: false,
    config: "string",
    name: "string",
    version: "string",
});

type: alicloud:cs:KubernetesAddon
properties:
    cleanupCloudResources: false
    clusterId: string
    config: string
    name: string
    version: string

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:

ClusterId string: The id of kubernetes cluster.
CleanupCloudResources bool: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
Config string: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
Name string: The name of addon.
Version string: The current version of addon.

ClusterId string: The id of kubernetes cluster.
CleanupCloudResources bool: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
Config string: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
Name string: The name of addon.
Version string: The current version of addon.

clusterId String: The id of kubernetes cluster.
cleanupCloudResources Boolean: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
config String: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name String: The name of addon.
version String: The current version of addon.

clusterId string: The id of kubernetes cluster.
cleanupCloudResources boolean: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
config string: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name string: The name of addon.
version string: The current version of addon.

cluster_id str: The id of kubernetes cluster.
cleanup_cloud_resources bool: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
config str: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name str: The name of addon.
version str: The current version of addon.

clusterId String: The id of kubernetes cluster.
cleanupCloudResources Boolean: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
config String: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name String: The name of addon.
version String: The current version of addon.

Outputs

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

CanUpgrade bool: Is the addon ready for upgrade.
Id string: The provider-assigned unique ID for this managed resource.
NextVersion string: The version which addon can be upgraded to.
Required bool: Is it a mandatory addon to be installed.

CanUpgrade bool: Is the addon ready for upgrade.
Id string: The provider-assigned unique ID for this managed resource.
NextVersion string: The version which addon can be upgraded to.
Required bool: Is it a mandatory addon to be installed.

canUpgrade Boolean: Is the addon ready for upgrade.
id String: The provider-assigned unique ID for this managed resource.
nextVersion String: The version which addon can be upgraded to.
required Boolean: Is it a mandatory addon to be installed.

canUpgrade boolean: Is the addon ready for upgrade.
id string: The provider-assigned unique ID for this managed resource.
nextVersion string: The version which addon can be upgraded to.
required boolean: Is it a mandatory addon to be installed.

can_upgrade bool: Is the addon ready for upgrade.
id str: The provider-assigned unique ID for this managed resource.
next_version str: The version which addon can be upgraded to.
required bool: Is it a mandatory addon to be installed.

canUpgrade Boolean: Is the addon ready for upgrade.
id String: The provider-assigned unique ID for this managed resource.
nextVersion String: The version which addon can be upgraded to.
required Boolean: Is it a mandatory addon to be installed.

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,
        can_upgrade: Optional[bool] = None,
        cleanup_cloud_resources: Optional[bool] = None,
        cluster_id: Optional[str] = None,
        config: Optional[str] = None,
        name: Optional[str] = None,
        next_version: Optional[str] = None,
        required: Optional[bool] = None,
        version: Optional[str] = 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)

Resource lookup is not supported in YAML

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.

The following state arguments are supported:

CanUpgrade bool: Is the addon ready for upgrade.
CleanupCloudResources bool: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
ClusterId string: The id of kubernetes cluster.
Config string: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
Name string: The name of addon.
NextVersion string: The version which addon can be upgraded to.
Required bool: Is it a mandatory addon to be installed.
Version string: The current version of addon.

CanUpgrade bool: Is the addon ready for upgrade.
CleanupCloudResources bool: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
ClusterId string: The id of kubernetes cluster.
Config string: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
Name string: The name of addon.
NextVersion string: The version which addon can be upgraded to.
Required bool: Is it a mandatory addon to be installed.
Version string: The current version of addon.

canUpgrade Boolean: Is the addon ready for upgrade.
cleanupCloudResources Boolean: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
clusterId String: The id of kubernetes cluster.
config String: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name String: The name of addon.
nextVersion String: The version which addon can be upgraded to.
required Boolean: Is it a mandatory addon to be installed.
version String: The current version of addon.

canUpgrade boolean: Is the addon ready for upgrade.
cleanupCloudResources boolean: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
clusterId string: The id of kubernetes cluster.
config string: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name string: The name of addon.
nextVersion string: The version which addon can be upgraded to.
required boolean: Is it a mandatory addon to be installed.
version string: The current version of addon.

can_upgrade bool: Is the addon ready for upgrade.
cleanup_cloud_resources bool: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
cluster_id str: The id of kubernetes cluster.
config str: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name str: The name of addon.
next_version str: The version which addon can be upgraded to.
required bool: Is it a mandatory addon to be installed.
version str: The current version of addon.

canUpgrade Boolean: Is the addon ready for upgrade.
cleanupCloudResources Boolean: Whether to clean up cloud resources when deleting. Currently only works for addon ack-virtual-node and you must specify it when uninstall addon ack-virtual-node. Valid values: true: clean up, false: do not clean up.
clusterId String: The id of kubernetes cluster.
config String: The customized configuration of addon. Your customized configuration will be merged to existed configuration stored in server. If you want to clean one configuration, you must set the configuration to empty value, removing from code cannot make effect. You can checkout the customized configuration of the addon through datasource alicloud.cs.getKubernetesAddonMetadata, the returned format is the standard json schema. If return empty, it means that the addon does not support custom configuration yet. You can also checkout the current custom configuration through the data source alicloud.cs.getKubernetesAddons.
name String: The name of addon.
nextVersion String: The version which addon can be upgraded to.
required Boolean: Is it a mandatory addon to be installed.
version String: The current version of addon.

Import

Cluster addon can be imported by cluster id and addon name. Then write the addon.tf file according to the result of pulumi preview.

$ pulumi import alicloud:cs/kubernetesAddon:KubernetesAddon my_addon <cluster_id>:<addon_name>

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

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-alicloud

alicloud.cs.KubernetesAddon

On this page

On this page

Example Usage

Create KubernetesAddon Resource

Constructor syntax

Parameters

Constructor example

KubernetesAddon Resource Properties

Inputs

Outputs

Look up Existing KubernetesAddon Resource

Import

Package Details

On this page

On this page