Edit This Page

eks

class pulumi_aws.eks.Cluster(resource_name, opts=None, name=None, role_arn=None, version=None, vpc_config=None, __name__=None, __opts__=None)

Manages an EKS Cluster.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – Name of the cluster.
  • role_arn (pulumi.Input[str]) – 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.
  • version (pulumi.Input[str]) – Desired Kubernetes master version. If you do not specify a value, the latest available version is used.
  • vpc_config (pulumi.Input[dict]) – 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.
arn = None

The Amazon Resource Name (ARN) of the cluster.

certificate_authority = None

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

endpoint = None

The endpoint for your Kubernetes API server.

name = None

Name of the cluster.

platform_version = None

The platform version for the cluster.

role_arn = None

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.

version = None

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

vpc_config = None

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.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.eks.GetClusterAuthResult(token=None, id=None)

A collection of values returned by getClusterAuth.

token = None

The token to use to authenticate with the cluster.

id = None

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

class pulumi_aws.eks.GetClusterResult(arn=None, certificate_authority=None, created_at=None, endpoint=None, platform_version=None, role_arn=None, version=None, vpc_config=None, id=None)

A collection of values returned by getCluster.

arn = None

The Amazon Resource Name (ARN) of the cluster.

certificate_authority = None

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

created_at = None

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

endpoint = None

The endpoint for your Kubernetes API server.

platform_version = None

The platform version for the cluster.

role_arn = None

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.

version = None

The Kubernetes server version for the cluster.

vpc_config = None

Nested attribute containing VPC configuration for the cluster.

id = None

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

pulumi_aws.eks.get_cluster(name=None)

Retrieve information about an EKS Cluster.

pulumi_aws.eks.get_cluster_auth(name=None)

Get an authentication token to communicate with an EKS cluster.

Uses IAM credentials from the AWS provider to generate a temporary token that is compatible with AWS IAM Authenticator authentication. This can be used to authenticate to an EKS cluster or to a cluster that has the AWS IAM Authenticator server configured.