Module eks

@pulumi/aws > eks

Index

• class Cluster
• function getCluster
• interface ClusterArgs
• interface ClusterState
• interface GetClusterArgs
• interface GetClusterResult

eks/cluster.ts eks/getCluster.ts

class Cluster

Manages an EKS Cluster.

constructor

new Cluster(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState): Cluster

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the cluster.

property certificateAuthority

public certificateAuthority: pulumi.Output<{ ... }>;

Nested attribute containing certificate-authority-data for your cluster.

property createdAt

public createdAt: pulumi.Output<string>;

property endpoint

public endpoint: pulumi.Output<string>;

The endpoint for your Kubernetes API server.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the cluster.

property platformVersion

public platformVersion: pulumi.Output<string>;

The platform version for the cluster.

property roleArn

public roleArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

Desired Kubernetes master version. If you do not specify a value, the latest available version is used.

property vpcConfig

public vpcConfig: pulumi.Output<{ ... }>;

Nested argument for the VPC associated with your cluster. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. Configuration detailed below.

function getCluster

getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>

Retrieve information about an EKS Cluster.

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property name

name?: pulumi.Input<string>;

Name of the cluster.

property roleArn

roleArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

property version

version?: pulumi.Input<string>;

Desired Kubernetes master version. If you do not specify a value, the latest available version is used.

property vpcConfig

vpcConfig: pulumi.Input<{ ... }>;

Nested argument for the VPC associated with your cluster. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. Configuration detailed below.

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the cluster.

property certificateAuthority

certificateAuthority?: pulumi.Input<{ ... }>;

Nested attribute containing certificate-authority-data for your cluster.

property createdAt

createdAt?: pulumi.Input<string>;

property endpoint

endpoint?: pulumi.Input<string>;

The endpoint for your Kubernetes API server.

property name

name?: pulumi.Input<string>;

Name of the cluster.

property platformVersion

platformVersion?: pulumi.Input<string>;

The platform version for the cluster.

property roleArn

roleArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

property version

version?: pulumi.Input<string>;

Desired Kubernetes master version. If you do not specify a value, the latest available version is used.

property vpcConfig

vpcConfig?: pulumi.Input<{ ... }>;

Nested argument for the VPC associated with your cluster. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. Configuration detailed below.

interface GetClusterArgs

A collection of arguments for invoking getCluster.

property name

name: string;

The name of the cluster

interface GetClusterResult

A collection of values returned by getCluster.

property arn

arn: string;

The Amazon Resource Name (ARN) of the cluster.

property certificateAuthority

certificateAuthority: { ... };

Nested attribute containing certificate-authority-data for your cluster.

property createdAt

createdAt: string;

The Unix epoch time stamp in seconds for when the cluster was created.

property endpoint

endpoint: string;

The endpoint for your Kubernetes API server.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property platformVersion

platformVersion: string;

The platform version for the cluster.

property roleArn

roleArn: string;

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

property version

version: string;

The Kubernetes server version for the cluster.

property vpcConfig

vpcConfig: { ... };

Nested attribute containing VPC configuration for the cluster.