Capability class

Manages an EKS Capability for an EKS cluster.

Example Usage

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

const example = new aws.eks.Capability("example", {
    configuration: {
        argoCd: {
            awsIdc: {
                idcInstanceArn: "arn:aws:sso:::instance/ssoins-1234567890abcdef0",
            },
            namespace: "argocd",
        },
    },
    clusterName: exampleAwsEksCluster.name,
    capabilityName: "argocd",
    type: "ARGOCD",
    roleArn: exampleAwsIamRole.arn,
    deletePropagationPolicy: "RETAIN",
    tags: {
        Name: "example-capability",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.eks.Capability("example",
    configuration={
        "argo_cd": {
            "aws_idc": {
                "idc_instance_arn": "arn:aws:sso:::instance/ssoins-1234567890abcdef0",
            },
            "namespace": "argocd",
        },
    },
    cluster_name=example_aws_eks_cluster["name"],
    capability_name="argocd",
    type="ARGOCD",
    role_arn=example_aws_iam_role["arn"],
    delete_propagation_policy="RETAIN",
    tags={
        "Name": "example-capability",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Eks.Capability("example", new()
    {
        Configuration = new Aws.Eks.Inputs.CapabilityConfigurationArgs
        {
            ArgoCd = new Aws.Eks.Inputs.CapabilityConfigurationArgoCdArgs
            {
                AwsIdc = new Aws.Eks.Inputs.CapabilityConfigurationArgoCdAwsIdcArgs
                {
                    IdcInstanceArn = "arn:aws:sso:::instance/ssoins-1234567890abcdef0",
                },
                Namespace = "argocd",
            },
        },
        ClusterName = exampleAwsEksCluster.Name,
        CapabilityName = "argocd",
        Type = "ARGOCD",
        RoleArn = exampleAwsIamRole.Arn,
        DeletePropagationPolicy = "RETAIN",
        Tags =
        {
            { "Name", "example-capability" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/eks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eks.NewCapability(ctx, "example", &eks.CapabilityArgs{
			Configuration: &eks.CapabilityConfigurationArgs{
				ArgoCd: &eks.CapabilityConfigurationArgoCdArgs{
					AwsIdc: &eks.CapabilityConfigurationArgoCdAwsIdcArgs{
						IdcInstanceArn: pulumi.String("arn:aws:sso:::instance/ssoins-1234567890abcdef0"),
					},
					Namespace: pulumi.String("argocd"),
				},
			},
			ClusterName:             pulumi.Any(exampleAwsEksCluster.Name),
			CapabilityName:          pulumi.String("argocd"),
			Type:                    pulumi.String("ARGOCD"),
			RoleArn:                 pulumi.Any(exampleAwsIamRole.Arn),
			DeletePropagationPolicy: pulumi.String("RETAIN"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-capability"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_eks_capability" "example" {
  configuration = {
    argo_cd = {
      aws_idc = {
        idc_instance_arn = "arn:aws:sso:::instance/ssoins-1234567890abcdef0"
      }
      namespace = "argocd"
    }
  }
  cluster_name              = exampleAwsEksCluster.name
  capability_name           = "argocd"
  type                      = "ARGOCD"
  role_arn                  = exampleAwsIamRole.arn
  delete_propagation_policy = "RETAIN"
  tags = {
    "Name" = "example-capability"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.Capability;
import com.pulumi.aws.eks.CapabilityArgs;
import com.pulumi.aws.eks.inputs.CapabilityConfigurationArgs;
import com.pulumi.aws.eks.inputs.CapabilityConfigurationArgoCdArgs;
import com.pulumi.aws.eks.inputs.CapabilityConfigurationArgoCdAwsIdcArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new Capability("example", CapabilityArgs.builder()
            .configuration(CapabilityConfigurationArgs.builder()
                .argoCd(CapabilityConfigurationArgoCdArgs.builder()
                    .awsIdc(CapabilityConfigurationArgoCdAwsIdcArgs.builder()
                        .idcInstanceArn("arn:aws:sso:::instance/ssoins-1234567890abcdef0")
                        .build())
                    .namespace("argocd")
                    .build())
                .build())
            .clusterName(exampleAwsEksCluster.name())
            .capabilityName("argocd")
            .type("ARGOCD")
            .roleArn(exampleAwsIamRole.arn())
            .deletePropagationPolicy("RETAIN")
            .tags(Map.of("Name", "example-capability"))
            .build());

    }
}
resources:
  example:
    type: aws:eks:Capability
    properties:
      configuration:
        argoCd:
          awsIdc:
            idcInstanceArn: arn:aws:sso:::instance/ssoins-1234567890abcdef0
          namespace: argocd
      clusterName: ${exampleAwsEksCluster.name}
      capabilityName: argocd
      type: ARGOCD
      roleArn: ${exampleAwsIamRole.arn}
      deletePropagationPolicy: RETAIN
      tags:
        Name: example-capability

Import

Identity Schema

Required

  • clusterName (String) Name of the EKS Cluster.
  • capabilityName (String) Name of the capability.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Capabilities using clusterName and capabilityName separated by a comma (,). For example:

$ pulumi import aws:eks/capability:Capability example example-cluster,example-capability

Constructors

Capability(String name, {CapabilityArgs? args, CustomResourceOptions? options})
Creates a new Capability. name The Pulumi resource name. args Arguments used to configure this Capability. The set of arguments for Capability. options Resource options controlling this resource's behavior.
Capability.reference(String urn)
Creates a typed reference to an existing Capability resource.

Properties

arn ↔ Output<String>
ARN of the capability.
latefinal
capabilityName ↔ Output<String>
Name of the capability. Must be unique within the cluster.
latefinal
childResources → Set<Resource>
finalinherited
clusterName ↔ Output<String>
Name of the EKS cluster.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configuration ↔ Output<CapabilityConfiguration?>
Configuration for the capability. See configuration below.
latefinal
deletePropagationPolicy ↔ Output<String>
Delete propagation policy for the capability. Valid values: RETAIN.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
roleArn ↔ Output<String>
ARN of the IAM role to associate with the capability.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
timeouts ↔ Output<CapabilityTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
Type of the capability. Valid values: ACK, KRO, ARGOCD.
latefinal
urn ↔ Output<String>
latefinalinherited
version ↔ Output<String>
Version of the capability.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {CapabilityState? state, CustomResourceOptions? options}) → Capability
Gets an existing Capability resource's state with the given name and id.