Oracle Cloud Infrastructure v0.20.0, May 31 23

oci.ContainerEngine.getAddonOptions

Explore with Pulumi AI

This data source provides the list of Addon Options in Oracle Cloud Infrastructure Container Engine service.

Get list of supported addons for a specific kubernetes version.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testAddonOptions = Oci.ContainerEngine.GetAddonOptions.Invoke(new()
    {
        KubernetesVersion = @var.Addon_option_kubernetes_version,
        AddonName = oci_containerengine_addon.Test_addon.Name,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/ContainerEngine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ContainerEngine.GetAddonOptions(ctx, &containerengine.GetAddonOptionsArgs{
			KubernetesVersion: _var.Addon_option_kubernetes_version,
			AddonName:         pulumi.StringRef(oci_containerengine_addon.Test_addon.Name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ContainerEngine.ContainerEngineFunctions;
import com.pulumi.oci.ContainerEngine.inputs.GetAddonOptionsArgs;
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 testAddonOptions = ContainerEngineFunctions.getAddonOptions(GetAddonOptionsArgs.builder()
            .kubernetesVersion(var_.addon_option_kubernetes_version())
            .addonName(oci_containerengine_addon.test_addon().name())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_addon_options = oci.ContainerEngine.get_addon_options(kubernetes_version=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
    addon_name=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))

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

const testAddonOptions = oci.ContainerEngine.getAddonOptions({
    kubernetesVersion: _var.addon_option_kubernetes_version,
    addonName: oci_containerengine_addon.test_addon.name,
});

variables:
  testAddonOptions:
    fn::invoke:
      Function: oci:ContainerEngine:getAddonOptions
      Arguments:
        kubernetesVersion: ${var.addon_option_kubernetes_version}
        addonName: ${oci_containerengine_addon.test_addon.name}

Using getAddonOptions

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 getAddonOptions(args: GetAddonOptionsArgs, opts?: InvokeOptions): Promise<GetAddonOptionsResult>
function getAddonOptionsOutput(args: GetAddonOptionsOutputArgs, opts?: InvokeOptions): Output<GetAddonOptionsResult>

def get_addon_options(addon_name: Optional[str] = None,
                      filters: Optional[Sequence[_containerengine.GetAddonOptionsFilter]] = None,
                      kubernetes_version: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAddonOptionsResult
def get_addon_options_output(addon_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_containerengine.GetAddonOptionsFilterArgs]]]] = None,
                      kubernetes_version: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAddonOptionsResult]

func GetAddonOptions(ctx *Context, args *GetAddonOptionsArgs, opts ...InvokeOption) (*GetAddonOptionsResult, error)
func GetAddonOptionsOutput(ctx *Context, args *GetAddonOptionsOutputArgs, opts ...InvokeOption) GetAddonOptionsResultOutput

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

public static class GetAddonOptions 
{
    public static Task<GetAddonOptionsResult> InvokeAsync(GetAddonOptionsArgs args, InvokeOptions? opts = null)
    public static Output<GetAddonOptionsResult> Invoke(GetAddonOptionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAddonOptionsResult> getAddonOptions(GetAddonOptionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:ContainerEngine/getAddonOptions:getAddonOptions
  arguments:
    # arguments dictionary

The following arguments are supported:

KubernetesVersion string: The kubernetes version to fetch the addons.
AddonName string: The name of the addon.
Filters List<GetAddonOptionsFilter>

KubernetesVersion string: The kubernetes version to fetch the addons.
AddonName string: The name of the addon.
Filters []GetAddonOptionsFilter

kubernetesVersion String: The kubernetes version to fetch the addons.
addonName String: The name of the addon.
filters List<GetAddonOptionsFilter>

kubernetesVersion string: The kubernetes version to fetch the addons.
addonName string: The name of the addon.
filters GetAddonOptionsFilter[]

kubernetes_version str: The kubernetes version to fetch the addons.
addon_name str: The name of the addon.
filters GetAddonOptionsFilter]

kubernetesVersion String: The kubernetes version to fetch the addons.
addonName String: The name of the addon.
filters List<Property Map>

getAddonOptions Result

The following output properties are available:

AddonOptions List<GetAddonOptionsAddonOption>: The list of addon_options.
Id string: The provider-assigned unique ID for this managed resource.
KubernetesVersion string
AddonName string
Filters List<GetAddonOptionsFilter>

AddonOptions []GetAddonOptionsAddonOption: The list of addon_options.
Id string: The provider-assigned unique ID for this managed resource.
KubernetesVersion string
AddonName string
Filters []GetAddonOptionsFilter

addonOptions List<GetAddonOptionsAddonOption>: The list of addon_options.
id String: The provider-assigned unique ID for this managed resource.
kubernetesVersion String
addonName String
filters List<GetAddonOptionsFilter>

addonOptions GetAddonOptionsAddonOption[]: The list of addon_options.
id string: The provider-assigned unique ID for this managed resource.
kubernetesVersion string
addonName string
filters GetAddonOptionsFilter[]

addon_options GetAddonOptionsAddonOption]: The list of addon_options.
id str: The provider-assigned unique ID for this managed resource.
kubernetes_version str
addon_name str
filters GetAddonOptionsFilter]

addonOptions List<Property Map>: The list of addon_options.
id String: The provider-assigned unique ID for this managed resource.
kubernetesVersion String
addonName String
filters List<Property Map>

Supporting Types

GetAddonOptionsAddonOption

AddonGroup string: Addon group info, a namespace concept that groups addons with similar functionalities.
AddonSchemaVersion string: Addon definition schema version to validate addon.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Information about the addon version.
FreeformTags Dictionary<string, object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsEssential bool: Is it an essential addon for cluster operation or not.
Name string: Name of the addon and it would be unique.
State string: The life cycle state of the addon.
SystemTags Dictionary<string, object>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the work request was created.
Versions List<GetAddonOptionsAddonOptionVersion>: The resources this work request affects.

AddonGroup string: Addon group info, a namespace concept that groups addons with similar functionalities.
AddonSchemaVersion string: Addon definition schema version to validate addon.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Information about the addon version.
FreeformTags map[string]interface{}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsEssential bool: Is it an essential addon for cluster operation or not.
Name string: Name of the addon and it would be unique.
State string: The life cycle state of the addon.
SystemTags map[string]interface{}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the work request was created.
Versions []GetAddonOptionsAddonOptionVersion: The resources this work request affects.

addonGroup String: Addon group info, a namespace concept that groups addons with similar functionalities.
addonSchemaVersion String: Addon definition schema version to validate addon.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Information about the addon version.
freeformTags Map<String,Object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isEssential Boolean: Is it an essential addon for cluster operation or not.
name String: Name of the addon and it would be unique.
state String: The life cycle state of the addon.
systemTags Map<String,Object>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the work request was created.
versions List<GetAddonOptionsAddonOptionVersion>: The resources this work request affects.

addonGroup string: Addon group info, a namespace concept that groups addons with similar functionalities.
addonSchemaVersion string: Addon definition schema version to validate addon.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: Information about the addon version.
freeformTags {[key: string]: any}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isEssential boolean: Is it an essential addon for cluster operation or not.
name string: Name of the addon and it would be unique.
state string: The life cycle state of the addon.
systemTags {[key: string]: any}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the work request was created.
versions GetAddonOptionsAddonOptionVersion[]: The resources this work request affects.

addon_group str: Addon group info, a namespace concept that groups addons with similar functionalities.
addon_schema_version str: Addon definition schema version to validate addon.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: Information about the addon version.
freeform_tags Mapping[str, Any]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
is_essential bool: Is it an essential addon for cluster operation or not.
name str: Name of the addon and it would be unique.
state str: The life cycle state of the addon.
system_tags Mapping[str, Any]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time the work request was created.
versions GetAddonOptionsAddonOptionVersion]: The resources this work request affects.

addonGroup String: Addon group info, a namespace concept that groups addons with similar functionalities.
addonSchemaVersion String: Addon definition schema version to validate addon.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Information about the addon version.
freeformTags Map<Any>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isEssential Boolean: Is it an essential addon for cluster operation or not.
name String: Name of the addon and it would be unique.
state String: The life cycle state of the addon.
systemTags Map<Any>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the work request was created.
versions List<Property Map>: The resources this work request affects.

GetAddonOptionsAddonOptionVersion

Configurations List<GetAddonOptionsAddonOptionVersionConfiguration>: Addon version configuration details.
Description string: Information about the addon version.
KubernetesVersionFilters List<GetAddonOptionsAddonOptionVersionKubernetesVersionFilter>: The range of kubernetes versions an addon can be configured.
Status string: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.
VersionNumber string: Version number, need be comparable within an addon.

Configurations []GetAddonOptionsAddonOptionVersionConfiguration: Addon version configuration details.
Description string: Information about the addon version.
KubernetesVersionFilters []GetAddonOptionsAddonOptionVersionKubernetesVersionFilter: The range of kubernetes versions an addon can be configured.
Status string: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.
VersionNumber string: Version number, need be comparable within an addon.

configurations List<GetAddonOptionsAddonOptionVersionConfiguration>: Addon version configuration details.
description String: Information about the addon version.
kubernetesVersionFilters List<GetAddonOptionsAddonOptionVersionKubernetesVersionFilter>: The range of kubernetes versions an addon can be configured.
status String: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.
versionNumber String: Version number, need be comparable within an addon.

configurations GetAddonOptionsAddonOptionVersionConfiguration[]: Addon version configuration details.
description string: Information about the addon version.
kubernetesVersionFilters GetAddonOptionsAddonOptionVersionKubernetesVersionFilter[]: The range of kubernetes versions an addon can be configured.
status string: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.
versionNumber string: Version number, need be comparable within an addon.

configurations GetAddonOptionsAddonOptionVersionConfiguration]: Addon version configuration details.
description str: Information about the addon version.
kubernetes_version_filters GetAddonOptionsAddonOptionVersionKubernetesVersionFilter]: The range of kubernetes versions an addon can be configured.
status str: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.
version_number str: Version number, need be comparable within an addon.

configurations List<Property Map>: Addon version configuration details.
description String: Information about the addon version.
kubernetesVersionFilters List<Property Map>: The range of kubernetes versions an addon can be configured.
status String: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.
versionNumber String: Version number, need be comparable within an addon.

GetAddonOptionsAddonOptionVersionConfiguration

Description string: Information about the addon version.
DisplayName string: Display name of addon version.
IsRequired bool: If the the configuration is required or not.
Key string: Addon configuration key
Value string: Addon configuration value

Description string: Information about the addon version.
DisplayName string: Display name of addon version.
IsRequired bool: If the the configuration is required or not.
Key string: Addon configuration key
Value string: Addon configuration value

description String: Information about the addon version.
displayName String: Display name of addon version.
isRequired Boolean: If the the configuration is required or not.
key String: Addon configuration key
value String: Addon configuration value

description string: Information about the addon version.
displayName string: Display name of addon version.
isRequired boolean: If the the configuration is required or not.
key string: Addon configuration key
value string: Addon configuration value

description str: Information about the addon version.
display_name str: Display name of addon version.
is_required bool: If the the configuration is required or not.
key str: Addon configuration key
value str: Addon configuration value

description String: Information about the addon version.
displayName String: Display name of addon version.
isRequired Boolean: If the the configuration is required or not.
key String: Addon configuration key
value String: Addon configuration value

GetAddonOptionsAddonOptionVersionKubernetesVersionFilter

ExactKubernetesVersions List<string>: The exact version of kubernetes that are compatible.
MaximumVersion string: The latest kubernetes version.
MinimalVersion string: The earliest kubernetes version.

ExactKubernetesVersions []string: The exact version of kubernetes that are compatible.
MaximumVersion string: The latest kubernetes version.
MinimalVersion string: The earliest kubernetes version.

exactKubernetesVersions List<String>: The exact version of kubernetes that are compatible.
maximumVersion String: The latest kubernetes version.
minimalVersion String: The earliest kubernetes version.

exactKubernetesVersions string[]: The exact version of kubernetes that are compatible.
maximumVersion string: The latest kubernetes version.
minimalVersion string: The earliest kubernetes version.

exact_kubernetes_versions Sequence[str]: The exact version of kubernetes that are compatible.
maximum_version str: The latest kubernetes version.
minimal_version str: The earliest kubernetes version.

exactKubernetesVersions List<String>: The exact version of kubernetes that are compatible.
maximumVersion String: The latest kubernetes version.
minimalVersion String: The earliest kubernetes version.

GetAddonOptionsFilter

Name string: Name of the addon and it would be unique.
Values List<string>
Regex bool

Name string: Name of the addon and it would be unique.
Values []string
Regex bool

name String: Name of the addon and it would be unique.
values List<String>
regex Boolean

name string: Name of the addon and it would be unique.
values string[]
regex boolean

name str: Name of the addon and it would be unique.
values Sequence[str]
regex bool

name String: Name of the addon and it would be unique.
values List<String>
regex Boolean

Package Details

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