Documentation
¶
Overview ¶
Package eks provides the client and types for making API requests to Amazon Elastic Container Service for Kubernetes.
Amazon Elastic Container Service for Kubernetes (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 Amazon Elastic Container Service for Kubernetes 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 Elastic Container Service for Kubernetes client EKS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/eks/#New
Index ¶
- Constants
- type Certificate
- type Cluster
- type ClusterStatus
- type CreateClusterInput
- type CreateClusterOutput
- type CreateClusterRequest
- type DeleteClusterInput
- type DeleteClusterOutput
- type DeleteClusterRequest
- type DescribeClusterInput
- type DescribeClusterOutput
- type DescribeClusterRequest
- type DescribeUpdateInput
- type DescribeUpdateOutput
- type DescribeUpdateRequest
- type EKS
- func (c *EKS) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest
- func (c *EKS) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest
- func (c *EKS) DescribeClusterRequest(input *DescribeClusterInput) DescribeClusterRequest
- func (c *EKS) DescribeUpdateRequest(input *DescribeUpdateInput) DescribeUpdateRequest
- func (c *EKS) ListClustersRequest(input *ListClustersInput) ListClustersRequest
- func (c *EKS) ListUpdatesRequest(input *ListUpdatesInput) ListUpdatesRequest
- func (c *EKS) UpdateClusterVersionRequest(input *UpdateClusterVersionInput) UpdateClusterVersionRequest
- func (c *EKS) WaitUntilClusterActive(input *DescribeClusterInput) error
- func (c *EKS) WaitUntilClusterActiveWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...aws.WaiterOption) error
- func (c *EKS) WaitUntilClusterDeleted(input *DescribeClusterInput) error
- func (c *EKS) WaitUntilClusterDeletedWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...aws.WaiterOption) error
- type ErrorCode
- type ErrorDetail
- type ListClustersInput
- type ListClustersOutput
- type ListClustersRequest
- type ListUpdatesInput
- type ListUpdatesOutput
- type ListUpdatesRequest
- type Update
- type UpdateClusterVersionInput
- type UpdateClusterVersionOutput
- type UpdateClusterVersionRequest
- type UpdateParam
- type UpdateParamType
- type UpdateStatus
- type UpdateType
- type VpcConfigRequest
- type VpcConfigResponse
Examples ¶
Constants ¶
const ( // ErrCodeClientException for service response error code // "ClientException". // // 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. ErrCodeClientException = "ClientException" // 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" // 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" // "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" )
const ( ServiceName = "eks" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/Certificate
func (Certificate) GoString ¶
func (s Certificate) GoString() string
GoString returns the string representation
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 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" timestampFormat:"unix"` // The endpoint for your Kubernetes API server. Endpoint *string `locationName:"endpoint" type:"string"` // 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 (http://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) // in the Amazon EKS User Guide. PlatformVersion *string `locationName:"platformVersion" type:"string"` // The VPC subnets and security groups 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 (http://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) // and Cluster Security Group Considerations (http://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 Kubernetes server version for the cluster. Version *string `locationName:"version" type:"string"` // contains filtered or unexported fields }
An object representing an Amazon EKS cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/Cluster
func (Cluster) MarshalFields ¶
func (s Cluster) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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"` // 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 subnets and security groups 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 (http://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) // and Cluster Security Group Considerations (http://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 // may 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 (http://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 desired Kubernetes version for your cluster. If you do not specify a // value here, the latest version available in Amazon EKS is used. Version *string `locationName:"version" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateClusterRequest
func (CreateClusterInput) GoString ¶
func (s CreateClusterInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateClusterResponse
func (CreateClusterOutput) GoString ¶
func (s CreateClusterOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s CreateClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the CreateCluster API operation.
func (CreateClusterRequest) Send ¶
func (r CreateClusterRequest) Send() (*CreateClusterOutput, error)
Send marshals and sends the CreateCluster API 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteClusterRequest
func (DeleteClusterInput) GoString ¶
func (s DeleteClusterInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteClusterResponse
func (DeleteClusterOutput) GoString ¶
func (s DeleteClusterOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s DeleteClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DeleteCluster API operation.
func (DeleteClusterRequest) Send ¶
func (r DeleteClusterRequest) Send() (*DeleteClusterOutput, error)
Send marshals and sends the DeleteCluster API 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeClusterRequest
func (DescribeClusterInput) GoString ¶
func (s DescribeClusterInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeClusterResponse
func (DescribeClusterOutput) GoString ¶
func (s DescribeClusterOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s DescribeClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DescribeCluster API operation.
func (DescribeClusterRequest) Send ¶
func (r DescribeClusterRequest) Send() (*DescribeClusterOutput, error)
Send marshals and sends the DescribeCluster API 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeUpdateRequest
func (DescribeUpdateInput) GoString ¶ added in v0.7.0
func (s DescribeUpdateInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeUpdateResponse
func (DescribeUpdateOutput) GoString ¶ added in v0.7.0
func (s DescribeUpdateOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶ added in v0.7.0
func (s DescribeUpdateOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DescribeUpdate API operation.
func (DescribeUpdateRequest) Send ¶ added in v0.7.0
func (r DescribeUpdateRequest) Send() (*DescribeUpdateOutput, error)
Send marshals and sends the DescribeUpdate API request.
type EKS ¶
EKS provides the API operation methods for making requests to Amazon Elastic Container Service for Kubernetes. See this package's package overview docs for details on the service.
EKS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the EKS client with a config.
Example:
// Create a EKS client from just a config. svc := eks.New(myConfig)
func (*EKS) CreateClusterRequest ¶
func (c *EKS) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest
CreateClusterRequest returns a request value for making API operation for Amazon Elastic Container Service for Kubernetes.
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, like 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.
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.
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).
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 (http://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) and Launching Amazon EKS Worker Nodes (http://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html)in the Amazon EKS User Guide.
// Example sending a request using the CreateClusterRequest method. req := client.CreateClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateCluster
func (*EKS) DeleteClusterRequest ¶
func (c *EKS) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest
DeleteClusterRequest returns a request value for making API operation for Amazon Elastic Container Service for Kubernetes.
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 (http://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html) in the Amazon EKS User Guide.
// Example sending a request using the DeleteClusterRequest method. req := client.DeleteClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteCluster
func (*EKS) DescribeClusterRequest ¶
func (c *EKS) DescribeClusterRequest(input *DescribeClusterInput) DescribeClusterRequest
DescribeClusterRequest returns a request value for making API operation for Amazon Elastic Container Service for Kubernetes.
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 (http://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html).
The API server endpoint and certificate authority data are not available until the cluster reaches the ACTIVE state.
// Example sending a request using the DescribeClusterRequest method. req := client.DescribeClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeCluster
func (*EKS) DescribeUpdateRequest ¶ added in v0.7.0
func (c *EKS) DescribeUpdateRequest(input *DescribeUpdateInput) DescribeUpdateRequest
DescribeUpdateRequest returns a request value for making API operation for Amazon Elastic Container Service for Kubernetes.
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 the DescribeUpdateRequest method. req := client.DescribeUpdateRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeUpdate
func (*EKS) ListClustersRequest ¶
func (c *EKS) ListClustersRequest(input *ListClustersInput) ListClustersRequest
ListClustersRequest returns a request value for making API operation for Amazon Elastic Container Service for Kubernetes.
Lists the Amazon EKS clusters in your AWS account in the specified Region.
// Example sending a request using the ListClustersRequest method. req := client.ListClustersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListClusters
func (*EKS) ListUpdatesRequest ¶ added in v0.7.0
func (c *EKS) ListUpdatesRequest(input *ListUpdatesInput) ListUpdatesRequest
ListUpdatesRequest returns a request value for making API operation for Amazon Elastic Container Service for Kubernetes.
Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
// Example sending a request using the ListUpdatesRequest method. req := client.ListUpdatesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListUpdates
func (*EKS) UpdateClusterVersionRequest ¶ added in v0.7.0
func (c *EKS) UpdateClusterVersionRequest(input *UpdateClusterVersionInput) UpdateClusterVersionRequest
UpdateClusterVersionRequest returns a request value for making API operation for Amazon Elastic Container Service for Kubernetes.
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 the UpdateClusterVersionRequest method. req := client.UpdateClusterVersionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateClusterVersion
func (*EKS) WaitUntilClusterActive ¶ added in v0.6.0
func (c *EKS) WaitUntilClusterActive(input *DescribeClusterInput) 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.
func (*EKS) WaitUntilClusterActiveWithContext ¶ added in v0.6.0
func (c *EKS) WaitUntilClusterActiveWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...aws.WaiterOption) error
WaitUntilClusterActiveWithContext is an extended version of WaitUntilClusterActive. With the support for passing in a context and options to configure the Waiter and the underlying request options.
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 (*EKS) WaitUntilClusterDeleted ¶ added in v0.6.0
func (c *EKS) WaitUntilClusterDeleted(input *DescribeClusterInput) 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.
func (*EKS) WaitUntilClusterDeletedWithContext ¶ added in v0.6.0
func (c *EKS) WaitUntilClusterDeletedWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...aws.WaiterOption) error
WaitUntilClusterDeletedWithContext is an extended version of WaitUntilClusterDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.
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 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
type ErrorDetail ¶ added in v0.7.0
type ErrorDetail struct { // A brief description of the error. // // * SubnetNotFound: One of the subnets associated with the cluster could // not be found. // // * SecurityGroupNotFound: One of the security groups associated with the // cluster could not be found. // // * EniLimitReached: You have reached the elastic network interface limit // for your account. // // * IpNotAvailable: A subnet associated with the cluster does not have any // free IP addresses. // // * AccessDenied: You do not have permissions to perform the specified operation. // // * OperationNotPermitted: The service role associated with the cluster // does not have the required access permissions for Amazon EKS. // // * VpcIdNotFound: The VPC associated with the cluster could not be found. 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ErrorDetail
func (ErrorDetail) GoString ¶ added in v0.7.0
func (s ErrorDetail) GoString() string
GoString returns the string representation
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 ListClustersInput ¶
type ListClustersInput struct { // The maximum number of cluster results returned by ListClusters in paginated // output. When this parameter is used, ListClusters only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another ListClusters // request with the returned nextToken value. This value can be between 1 and // 100. If this parameter is not used, then 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 only used 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListClustersRequest
func (ListClustersInput) GoString ¶
func (s ListClustersInput) GoString() string
GoString returns the string representation
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, this value can be used // 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListClustersResponse
func (ListClustersOutput) GoString ¶
func (s ListClustersOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s ListClustersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListClustersOutput) String ¶
func (s ListClustersOutput) String() string
String returns the string representation
type ListClustersRequest ¶
type ListClustersRequest struct { *aws.Request Input *ListClustersInput Copy func(*ListClustersInput) ListClustersRequest }
ListClustersRequest is a API request type for the ListClusters API operation.
func (ListClustersRequest) Send ¶
func (r ListClustersRequest) Send() (*ListClustersOutput, error)
Send marshals and sends the ListClusters API request.
type ListUpdatesInput ¶ added in v0.7.0
type ListUpdatesInput struct { // The maximum number of update results returned by ListUpdates in paginated // output. When this parameter is used, ListUpdates only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another ListUpdates // request with the returned nextToken value. This value can be between 1 and // 100. If this parameter is not used, then 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 for which to list updates. // // 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListUpdatesRequest
func (ListUpdatesInput) GoString ¶ added in v0.7.0
func (s ListUpdatesInput) GoString() string
GoString returns the string representation
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, this value can be used // 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListUpdatesResponse
func (ListUpdatesOutput) GoString ¶ added in v0.7.0
func (s ListUpdatesOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶ added in v0.7.0
func (s ListUpdatesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUpdatesOutput) String ¶ added in v0.7.0
func (s ListUpdatesOutput) String() string
String returns the string representation
type ListUpdatesRequest ¶ added in v0.7.0
type ListUpdatesRequest struct { *aws.Request Input *ListUpdatesInput Copy func(*ListUpdatesInput) ListUpdatesRequest }
ListUpdatesRequest is a API request type for the ListUpdates API operation.
func (ListUpdatesRequest) Send ¶ added in v0.7.0
func (r ListUpdatesRequest) Send() (*ListUpdatesOutput, error)
Send marshals and sends the ListUpdates API 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" timestampFormat:"unix"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/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.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateClusterVersionRequest
func (UpdateClusterVersionInput) GoString ¶ added in v0.7.0
func (s UpdateClusterVersionInput) GoString() string
GoString returns the string representation
func (UpdateClusterVersionInput) MarshalFields ¶ added in v0.7.0
func (s UpdateClusterVersionInput) MarshalFields(e protocol.FieldEncoder) error
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateClusterVersionResponse
func (UpdateClusterVersionOutput) GoString ¶ added in v0.7.0
func (s UpdateClusterVersionOutput) GoString() string
GoString returns the string representation
func (UpdateClusterVersionOutput) MarshalFields ¶ added in v0.7.0
func (s UpdateClusterVersionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateClusterVersionOutput) SDKResponseMetadata ¶ added in v0.7.0
func (s UpdateClusterVersionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateClusterVersionOutput) String ¶ added in v0.7.0
func (s UpdateClusterVersionOutput) String() string
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 a API request type for the UpdateClusterVersion API operation.
func (UpdateClusterVersionRequest) Send ¶ added in v0.7.0
func (r UpdateClusterVersionRequest) Send() (*UpdateClusterVersionOutput, error)
Send marshals and sends the UpdateClusterVersion API 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateParam
func (UpdateParam) GoString ¶ added in v0.7.0
func (s UpdateParam) GoString() string
GoString returns the string representation
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" )
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"
)
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 { // 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 do not 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 is a required field SubnetIds []string `locationName:"subnetIds" type:"list" required:"true"` // contains filtered or unexported fields }
An object representing an Amazon EKS cluster VPC configuration request. Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/VpcConfigRequest
func (VpcConfigRequest) GoString ¶
func (s VpcConfigRequest) GoString() string
GoString returns the string representation
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
func (*VpcConfigRequest) Validate ¶
func (s *VpcConfigRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type VpcConfigResponse ¶
type VpcConfigResponse struct { // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/VpcConfigResponse
func (VpcConfigResponse) GoString ¶
func (s VpcConfigResponse) GoString() string
GoString returns the string representation
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 Container Service for Kubernetes service client for testing your code.
|
Package eksiface provides an interface to enable mocking the Amazon Elastic Container Service for Kubernetes service client for testing your code. |