eks

package
v0.16.0 Latest Latest
Warning

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

Go to latest
Published: Nov 13, 2019 License: Apache-2.0 Imports: 7 Imported by: 246

Documentation

Overview

Package eks provides the client and types for making API requests to Amazon EKS.

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

See https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01 for more information on this service.

See eks package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/eks/

Using the Client

To use Amazon EKS with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon EKS client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/eks/#New

Index

Examples

Constants

View Source
const (
	ServiceName = "Amazon EKS" // Service's name
	ServiceID   = "EKS"        // Service's identifier
	EndpointsID = "eks"        // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// This exception is thrown if the request contains a semantic error. The precise
	// meaning will depend on the API, and will be documented in the error message.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeException for service response error code
	// "Exception".
	//
	// These errors are usually caused by a client action. Actions can include using
	// an action or resource on behalf of a user that doesn't have permissions to
	// use the action or resource or specifying an identifier that is not valid.
	ErrCodeException = "Exception"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// The specified parameter is invalid. Review the available parameters for the
	// API request.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is invalid given the state of the cluster. Check the state of
	// the cluster and the associated operations.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// A service resource associated with the request could not be found. Clients
	// should not retry such requests.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource is in use.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// You have encountered a service limit on the specified resource.
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource could not be found. You can view your available clusters
	// with ListClusters. Amazon EKS clusters are Region-specific.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServerException for service response error code
	// "ServerException".
	//
	// These errors are usually caused by a server-side issue.
	ErrCodeServerException = "ServerException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is unavailable. Back off and retry the operation.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeUnsupportedAvailabilityZoneException for service response error code
	// "UnsupportedAvailabilityZoneException".
	//
	// At least one of your specified cluster subnets is in an Availability Zone
	// that does not support Amazon EKS. The exception output specifies the supported
	// Availability Zones for your account, from which you can choose subnets for
	// your cluster.
	ErrCodeUnsupportedAvailabilityZoneException = "UnsupportedAvailabilityZoneException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Certificate

type Certificate struct {

	// The Base64-encoded certificate data required to communicate with your cluster.
	// Add this to the certificate-authority-data section of the kubeconfig file
	// for your cluster.
	Data *string `locationName:"data" type:"string"`
	// contains filtered or unexported fields
}

An object representing the certificate-authority-data for your cluster.

func (Certificate) MarshalFields

func (s Certificate) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Certificate) String

func (s Certificate) String() string

String returns the string representation

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon EKS. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := eks.New(myConfig)

func (*Client) CreateClusterRequest added in v0.9.0

func (c *Client) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest

CreateClusterRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/).

Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication (https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) and Launching Amazon EKS Worker Nodes (https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the Amazon EKS User Guide.

// Example sending a request using CreateClusterRequest.
req := client.CreateClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateCluster

Example (Shared00)

To create a new cluster

The following example creates an Amazon EKS cluster called prod.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/eks"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := eks.New(cfg)
	input := &eks.CreateClusterInput{
		ClientRequestToken: aws.String("1d2129a1-3d38-460a-9756-e5b91fddb951"),
		Name:               aws.String("prod"),
		ResourcesVpcConfig: &eks.VpcConfigRequest{
			SecurityGroupIds: []string{
				"sg-6979fe18",
			},
			SubnetIds: []string{
				"subnet-6782e71e",
				"subnet-e7e761ac",
			},
		},
		RoleArn: aws.String("arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI"),
		Version: aws.String("1.10"),
	}

	req := svc.CreateClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case eks.ErrCodeResourceInUseException:
				fmt.Println(eks.ErrCodeResourceInUseException, aerr.Error())
			case eks.ErrCodeResourceLimitExceededException:
				fmt.Println(eks.ErrCodeResourceLimitExceededException, aerr.Error())
			case eks.ErrCodeInvalidParameterException:
				fmt.Println(eks.ErrCodeInvalidParameterException, aerr.Error())
			case eks.ErrCodeException:
				fmt.Println(eks.ErrCodeException, aerr.Error())
			case eks.ErrCodeServerException:
				fmt.Println(eks.ErrCodeServerException, aerr.Error())
			case eks.ErrCodeServiceUnavailableException:
				fmt.Println(eks.ErrCodeServiceUnavailableException, aerr.Error())
			case eks.ErrCodeUnsupportedAvailabilityZoneException:
				fmt.Println(eks.ErrCodeUnsupportedAvailabilityZoneException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteClusterRequest added in v0.9.0

func (c *Client) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest

DeleteClusterRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Deletes the Amazon EKS cluster control plane.

If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster (https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html) in the Amazon EKS User Guide.

// Example sending a request using DeleteClusterRequest.
req := client.DeleteClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteCluster

Example (Shared00)

To delete a cluster

This example command deletes a cluster named `devel` in your default region.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/eks"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := eks.New(cfg)
	input := &eks.DeleteClusterInput{
		Name: aws.String("devel"),
	}

	req := svc.DeleteClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case eks.ErrCodeResourceInUseException:
				fmt.Println(eks.ErrCodeResourceInUseException, aerr.Error())
			case eks.ErrCodeResourceNotFoundException:
				fmt.Println(eks.ErrCodeResourceNotFoundException, aerr.Error())
			case eks.ErrCodeException:
				fmt.Println(eks.ErrCodeException, aerr.Error())
			case eks.ErrCodeServerException:
				fmt.Println(eks.ErrCodeServerException, aerr.Error())
			case eks.ErrCodeServiceUnavailableException:
				fmt.Println(eks.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeClusterRequest added in v0.9.0

func (c *Client) DescribeClusterRequest(input *DescribeClusterInput) DescribeClusterRequest

DescribeClusterRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Returns descriptive information about an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS (https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html).

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

// Example sending a request using DescribeClusterRequest.
req := client.DescribeClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeCluster

Example (Shared00)

To describe a cluster

This example command provides a description of the specified cluster in your default region.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/eks"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := eks.New(cfg)
	input := &eks.DescribeClusterInput{
		Name: aws.String("devel"),
	}

	req := svc.DescribeClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case eks.ErrCodeResourceNotFoundException:
				fmt.Println(eks.ErrCodeResourceNotFoundException, aerr.Error())
			case eks.ErrCodeException:
				fmt.Println(eks.ErrCodeException, aerr.Error())
			case eks.ErrCodeServerException:
				fmt.Println(eks.ErrCodeServerException, aerr.Error())
			case eks.ErrCodeServiceUnavailableException:
				fmt.Println(eks.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeUpdateRequest added in v0.9.0

func (c *Client) DescribeUpdateRequest(input *DescribeUpdateInput) DescribeUpdateRequest

DescribeUpdateRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

// Example sending a request using DescribeUpdateRequest.
req := client.DescribeUpdateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeUpdate

func (*Client) ListClustersRequest added in v0.9.0

func (c *Client) ListClustersRequest(input *ListClustersInput) ListClustersRequest

ListClustersRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Lists the Amazon EKS clusters in your AWS account in the specified Region.

// Example sending a request using ListClustersRequest.
req := client.ListClustersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListClusters

Example (Shared00)

To list your available clusters

This example command lists all of your available clusters in your default region.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/eks"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := eks.New(cfg)
	input := &eks.ListClustersInput{}

	req := svc.ListClustersRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case eks.ErrCodeInvalidParameterException:
				fmt.Println(eks.ErrCodeInvalidParameterException, aerr.Error())
			case eks.ErrCodeException:
				fmt.Println(eks.ErrCodeException, aerr.Error())
			case eks.ErrCodeServerException:
				fmt.Println(eks.ErrCodeServerException, aerr.Error())
			case eks.ErrCodeServiceUnavailableException:
				fmt.Println(eks.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListTagsForResourceRequest added in v0.12.0

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

List the tags for an Amazon EKS resource.

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListTagsForResource

func (*Client) ListUpdatesRequest added in v0.9.0

func (c *Client) ListUpdatesRequest(input *ListUpdatesInput) ListUpdatesRequest

ListUpdatesRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

// Example sending a request using ListUpdatesRequest.
req := client.ListUpdatesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListUpdates

func (*Client) TagResourceRequest added in v0.12.0

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/TagResource

func (*Client) UntagResourceRequest added in v0.12.0

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Deletes specified tags from a resource.

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UntagResource

func (*Client) UpdateClusterConfigRequest added in v0.9.0

func (c *Client) UpdateClusterConfigRequest(input *UpdateClusterConfigInput) UpdateClusterConfigRequest

UpdateClusterConfigRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/).

You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the Amazon EKS User Guide .

At this time, you can not update the subnets or security group IDs for an existing cluster.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

// Example sending a request using UpdateClusterConfigRequest.
req := client.UpdateClusterConfigRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateClusterConfig

func (*Client) UpdateClusterVersionRequest added in v0.9.0

func (c *Client) UpdateClusterVersionRequest(input *UpdateClusterVersionInput) UpdateClusterVersionRequest

UpdateClusterVersionRequest returns a request value for making API operation for Amazon Elastic Kubernetes Service.

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

// Example sending a request using UpdateClusterVersionRequest.
req := client.UpdateClusterVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateClusterVersion

func (*Client) WaitUntilClusterActive added in v0.9.0

func (c *Client) WaitUntilClusterActive(ctx context.Context, input *DescribeClusterInput, opts ...aws.WaiterOption) error

WaitUntilClusterActive uses the Amazon EKS API operation DescribeCluster to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilClusterDeleted added in v0.9.0

func (c *Client) WaitUntilClusterDeleted(ctx context.Context, input *DescribeClusterInput, opts ...aws.WaiterOption) error

WaitUntilClusterDeleted uses the Amazon EKS API operation DescribeCluster to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Cluster

type Cluster struct {

	// The Amazon Resource Name (ARN) of the cluster.
	Arn *string `locationName:"arn" type:"string"`

	// The certificate-authority-data for your cluster.
	CertificateAuthority *Certificate `locationName:"certificateAuthority" type:"structure"`

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientRequestToken *string `locationName:"clientRequestToken" type:"string"`

	// The Unix epoch timestamp in seconds for when the cluster was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The endpoint for your Kubernetes API server.
	Endpoint *string `locationName:"endpoint" type:"string"`

	// The identity provider information for the cluster.
	Identity *Identity `locationName:"identity" type:"structure"`

	// The logging configuration for your cluster.
	Logging *Logging `locationName:"logging" type:"structure"`

	// The name of the cluster.
	Name *string `locationName:"name" type:"string"`

	// The platform version of your Amazon EKS cluster. For more information, see
	// Platform Versions (https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html)
	// in the Amazon EKS User Guide .
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// The VPC configuration used by the cluster control plane. 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.
	ResourcesVpcConfig *VpcConfigResponse `locationName:"resourcesVpcConfig" type:"structure"`

	// 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 *string `locationName:"roleArn" type:"string"`

	// The current status of the cluster.
	Status ClusterStatus `locationName:"status" type:"string" enum:"true"`

	// The metadata that you apply to the cluster to assist with categorization
	// and organization. Each tag consists of a key and an optional value, both
	// of which you define.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`

	// The Kubernetes server version for the cluster.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

An object representing an Amazon EKS cluster.

func (Cluster) MarshalFields

func (s Cluster) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Cluster) String

func (s Cluster) String() string

String returns the string representation

type ClusterStatus

type ClusterStatus string
const (
	ClusterStatusCreating ClusterStatus = "CREATING"
	ClusterStatusActive   ClusterStatus = "ACTIVE"
	ClusterStatusDeleting ClusterStatus = "DELETING"
	ClusterStatusFailed   ClusterStatus = "FAILED"
)

Enum values for ClusterStatus

func (ClusterStatus) MarshalValue

func (enum ClusterStatus) MarshalValue() (string, error)

func (ClusterStatus) MarshalValueBuf

func (enum ClusterStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CreateClusterInput

type CreateClusterInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientRequestToken *string `locationName:"clientRequestToken" type:"string" idempotencyToken:"true"`

	// Enable or disable exporting the Kubernetes control plane logs for your cluster
	// to CloudWatch Logs. By default, cluster control plane logs aren't exported
	// to CloudWatch Logs. For more information, see Amazon EKS Cluster Control
	// Plane Logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)
	// in the Amazon EKS User Guide .
	//
	// CloudWatch Logs ingestion, archive storage, and data scanning rates apply
	// to exported control plane logs. For more information, see Amazon CloudWatch
	// Pricing (http://aws.amazon.com/cloudwatch/pricing/).
	Logging *Logging `locationName:"logging" type:"structure"`

	// The unique name to give to your cluster.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The VPC configuration used by the cluster control plane. 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. You must specify at least two subnets. You
	// can specify up to five security groups, but we recommend that you use a dedicated
	// security group for your cluster control plane.
	//
	// ResourcesVpcConfig is a required field
	ResourcesVpcConfig *VpcConfigRequest `locationName:"resourcesVpcConfig" type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that provides permissions
	// for Amazon EKS to make calls to other AWS API operations on your behalf.
	// For more information, see Amazon EKS Service IAM Role (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html)
	// in the Amazon EKS User Guide .
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The metadata to apply to the cluster to assist with categorization and organization.
	// Each tag consists of a key and an optional value, both of which you define.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`

	// The desired Kubernetes version for your cluster. If you don't specify a value
	// here, the latest version available in Amazon EKS is used.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (CreateClusterInput) MarshalFields

func (s CreateClusterInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateClusterInput) String

func (s CreateClusterInput) String() string

String returns the string representation

func (*CreateClusterInput) Validate

func (s *CreateClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateClusterOutput

type CreateClusterOutput struct {

	// The full description of your new cluster.
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateClusterOutput) MarshalFields

func (s CreateClusterOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateClusterOutput) String

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateClusterRequest

type CreateClusterRequest struct {
	*aws.Request
	Input *CreateClusterInput
	Copy  func(*CreateClusterInput) CreateClusterRequest
}

CreateClusterRequest is the request type for the CreateCluster API operation.

func (CreateClusterRequest) Send

Send marshals and sends the CreateCluster API request.

type CreateClusterResponse added in v0.9.0

type CreateClusterResponse struct {
	*CreateClusterOutput
	// contains filtered or unexported fields
}

CreateClusterResponse is the response type for the CreateCluster API operation.

func (*CreateClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCluster request.

type DeleteClusterInput

type DeleteClusterInput struct {

	// The name of the cluster to delete.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterInput) MarshalFields

func (s DeleteClusterInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteClusterInput) String

func (s DeleteClusterInput) String() string

String returns the string representation

func (*DeleteClusterInput) Validate

func (s *DeleteClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteClusterOutput

type DeleteClusterOutput struct {

	// The full description of the cluster to delete.
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteClusterOutput) MarshalFields

func (s DeleteClusterOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteClusterOutput) String

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteClusterRequest

type DeleteClusterRequest struct {
	*aws.Request
	Input *DeleteClusterInput
	Copy  func(*DeleteClusterInput) DeleteClusterRequest
}

DeleteClusterRequest is the request type for the DeleteCluster API operation.

func (DeleteClusterRequest) Send

Send marshals and sends the DeleteCluster API request.

type DeleteClusterResponse added in v0.9.0

type DeleteClusterResponse struct {
	*DeleteClusterOutput
	// contains filtered or unexported fields
}

DeleteClusterResponse is the response type for the DeleteCluster API operation.

func (*DeleteClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCluster request.

type DescribeClusterInput

type DescribeClusterInput struct {

	// The name of the cluster to describe.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeClusterInput) MarshalFields

func (s DescribeClusterInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeClusterInput) String

func (s DescribeClusterInput) String() string

String returns the string representation

func (*DescribeClusterInput) Validate

func (s *DescribeClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeClusterOutput

type DescribeClusterOutput struct {

	// The full description of your specified cluster.
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeClusterOutput) MarshalFields

func (s DescribeClusterOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeClusterOutput) String

func (s DescribeClusterOutput) String() string

String returns the string representation

type DescribeClusterRequest

type DescribeClusterRequest struct {
	*aws.Request
	Input *DescribeClusterInput
	Copy  func(*DescribeClusterInput) DescribeClusterRequest
}

DescribeClusterRequest is the request type for the DescribeCluster API operation.

func (DescribeClusterRequest) Send

Send marshals and sends the DescribeCluster API request.

type DescribeClusterResponse added in v0.9.0

type DescribeClusterResponse struct {
	*DescribeClusterOutput
	// contains filtered or unexported fields
}

DescribeClusterResponse is the response type for the DescribeCluster API operation.

func (*DescribeClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCluster request.

type DescribeUpdateInput added in v0.7.0

type DescribeUpdateInput struct {

	// The name of the Amazon EKS cluster to update.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The ID of the update to describe.
	//
	// UpdateId is a required field
	UpdateId *string `location:"uri" locationName:"updateId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUpdateInput) MarshalFields added in v0.7.0

func (s DescribeUpdateInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUpdateInput) String added in v0.7.0

func (s DescribeUpdateInput) String() string

String returns the string representation

func (*DescribeUpdateInput) Validate added in v0.7.0

func (s *DescribeUpdateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUpdateOutput added in v0.7.0

type DescribeUpdateOutput struct {

	// The full description of the specified update.
	Update *Update `locationName:"update" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeUpdateOutput) MarshalFields added in v0.7.0

func (s DescribeUpdateOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUpdateOutput) String added in v0.7.0

func (s DescribeUpdateOutput) String() string

String returns the string representation

type DescribeUpdateRequest added in v0.7.0

type DescribeUpdateRequest struct {
	*aws.Request
	Input *DescribeUpdateInput
	Copy  func(*DescribeUpdateInput) DescribeUpdateRequest
}

DescribeUpdateRequest is the request type for the DescribeUpdate API operation.

func (DescribeUpdateRequest) Send added in v0.7.0

Send marshals and sends the DescribeUpdate API request.

type DescribeUpdateResponse added in v0.9.0

type DescribeUpdateResponse struct {
	*DescribeUpdateOutput
	// contains filtered or unexported fields
}

DescribeUpdateResponse is the response type for the DescribeUpdate API operation.

func (*DescribeUpdateResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeUpdateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUpdate request.

type ErrorCode added in v0.7.0

type ErrorCode string
const (
	ErrorCodeSubnetNotFound        ErrorCode = "SubnetNotFound"
	ErrorCodeSecurityGroupNotFound ErrorCode = "SecurityGroupNotFound"
	ErrorCodeEniLimitReached       ErrorCode = "EniLimitReached"
	ErrorCodeIpNotAvailable        ErrorCode = "IpNotAvailable"
	ErrorCodeAccessDenied          ErrorCode = "AccessDenied"
	ErrorCodeOperationNotPermitted ErrorCode = "OperationNotPermitted"
	ErrorCodeVpcIdNotFound         ErrorCode = "VpcIdNotFound"
	ErrorCodeUnknown               ErrorCode = "Unknown"
)

Enum values for ErrorCode

func (ErrorCode) MarshalValue added in v0.7.0

func (enum ErrorCode) MarshalValue() (string, error)

func (ErrorCode) MarshalValueBuf added in v0.7.0

func (enum ErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

type ErrorDetail added in v0.7.0

type ErrorDetail struct {

	// A brief description of the error.
	//
	//    * SubnetNotFound: We couldn't find one of the subnets associated with
	//    the cluster.
	//
	//    * SecurityGroupNotFound: We couldn't find one of the security groups associated
	//    with the cluster.
	//
	//    * EniLimitReached: You have reached the elastic network interface limit
	//    for your account.
	//
	//    * IpNotAvailable: A subnet associated with the cluster doesn't have any
	//    free IP addresses.
	//
	//    * AccessDenied: You don't have permissions to perform the specified operation.
	//
	//    * OperationNotPermitted: The service role associated with the cluster
	//    doesn't have the required access permissions for Amazon EKS.
	//
	//    * VpcIdNotFound: We couldn't find the VPC associated with the cluster.
	ErrorCode ErrorCode `locationName:"errorCode" type:"string" enum:"true"`

	// A more complete description of the error.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// An optional field that contains the resource IDs associated with the error.
	ResourceIds []string `locationName:"resourceIds" type:"list"`
	// contains filtered or unexported fields
}

An object representing an error when an asynchronous operation fails.

func (ErrorDetail) MarshalFields added in v0.7.0

func (s ErrorDetail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorDetail) String added in v0.7.0

func (s ErrorDetail) String() string

String returns the string representation

type Identity added in v0.12.0

type Identity struct {

	// The OpenID Connect (https://openid.net/connect/) identity provider information
	// for the cluster.
	Oidc *OIDC `locationName:"oidc" type:"structure"`
	// contains filtered or unexported fields
}

An object representing an identity provider for authentication credentials.

func (Identity) MarshalFields added in v0.12.0

func (s Identity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Identity) String added in v0.12.0

func (s Identity) String() string

String returns the string representation

type ListClustersInput

type ListClustersInput struct {

	// The maximum number of cluster results returned by ListClusters in paginated
	// output. When you use this parameter, ListClusters returns only maxResults
	// results in a single page along with a nextToken response element. You can
	// see the remaining results of the initial request by sending another ListClusters
	// request with the returned nextToken value. This value can be between 1 and
	// 100. If you don't use this parameter, ListClusters returns up to 100 results
	// and a nextToken value if applicable.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The nextToken value returned from a previous paginated ListClusters request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value.
	//
	// This token should be treated as an opaque identifier that is used only to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClustersInput) MarshalFields

func (s ListClustersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListClustersInput) String

func (s ListClustersInput) String() string

String returns the string representation

func (*ListClustersInput) Validate

func (s *ListClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListClustersOutput

type ListClustersOutput struct {

	// A list of all of the clusters for your account in the specified Region.
	Clusters []string `locationName:"clusters" type:"list"`

	// The nextToken value to include in a future ListClusters request. When the
	// results of a ListClusters request exceed maxResults, you can use this value
	// to retrieve the next page of results. This value is null when there are no
	// more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClustersOutput) MarshalFields

func (s ListClustersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListClustersOutput) String

func (s ListClustersOutput) String() string

String returns the string representation

type ListClustersPaginator added in v0.12.0

type ListClustersPaginator struct {
	aws.Pager
}

ListClustersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListClustersPaginator added in v0.12.0

func NewListClustersPaginator(req ListClustersRequest) ListClustersPaginator

NewListClustersRequestPaginator returns a paginator for ListClusters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListClustersRequest(input)
p := eks.NewListClustersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListClustersPaginator) CurrentPage added in v0.12.0

func (p *ListClustersPaginator) CurrentPage() *ListClustersOutput

type ListClustersRequest

type ListClustersRequest struct {
	*aws.Request
	Input *ListClustersInput
	Copy  func(*ListClustersInput) ListClustersRequest
}

ListClustersRequest is the request type for the ListClusters API operation.

func (ListClustersRequest) Send

Send marshals and sends the ListClusters API request.

type ListClustersResponse added in v0.9.0

type ListClustersResponse struct {
	*ListClustersOutput
	// contains filtered or unexported fields
}

ListClustersResponse is the response type for the ListClusters API operation.

func (*ListClustersResponse) SDKResponseMetdata added in v0.9.0

func (r *ListClustersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListClusters request.

type ListTagsForResourceInput added in v0.12.0

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource for which to
	// list the tags. Currently, the supported resources are Amazon EKS clusters.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.12.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.12.0

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.12.0

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.12.0

type ListTagsForResourceOutput struct {

	// The tags for the resource.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields added in v0.12.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.12.0

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.12.0

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.12.0

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.12.0

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.12.0

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListUpdatesInput added in v0.7.0

type ListUpdatesInput struct {

	// The maximum number of update results returned by ListUpdates in paginated
	// output. When you use this parameter, ListUpdates returns only maxResults
	// results in a single page along with a nextToken response element. You can
	// see the remaining results of the initial request by sending another ListUpdates
	// request with the returned nextToken value. This value can be between 1 and
	// 100. If you don't use this parameter, ListUpdates returns up to 100 results
	// and a nextToken value if applicable.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The name of the Amazon EKS cluster to list updates for.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The nextToken value returned from a previous paginated ListUpdates request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListUpdatesInput) MarshalFields added in v0.7.0

func (s ListUpdatesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUpdatesInput) String added in v0.7.0

func (s ListUpdatesInput) String() string

String returns the string representation

func (*ListUpdatesInput) Validate added in v0.7.0

func (s *ListUpdatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListUpdatesOutput added in v0.7.0

type ListUpdatesOutput struct {

	// The nextToken value to include in a future ListUpdates request. When the
	// results of a ListUpdates request exceed maxResults, you can use this value
	// to retrieve the next page of results. This value is null when there are no
	// more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of all the updates for the specified cluster and Region.
	UpdateIds []string `locationName:"updateIds" type:"list"`
	// contains filtered or unexported fields
}

func (ListUpdatesOutput) MarshalFields added in v0.7.0

func (s ListUpdatesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUpdatesOutput) String added in v0.7.0

func (s ListUpdatesOutput) String() string

String returns the string representation

type ListUpdatesPaginator added in v0.12.0

type ListUpdatesPaginator struct {
	aws.Pager
}

ListUpdatesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListUpdatesPaginator added in v0.12.0

func NewListUpdatesPaginator(req ListUpdatesRequest) ListUpdatesPaginator

NewListUpdatesRequestPaginator returns a paginator for ListUpdates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListUpdatesRequest(input)
p := eks.NewListUpdatesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListUpdatesPaginator) CurrentPage added in v0.12.0

func (p *ListUpdatesPaginator) CurrentPage() *ListUpdatesOutput

type ListUpdatesRequest added in v0.7.0

type ListUpdatesRequest struct {
	*aws.Request
	Input *ListUpdatesInput
	Copy  func(*ListUpdatesInput) ListUpdatesRequest
}

ListUpdatesRequest is the request type for the ListUpdates API operation.

func (ListUpdatesRequest) Send added in v0.7.0

Send marshals and sends the ListUpdates API request.

type ListUpdatesResponse added in v0.9.0

type ListUpdatesResponse struct {
	*ListUpdatesOutput
	// contains filtered or unexported fields
}

ListUpdatesResponse is the response type for the ListUpdates API operation.

func (*ListUpdatesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListUpdatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListUpdates request.

type LogSetup added in v0.8.0

type LogSetup struct {

	// If a log type is enabled, that log type exports its control plane logs to
	// CloudWatch Logs. If a log type isn't enabled, that log type doesn't export
	// its control plane logs. Each individual log type can be enabled or disabled
	// independently.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// The available cluster control plane log types.
	Types []LogType `locationName:"types" type:"list"`
	// contains filtered or unexported fields
}

An object representing the enabled or disabled Kubernetes control plane logs for your cluster.

func (LogSetup) MarshalFields added in v0.8.0

func (s LogSetup) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LogSetup) String added in v0.8.0

func (s LogSetup) String() string

String returns the string representation

type LogType added in v0.8.0

type LogType string
const (
	LogTypeApi               LogType = "api"
	LogTypeAudit             LogType = "audit"
	LogTypeAuthenticator     LogType = "authenticator"
	LogTypeControllerManager LogType = "controllerManager"
	LogTypeScheduler         LogType = "scheduler"
)

Enum values for LogType

func (LogType) MarshalValue added in v0.8.0

func (enum LogType) MarshalValue() (string, error)

func (LogType) MarshalValueBuf added in v0.8.0

func (enum LogType) MarshalValueBuf(b []byte) ([]byte, error)

type Logging added in v0.8.0

type Logging struct {

	// The cluster control plane logging configuration for your cluster.
	ClusterLogging []LogSetup `locationName:"clusterLogging" type:"list"`
	// contains filtered or unexported fields
}

An object representing the logging configuration for resources in your cluster.

func (Logging) MarshalFields added in v0.8.0

func (s Logging) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Logging) String added in v0.8.0

func (s Logging) String() string

String returns the string representation

type OIDC added in v0.12.0

type OIDC struct {

	// The issuer URL for the OpenID Connect identity provider.
	Issuer *string `locationName:"issuer" type:"string"`
	// contains filtered or unexported fields
}

An object representing the OpenID Connect (https://openid.net/connect/) identity provider information for the cluster.

func (OIDC) MarshalFields added in v0.12.0

func (s OIDC) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (OIDC) String added in v0.12.0

func (s OIDC) String() string

String returns the string representation

type TagResourceInput added in v0.12.0

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to which to add tags. Currently,
	// the supported resources are Amazon EKS clusters.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The tags to add to the resource. A tag is an array of key-value pairs.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields added in v0.12.0

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.12.0

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.12.0

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.12.0

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

func (TagResourceOutput) MarshalFields added in v0.12.0

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.12.0

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.12.0

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.12.0

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.12.0

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.12.0

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput added in v0.12.0

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which to delete tags.
	// Currently, the supported resources are Amazon EKS clusters.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The keys of the tags to be removed.
	//
	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.12.0

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.12.0

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.12.0

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.12.0

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

func (UntagResourceOutput) MarshalFields added in v0.12.0

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.12.0

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.12.0

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.12.0

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.12.0

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.12.0

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type Update added in v0.7.0

type Update struct {

	// The Unix epoch timestamp in seconds for when the update was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Any errors associated with a Failed update.
	Errors []ErrorDetail `locationName:"errors" type:"list"`

	// A UUID that is used to track the update.
	Id *string `locationName:"id" type:"string"`

	// A key-value map that contains the parameters associated with the update.
	Params []UpdateParam `locationName:"params" type:"list"`

	// The current status of the update.
	Status UpdateStatus `locationName:"status" type:"string" enum:"true"`

	// The type of the update.
	Type UpdateType `locationName:"type" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

An object representing an asynchronous update.

func (Update) MarshalFields added in v0.7.0

func (s Update) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Update) String added in v0.7.0

func (s Update) String() string

String returns the string representation

type UpdateClusterConfigInput added in v0.8.0

type UpdateClusterConfigInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientRequestToken *string `locationName:"clientRequestToken" type:"string" idempotencyToken:"true"`

	// Enable or disable exporting the Kubernetes control plane logs for your cluster
	// to CloudWatch Logs. By default, cluster control plane logs aren't exported
	// to CloudWatch Logs. For more information, see Amazon EKS Cluster Control
	// Plane Logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)
	// in the Amazon EKS User Guide .
	//
	// CloudWatch Logs ingestion, archive storage, and data scanning rates apply
	// to exported control plane logs. For more information, see Amazon CloudWatch
	// Pricing (http://aws.amazon.com/cloudwatch/pricing/).
	Logging *Logging `locationName:"logging" type:"structure"`

	// The name of the Amazon EKS cluster to update.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// An object representing the VPC configuration to use for an Amazon EKS cluster.
	ResourcesVpcConfig *VpcConfigRequest `locationName:"resourcesVpcConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateClusterConfigInput) MarshalFields added in v0.8.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateClusterConfigInput) String added in v0.8.0

func (s UpdateClusterConfigInput) String() string

String returns the string representation

func (*UpdateClusterConfigInput) Validate added in v0.8.0

func (s *UpdateClusterConfigInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateClusterConfigOutput added in v0.8.0

type UpdateClusterConfigOutput struct {

	// An object representing an asynchronous update.
	Update *Update `locationName:"update" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateClusterConfigOutput) MarshalFields added in v0.8.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateClusterConfigOutput) String added in v0.8.0

func (s UpdateClusterConfigOutput) String() string

String returns the string representation

type UpdateClusterConfigRequest added in v0.8.0

type UpdateClusterConfigRequest struct {
	*aws.Request
	Input *UpdateClusterConfigInput
	Copy  func(*UpdateClusterConfigInput) UpdateClusterConfigRequest
}

UpdateClusterConfigRequest is the request type for the UpdateClusterConfig API operation.

func (UpdateClusterConfigRequest) Send added in v0.8.0

Send marshals and sends the UpdateClusterConfig API request.

type UpdateClusterConfigResponse added in v0.9.0

type UpdateClusterConfigResponse struct {
	*UpdateClusterConfigOutput
	// contains filtered or unexported fields
}

UpdateClusterConfigResponse is the response type for the UpdateClusterConfig API operation.

func (*UpdateClusterConfigResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateClusterConfigResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateClusterConfig request.

type UpdateClusterVersionInput added in v0.7.0

type UpdateClusterVersionInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientRequestToken *string `locationName:"clientRequestToken" type:"string" idempotencyToken:"true"`

	// The name of the Amazon EKS cluster to update.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The desired Kubernetes version following a successful update.
	//
	// Version is a required field
	Version *string `locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateClusterVersionInput) MarshalFields added in v0.7.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateClusterVersionInput) String added in v0.7.0

func (s UpdateClusterVersionInput) String() string

String returns the string representation

func (*UpdateClusterVersionInput) Validate added in v0.7.0

func (s *UpdateClusterVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateClusterVersionOutput added in v0.7.0

type UpdateClusterVersionOutput struct {

	// The full description of the specified update
	Update *Update `locationName:"update" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateClusterVersionOutput) MarshalFields added in v0.7.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateClusterVersionOutput) String added in v0.7.0

String returns the string representation

type UpdateClusterVersionRequest added in v0.7.0

type UpdateClusterVersionRequest struct {
	*aws.Request
	Input *UpdateClusterVersionInput
	Copy  func(*UpdateClusterVersionInput) UpdateClusterVersionRequest
}

UpdateClusterVersionRequest is the request type for the UpdateClusterVersion API operation.

func (UpdateClusterVersionRequest) Send added in v0.7.0

Send marshals and sends the UpdateClusterVersion API request.

type UpdateClusterVersionResponse added in v0.9.0

type UpdateClusterVersionResponse struct {
	*UpdateClusterVersionOutput
	// contains filtered or unexported fields
}

UpdateClusterVersionResponse is the response type for the UpdateClusterVersion API operation.

func (*UpdateClusterVersionResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateClusterVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateClusterVersion request.

type UpdateParam added in v0.7.0

type UpdateParam struct {

	// The keys associated with an update request.
	Type UpdateParamType `locationName:"type" type:"string" enum:"true"`

	// The value of the keys submitted as part of an update request.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

An object representing the details of an update request.

func (UpdateParam) MarshalFields added in v0.7.0

func (s UpdateParam) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateParam) String added in v0.7.0

func (s UpdateParam) String() string

String returns the string representation

type UpdateParamType added in v0.7.0

type UpdateParamType string
const (
	UpdateParamTypeVersion               UpdateParamType = "Version"
	UpdateParamTypePlatformVersion       UpdateParamType = "PlatformVersion"
	UpdateParamTypeEndpointPrivateAccess UpdateParamType = "EndpointPrivateAccess"
	UpdateParamTypeEndpointPublicAccess  UpdateParamType = "EndpointPublicAccess"
	UpdateParamTypeClusterLogging        UpdateParamType = "ClusterLogging"
)

Enum values for UpdateParamType

func (UpdateParamType) MarshalValue added in v0.7.0

func (enum UpdateParamType) MarshalValue() (string, error)

func (UpdateParamType) MarshalValueBuf added in v0.7.0

func (enum UpdateParamType) MarshalValueBuf(b []byte) ([]byte, error)

type UpdateStatus added in v0.7.0

type UpdateStatus string
const (
	UpdateStatusInProgress UpdateStatus = "InProgress"
	UpdateStatusFailed     UpdateStatus = "Failed"
	UpdateStatusCancelled  UpdateStatus = "Cancelled"
	UpdateStatusSuccessful UpdateStatus = "Successful"
)

Enum values for UpdateStatus

func (UpdateStatus) MarshalValue added in v0.7.0

func (enum UpdateStatus) MarshalValue() (string, error)

func (UpdateStatus) MarshalValueBuf added in v0.7.0

func (enum UpdateStatus) MarshalValueBuf(b []byte) ([]byte, error)

type UpdateType added in v0.7.0

type UpdateType string
const (
	UpdateTypeVersionUpdate        UpdateType = "VersionUpdate"
	UpdateTypeEndpointAccessUpdate UpdateType = "EndpointAccessUpdate"
	UpdateTypeLoggingUpdate        UpdateType = "LoggingUpdate"
)

Enum values for UpdateType

func (UpdateType) MarshalValue added in v0.7.0

func (enum UpdateType) MarshalValue() (string, error)

func (UpdateType) MarshalValueBuf added in v0.7.0

func (enum UpdateType) MarshalValueBuf(b []byte) ([]byte, error)

type VpcConfigRequest

type VpcConfigRequest struct {

	// Set this value to true to enable private access for your cluster's Kubernetes
	// API server endpoint. If you enable private access, Kubernetes API requests
	// from within your cluster's VPC use the private VPC endpoint. The default
	// value for this parameter is false, which disables private access for your
	// Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint
	// Access Control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html)
	// in the Amazon EKS User Guide .
	EndpointPrivateAccess *bool `locationName:"endpointPrivateAccess" type:"boolean"`

	// Set this value to false to disable public access for your cluster's Kubernetes
	// API server endpoint. If you disable public access, your cluster's Kubernetes
	// API server can receive only requests from within the cluster VPC. The default
	// value for this parameter is true, which enables public access for your Kubernetes
	// API server. For more information, see Amazon EKS Cluster Endpoint Access
	// Control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html)
	// in the Amazon EKS User Guide .
	EndpointPublicAccess *bool `locationName:"endpointPublicAccess" type:"boolean"`

	// Specify one or more security groups for the cross-account elastic network
	// interfaces that Amazon EKS creates to use to allow communication between
	// your worker nodes and the Kubernetes control plane. If you don't specify
	// a security group, the default security group for your VPC is used.
	SecurityGroupIds []string `locationName:"securityGroupIds" type:"list"`

	// Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account
	// elastic network interfaces in these subnets to allow communication between
	// your worker nodes and the Kubernetes control plane.
	SubnetIds []string `locationName:"subnetIds" type:"list"`
	// contains filtered or unexported fields
}

An object representing the VPC configuration to use for an Amazon EKS cluster.

func (VpcConfigRequest) MarshalFields

func (s VpcConfigRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VpcConfigRequest) String

func (s VpcConfigRequest) String() string

String returns the string representation

type VpcConfigResponse

type VpcConfigResponse struct {

	// This parameter indicates whether the Amazon EKS private API server endpoint
	// is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes
	// API requests that originate from within your cluster's VPC use the private
	// VPC endpoint instead of traversing the internet.
	EndpointPrivateAccess *bool `locationName:"endpointPrivateAccess" type:"boolean"`

	// This parameter indicates whether the Amazon EKS public API server endpoint
	// is enabled. If the Amazon EKS public API server endpoint is disabled, your
	// cluster's Kubernetes API server can receive only requests that originate
	// from within the cluster VPC.
	EndpointPublicAccess *bool `locationName:"endpointPublicAccess" type:"boolean"`

	// The security groups associated with the cross-account elastic network interfaces
	// that are used to allow communication between your worker nodes and the Kubernetes
	// control plane.
	SecurityGroupIds []string `locationName:"securityGroupIds" type:"list"`

	// The subnets associated with your cluster.
	SubnetIds []string `locationName:"subnetIds" type:"list"`

	// The VPC associated with your cluster.
	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

An object representing an Amazon EKS cluster VPC configuration response.

func (VpcConfigResponse) MarshalFields

func (s VpcConfigResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VpcConfigResponse) String

func (s VpcConfigResponse) String() string

String returns the string representation

Directories

Path Synopsis
Package eksiface provides an interface to enable mocking the Amazon Elastic Kubernetes Service service client for testing your code.
Package eksiface provides an interface to enable mocking the Amazon Elastic Kubernetes Service service client for testing your code.

Jump to

Keyboard shortcuts

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