eks

package
v1.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 19, 2019 License: Apache-2.0 Imports: 2 Imported by: 3

Documentation

Overview

nolint: lll Package eks exports types, functions, subpackages for provisioning eks resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster

type Cluster struct {
	// contains filtered or unexported fields
}

Manages an EKS Cluster.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/eks_cluster.html.markdown.

func GetCluster

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterState, opts ...pulumi.ResourceOpt) (*Cluster, error)

GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCluster

func NewCluster(ctx *pulumi.Context,
	name string, args *ClusterArgs, opts ...pulumi.ResourceOpt) (*Cluster, error)

NewCluster registers a new resource with the given unique name, arguments, and options.

func (*Cluster) Arn added in v0.14.1

func (r *Cluster) Arn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the cluster.

func (*Cluster) CertificateAuthority

func (r *Cluster) CertificateAuthority() *pulumi.Output

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

func (*Cluster) CreatedAt

func (r *Cluster) CreatedAt() *pulumi.StringOutput

func (*Cluster) EnabledClusterLogTypes added in v0.18.2

func (r *Cluster) EnabledClusterLogTypes() *pulumi.ArrayOutput

A list of the desired control plane logging to enable. For more information, see [Amazon EKS Control Plane Logging](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)

func (*Cluster) Endpoint

func (r *Cluster) Endpoint() *pulumi.StringOutput

The endpoint for your Kubernetes API server.

func (*Cluster) ID

func (r *Cluster) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Cluster) Identities added in v1.2.0

func (r *Cluster) Identities() *pulumi.ArrayOutput

Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019.

func (*Cluster) Name

func (r *Cluster) Name() *pulumi.StringOutput

Name of the cluster.

func (*Cluster) PlatformVersion added in v0.16.0

func (r *Cluster) PlatformVersion() *pulumi.StringOutput

The platform version for the cluster.

func (*Cluster) RoleArn

func (r *Cluster) RoleArn() *pulumi.StringOutput

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.

func (*Cluster) Status added in v0.18.27

func (r *Cluster) Status() *pulumi.StringOutput

The status of the EKS cluster. One of `CREATING`, `ACTIVE`, `DELETING`, `FAILED`.

func (*Cluster) Tags added in v1.5.0

func (r *Cluster) Tags() *pulumi.MapOutput

Key-value mapping of resource tags.

func (*Cluster) URN

func (r *Cluster) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Cluster) Version

func (r *Cluster) Version() *pulumi.StringOutput

Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS.

func (*Cluster) VpcConfig

func (r *Cluster) 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](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the Amazon EKS User Guide. Configuration detailed below.

type ClusterArgs

type ClusterArgs struct {
	// A list of the desired control plane logging to enable. For more information, see [Amazon EKS Control Plane Logging](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)
	EnabledClusterLogTypes interface{}
	// Name of the cluster.
	Name interface{}
	// 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.
	RoleArn interface{}
	// Key-value mapping of resource tags.
	Tags interface{}
	// Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS.
	Version interface{}
	// 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](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the Amazon EKS User Guide. Configuration detailed below.
	VpcConfig interface{}
}

The set of arguments for constructing a Cluster resource.

type ClusterState

type ClusterState struct {
	// The Amazon Resource Name (ARN) of the cluster.
	Arn interface{}
	// Nested attribute containing `certificate-authority-data` for your cluster.
	CertificateAuthority interface{}
	CreatedAt            interface{}
	// A list of the desired control plane logging to enable. For more information, see [Amazon EKS Control Plane Logging](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)
	EnabledClusterLogTypes interface{}
	// The endpoint for your Kubernetes API server.
	Endpoint interface{}
	// Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019.
	Identities interface{}
	// Name of the cluster.
	Name interface{}
	// The platform version for the cluster.
	PlatformVersion interface{}
	// 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.
	RoleArn interface{}
	// The status of the EKS cluster. One of `CREATING`, `ACTIVE`, `DELETING`, `FAILED`.
	Status interface{}
	// Key-value mapping of resource tags.
	Tags interface{}
	// Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS.
	Version interface{}
	// 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](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the Amazon EKS User Guide. Configuration detailed below.
	VpcConfig interface{}
}

Input properties used for looking up and filtering Cluster resources.

type GetClusterArgs

type GetClusterArgs struct {
	// The name of the cluster
	Name interface{}
	Tags interface{}
}

A collection of arguments for invoking getCluster.

type GetClusterAuthArgs added in v0.16.8

type GetClusterAuthArgs struct {
	// The name of the cluster
	Name interface{}
}

A collection of arguments for invoking getClusterAuth.

type GetClusterAuthResult added in v0.16.8

type GetClusterAuthResult struct {
	Name interface{}
	// The token to use to authenticate with the cluster.
	Token interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getClusterAuth.

func LookupClusterAuth added in v0.16.8

func LookupClusterAuth(ctx *pulumi.Context, args *GetClusterAuthArgs) (*GetClusterAuthResult, error)

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](https://github.com/kubernetes-sigs/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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/eks_cluster_auth.html.markdown.

type GetClusterResult

type GetClusterResult struct {
	// The Amazon Resource Name (ARN) of the cluster.
	Arn interface{}
	// Nested attribute containing `certificate-authority-data` for your cluster.
	CertificateAuthority interface{}
	// The Unix epoch time stamp in seconds for when the cluster was created.
	CreatedAt interface{}
	// The enabled control plane logs.
	EnabledClusterLogTypes interface{}
	// The endpoint for your Kubernetes API server.
	Endpoint interface{}
	// Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the [`eks.Cluster` resource documentation](https://www.terraform.io/docs/providers/aws/r/eks_cluster.html).
	Identities interface{}
	Name       interface{}
	// The platform version for the cluster.
	PlatformVersion interface{}
	// 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.
	RoleArn interface{}
	// The status of the EKS cluster. One of `CREATING`, `ACTIVE`, `DELETING`, `FAILED`.
	Status interface{}
	// Key-value mapping of resource tags.
	Tags interface{}
	// The Kubernetes server version for the cluster.
	Version interface{}
	// Nested attribute containing VPC configuration for the cluster.
	VpcConfig interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getCluster.

func LookupCluster

func LookupCluster(ctx *pulumi.Context, args *GetClusterArgs) (*GetClusterResult, error)

Retrieve information about an EKS Cluster.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/eks_cluster.html.markdown.

type NodeGroup added in v1.10.0

type NodeGroup struct {
	// contains filtered or unexported fields
}

Manages an EKS Node Group, which can provision and optionally update an Auto Scaling Group of Kubernetes worker nodes compatible with EKS. Additional documentation about this functionality can be found in the [EKS User Guide](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/eks_node_group.html.markdown.

func GetNodeGroup added in v1.10.0

func GetNodeGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *NodeGroupState, opts ...pulumi.ResourceOpt) (*NodeGroup, error)

GetNodeGroup gets an existing NodeGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewNodeGroup added in v1.10.0

func NewNodeGroup(ctx *pulumi.Context,
	name string, args *NodeGroupArgs, opts ...pulumi.ResourceOpt) (*NodeGroup, error)

NewNodeGroup registers a new resource with the given unique name, arguments, and options.

func (*NodeGroup) AmiType added in v1.10.0

func (r *NodeGroup) AmiType() *pulumi.StringOutput

func (*NodeGroup) Arn added in v1.10.0

func (r *NodeGroup) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the EKS Node Group.

func (*NodeGroup) ClusterName added in v1.10.0

func (r *NodeGroup) ClusterName() *pulumi.StringOutput

Name of the EKS Cluster.

func (*NodeGroup) DiskSize added in v1.10.0

func (r *NodeGroup) DiskSize() *pulumi.IntOutput

func (*NodeGroup) ID added in v1.10.0

func (r *NodeGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*NodeGroup) InstanceTypes added in v1.10.0

func (r *NodeGroup) InstanceTypes() *pulumi.StringOutput

func (*NodeGroup) Labels added in v1.10.0

func (r *NodeGroup) Labels() *pulumi.MapOutput

Key-value mapping of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.

func (*NodeGroup) NodeGroupName added in v1.10.0

func (r *NodeGroup) NodeGroupName() *pulumi.StringOutput

Name of the EKS Node Group.

func (*NodeGroup) NodeRoleArn added in v1.10.0

func (r *NodeGroup) NodeRoleArn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.

func (*NodeGroup) ReleaseVersion added in v1.10.0

func (r *NodeGroup) ReleaseVersion() *pulumi.StringOutput

AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.

func (*NodeGroup) RemoteAccess added in v1.10.0

func (r *NodeGroup) RemoteAccess() *pulumi.Output

Configuration block with remote access settings. Detailed below.

func (*NodeGroup) Resources added in v1.10.0

func (r *NodeGroup) Resources() *pulumi.ArrayOutput

List of objects containing information about underlying resources.

func (*NodeGroup) ScalingConfig added in v1.10.0

func (r *NodeGroup) ScalingConfig() *pulumi.Output

Configuration block with scaling settings. Detailed below.

func (*NodeGroup) Status added in v1.10.0

func (r *NodeGroup) Status() *pulumi.StringOutput

Status of the EKS Node Group.

func (*NodeGroup) SubnetIds added in v1.10.0

func (r *NodeGroup) SubnetIds() *pulumi.ArrayOutput

Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME` (where `CLUSTER_NAME` is replaced with the name of the EKS Cluster).

func (*NodeGroup) Tags added in v1.10.0

func (r *NodeGroup) Tags() *pulumi.MapOutput

Key-value mapping of resource tags.

func (*NodeGroup) URN added in v1.10.0

func (r *NodeGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*NodeGroup) Version added in v1.10.0

func (r *NodeGroup) Version() *pulumi.StringOutput

type NodeGroupArgs added in v1.10.0

type NodeGroupArgs struct {
	AmiType interface{}
	// Name of the EKS Cluster.
	ClusterName   interface{}
	DiskSize      interface{}
	InstanceTypes interface{}
	// Key-value mapping of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
	Labels interface{}
	// Name of the EKS Node Group.
	NodeGroupName interface{}
	// Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
	NodeRoleArn interface{}
	// AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
	ReleaseVersion interface{}
	// Configuration block with remote access settings. Detailed below.
	RemoteAccess interface{}
	// Configuration block with scaling settings. Detailed below.
	ScalingConfig interface{}
	// Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME` (where `CLUSTER_NAME` is replaced with the name of the EKS Cluster).
	SubnetIds interface{}
	// Key-value mapping of resource tags.
	Tags    interface{}
	Version interface{}
}

The set of arguments for constructing a NodeGroup resource.

type NodeGroupState added in v1.10.0

type NodeGroupState struct {
	AmiType interface{}
	// Amazon Resource Name (ARN) of the EKS Node Group.
	Arn interface{}
	// Name of the EKS Cluster.
	ClusterName   interface{}
	DiskSize      interface{}
	InstanceTypes interface{}
	// Key-value mapping of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
	Labels interface{}
	// Name of the EKS Node Group.
	NodeGroupName interface{}
	// Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
	NodeRoleArn interface{}
	// AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
	ReleaseVersion interface{}
	// Configuration block with remote access settings. Detailed below.
	RemoteAccess interface{}
	// List of objects containing information about underlying resources.
	Resources interface{}
	// Configuration block with scaling settings. Detailed below.
	ScalingConfig interface{}
	// Status of the EKS Node Group.
	Status interface{}
	// Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME` (where `CLUSTER_NAME` is replaced with the name of the EKS Cluster).
	SubnetIds interface{}
	// Key-value mapping of resource tags.
	Tags    interface{}
	Version interface{}
}

Input properties used for looking up and filtering NodeGroup resources.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL