@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
209 lines (208 loc) • 7.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages an EKS Capability for an EKS cluster.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.eks.Capability("example", {
* clusterName: exampleAwsEksCluster.name,
* capabilityName: "argocd",
* type: "ARGOCD",
* roleArn: exampleAwsIamRole.arn,
* deletePropagationPolicy: "RETAIN",
* configuration: {
* argoCd: {
* awsIdc: {
* idcInstanceArn: "arn:aws:sso:::instance/ssoins-1234567890abcdef0",
* },
* namespace: "argocd",
* },
* },
* tags: {
* Name: "example-capability",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import EKS Capability using the `cluster_name` and `capability_name` separated by a comma (`,`). For example:
*
* ```sh
* $ pulumi import aws:eks/capability:Capability example my-cluster,my-capability
* ```
*/
export declare class Capability extends pulumi.CustomResource {
/**
* Get an existing Capability resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CapabilityState, opts?: pulumi.CustomResourceOptions): Capability;
/**
* Returns true if the given object is an instance of Capability. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Capability;
/**
* ARN of the capability.
*/
readonly arn: pulumi.Output<string>;
/**
* Name of the capability. Must be unique within the cluster.
*/
readonly capabilityName: pulumi.Output<string>;
/**
* Name of the EKS cluster.
*/
readonly clusterName: pulumi.Output<string>;
/**
* Configuration for the capability. See `configuration` below.
*/
readonly configuration: pulumi.Output<outputs.eks.CapabilityConfiguration | undefined>;
/**
* Delete propagation policy for the capability. Valid values: `RETAIN`.
*/
readonly deletePropagationPolicy: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* ARN of the IAM role to associate with the capability.
*/
readonly roleArn: pulumi.Output<string>;
/**
* Key-value map of resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly timeouts: pulumi.Output<outputs.eks.CapabilityTimeouts | undefined>;
/**
* Type of the capability. Valid values: `ACK`, `KRO`, `ARGOCD`.
*/
readonly type: pulumi.Output<string>;
/**
* Version of the capability.
*/
readonly version: pulumi.Output<string>;
/**
* Create a Capability resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CapabilityArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Capability resources.
*/
export interface CapabilityState {
/**
* ARN of the capability.
*/
arn?: pulumi.Input<string>;
/**
* Name of the capability. Must be unique within the cluster.
*/
capabilityName?: pulumi.Input<string>;
/**
* Name of the EKS cluster.
*/
clusterName?: pulumi.Input<string>;
/**
* Configuration for the capability. See `configuration` below.
*/
configuration?: pulumi.Input<inputs.eks.CapabilityConfiguration>;
/**
* Delete propagation policy for the capability. Valid values: `RETAIN`.
*/
deletePropagationPolicy?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* ARN of the IAM role to associate with the capability.
*/
roleArn?: pulumi.Input<string>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.eks.CapabilityTimeouts>;
/**
* Type of the capability. Valid values: `ACK`, `KRO`, `ARGOCD`.
*/
type?: pulumi.Input<string>;
/**
* Version of the capability.
*/
version?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Capability resource.
*/
export interface CapabilityArgs {
/**
* Name of the capability. Must be unique within the cluster.
*/
capabilityName: pulumi.Input<string>;
/**
* Name of the EKS cluster.
*/
clusterName: pulumi.Input<string>;
/**
* Configuration for the capability. See `configuration` below.
*/
configuration?: pulumi.Input<inputs.eks.CapabilityConfiguration>;
/**
* Delete propagation policy for the capability. Valid values: `RETAIN`.
*/
deletePropagationPolicy: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* ARN of the IAM role to associate with the capability.
*/
roleArn: pulumi.Input<string>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.eks.CapabilityTimeouts>;
/**
* Type of the capability. Valid values: `ACK`, `KRO`, `ARGOCD`.
*/
type: pulumi.Input<string>;
}