eks

package
v1.31.10 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2020 License: Apache-2.0 Imports: 10 Imported by: 309

Documentation

Overview

Package eks provides the client and types for making API requests to Amazon Elastic Kubernetes Service.

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 contact Amazon Elastic Kubernetes Service 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 Kubernetes Service client EKS 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 (
	// AMITypesAl2X8664 is a AMITypes enum value
	AMITypesAl2X8664 = "AL2_x86_64"

	// AMITypesAl2X8664Gpu is a AMITypes enum value
	AMITypesAl2X8664Gpu = "AL2_x86_64_GPU"
)
View Source
const (
	// ClusterStatusCreating is a ClusterStatus enum value
	ClusterStatusCreating = "CREATING"

	// ClusterStatusActive is a ClusterStatus enum value
	ClusterStatusActive = "ACTIVE"

	// ClusterStatusDeleting is a ClusterStatus enum value
	ClusterStatusDeleting = "DELETING"

	// ClusterStatusFailed is a ClusterStatus enum value
	ClusterStatusFailed = "FAILED"

	// ClusterStatusUpdating is a ClusterStatus enum value
	ClusterStatusUpdating = "UPDATING"
)
View Source
const (
	// ErrorCodeSubnetNotFound is a ErrorCode enum value
	ErrorCodeSubnetNotFound = "SubnetNotFound"

	// ErrorCodeSecurityGroupNotFound is a ErrorCode enum value
	ErrorCodeSecurityGroupNotFound = "SecurityGroupNotFound"

	// ErrorCodeEniLimitReached is a ErrorCode enum value
	ErrorCodeEniLimitReached = "EniLimitReached"

	// ErrorCodeIpNotAvailable is a ErrorCode enum value
	ErrorCodeIpNotAvailable = "IpNotAvailable"

	// ErrorCodeAccessDenied is a ErrorCode enum value
	ErrorCodeAccessDenied = "AccessDenied"

	// ErrorCodeOperationNotPermitted is a ErrorCode enum value
	ErrorCodeOperationNotPermitted = "OperationNotPermitted"

	// ErrorCodeVpcIdNotFound is a ErrorCode enum value
	ErrorCodeVpcIdNotFound = "VpcIdNotFound"

	// ErrorCodeUnknown is a ErrorCode enum value
	ErrorCodeUnknown = "Unknown"

	// ErrorCodeNodeCreationFailure is a ErrorCode enum value
	ErrorCodeNodeCreationFailure = "NodeCreationFailure"

	// ErrorCodePodEvictionFailure is a ErrorCode enum value
	ErrorCodePodEvictionFailure = "PodEvictionFailure"

	// ErrorCodeInsufficientFreeAddresses is a ErrorCode enum value
	ErrorCodeInsufficientFreeAddresses = "InsufficientFreeAddresses"
)
View Source
const (
	// FargateProfileStatusCreating is a FargateProfileStatus enum value
	FargateProfileStatusCreating = "CREATING"

	// FargateProfileStatusActive is a FargateProfileStatus enum value
	FargateProfileStatusActive = "ACTIVE"

	// FargateProfileStatusDeleting is a FargateProfileStatus enum value
	FargateProfileStatusDeleting = "DELETING"

	// FargateProfileStatusCreateFailed is a FargateProfileStatus enum value
	FargateProfileStatusCreateFailed = "CREATE_FAILED"

	// FargateProfileStatusDeleteFailed is a FargateProfileStatus enum value
	FargateProfileStatusDeleteFailed = "DELETE_FAILED"
)
View Source
const (
	// LogTypeApi is a LogType enum value
	LogTypeApi = "api"

	// LogTypeAudit is a LogType enum value
	LogTypeAudit = "audit"

	// LogTypeAuthenticator is a LogType enum value
	LogTypeAuthenticator = "authenticator"

	// LogTypeControllerManager is a LogType enum value
	LogTypeControllerManager = "controllerManager"

	// LogTypeScheduler is a LogType enum value
	LogTypeScheduler = "scheduler"
)
View Source
const (
	// NodegroupIssueCodeAutoScalingGroupNotFound is a NodegroupIssueCode enum value
	NodegroupIssueCodeAutoScalingGroupNotFound = "AutoScalingGroupNotFound"

	// NodegroupIssueCodeAutoScalingGroupInvalidConfiguration is a NodegroupIssueCode enum value
	NodegroupIssueCodeAutoScalingGroupInvalidConfiguration = "AutoScalingGroupInvalidConfiguration"

	// NodegroupIssueCodeEc2securityGroupNotFound is a NodegroupIssueCode enum value
	NodegroupIssueCodeEc2securityGroupNotFound = "Ec2SecurityGroupNotFound"

	// NodegroupIssueCodeEc2securityGroupDeletionFailure is a NodegroupIssueCode enum value
	NodegroupIssueCodeEc2securityGroupDeletionFailure = "Ec2SecurityGroupDeletionFailure"

	// NodegroupIssueCodeEc2launchTemplateNotFound is a NodegroupIssueCode enum value
	NodegroupIssueCodeEc2launchTemplateNotFound = "Ec2LaunchTemplateNotFound"

	// NodegroupIssueCodeEc2launchTemplateVersionMismatch is a NodegroupIssueCode enum value
	NodegroupIssueCodeEc2launchTemplateVersionMismatch = "Ec2LaunchTemplateVersionMismatch"

	// NodegroupIssueCodeEc2subnetNotFound is a NodegroupIssueCode enum value
	NodegroupIssueCodeEc2subnetNotFound = "Ec2SubnetNotFound"

	// NodegroupIssueCodeEc2subnetInvalidConfiguration is a NodegroupIssueCode enum value
	NodegroupIssueCodeEc2subnetInvalidConfiguration = "Ec2SubnetInvalidConfiguration"

	// NodegroupIssueCodeIamInstanceProfileNotFound is a NodegroupIssueCode enum value
	NodegroupIssueCodeIamInstanceProfileNotFound = "IamInstanceProfileNotFound"

	// NodegroupIssueCodeIamLimitExceeded is a NodegroupIssueCode enum value
	NodegroupIssueCodeIamLimitExceeded = "IamLimitExceeded"

	// NodegroupIssueCodeIamNodeRoleNotFound is a NodegroupIssueCode enum value
	NodegroupIssueCodeIamNodeRoleNotFound = "IamNodeRoleNotFound"

	// NodegroupIssueCodeNodeCreationFailure is a NodegroupIssueCode enum value
	NodegroupIssueCodeNodeCreationFailure = "NodeCreationFailure"

	// NodegroupIssueCodeAsgInstanceLaunchFailures is a NodegroupIssueCode enum value
	NodegroupIssueCodeAsgInstanceLaunchFailures = "AsgInstanceLaunchFailures"

	// NodegroupIssueCodeInstanceLimitExceeded is a NodegroupIssueCode enum value
	NodegroupIssueCodeInstanceLimitExceeded = "InstanceLimitExceeded"

	// NodegroupIssueCodeInsufficientFreeAddresses is a NodegroupIssueCode enum value
	NodegroupIssueCodeInsufficientFreeAddresses = "InsufficientFreeAddresses"

	// NodegroupIssueCodeAccessDenied is a NodegroupIssueCode enum value
	NodegroupIssueCodeAccessDenied = "AccessDenied"

	// NodegroupIssueCodeInternalFailure is a NodegroupIssueCode enum value
	NodegroupIssueCodeInternalFailure = "InternalFailure"
)
View Source
const (
	// NodegroupStatusCreating is a NodegroupStatus enum value
	NodegroupStatusCreating = "CREATING"

	// NodegroupStatusActive is a NodegroupStatus enum value
	NodegroupStatusActive = "ACTIVE"

	// NodegroupStatusUpdating is a NodegroupStatus enum value
	NodegroupStatusUpdating = "UPDATING"

	// NodegroupStatusDeleting is a NodegroupStatus enum value
	NodegroupStatusDeleting = "DELETING"

	// NodegroupStatusCreateFailed is a NodegroupStatus enum value
	NodegroupStatusCreateFailed = "CREATE_FAILED"

	// NodegroupStatusDeleteFailed is a NodegroupStatus enum value
	NodegroupStatusDeleteFailed = "DELETE_FAILED"

	// NodegroupStatusDegraded is a NodegroupStatus enum value
	NodegroupStatusDegraded = "DEGRADED"
)
View Source
const (
	// UpdateParamTypeVersion is a UpdateParamType enum value
	UpdateParamTypeVersion = "Version"

	// UpdateParamTypePlatformVersion is a UpdateParamType enum value
	UpdateParamTypePlatformVersion = "PlatformVersion"

	// UpdateParamTypeEndpointPrivateAccess is a UpdateParamType enum value
	UpdateParamTypeEndpointPrivateAccess = "EndpointPrivateAccess"

	// UpdateParamTypeEndpointPublicAccess is a UpdateParamType enum value
	UpdateParamTypeEndpointPublicAccess = "EndpointPublicAccess"

	// UpdateParamTypeClusterLogging is a UpdateParamType enum value
	UpdateParamTypeClusterLogging = "ClusterLogging"

	// UpdateParamTypeDesiredSize is a UpdateParamType enum value
	UpdateParamTypeDesiredSize = "DesiredSize"

	// UpdateParamTypeLabelsToAdd is a UpdateParamType enum value
	UpdateParamTypeLabelsToAdd = "LabelsToAdd"

	// UpdateParamTypeLabelsToRemove is a UpdateParamType enum value
	UpdateParamTypeLabelsToRemove = "LabelsToRemove"

	// UpdateParamTypeMaxSize is a UpdateParamType enum value
	UpdateParamTypeMaxSize = "MaxSize"

	// UpdateParamTypeMinSize is a UpdateParamType enum value
	UpdateParamTypeMinSize = "MinSize"

	// UpdateParamTypeReleaseVersion is a UpdateParamType enum value
	UpdateParamTypeReleaseVersion = "ReleaseVersion"

	// UpdateParamTypePublicAccessCidrs is a UpdateParamType enum value
	UpdateParamTypePublicAccessCidrs = "PublicAccessCidrs"
)
View Source
const (
	// UpdateStatusInProgress is a UpdateStatus enum value
	UpdateStatusInProgress = "InProgress"

	// UpdateStatusFailed is a UpdateStatus enum value
	UpdateStatusFailed = "Failed"

	// UpdateStatusCancelled is a UpdateStatus enum value
	UpdateStatusCancelled = "Cancelled"

	// UpdateStatusSuccessful is a UpdateStatus enum value
	UpdateStatusSuccessful = "Successful"
)
View Source
const (
	// UpdateTypeVersionUpdate is a UpdateType enum value
	UpdateTypeVersionUpdate = "VersionUpdate"

	// UpdateTypeEndpointAccessUpdate is a UpdateType enum value
	UpdateTypeEndpointAccessUpdate = "EndpointAccessUpdate"

	// UpdateTypeLoggingUpdate is a UpdateType enum value
	UpdateTypeLoggingUpdate = "LoggingUpdate"

	// UpdateTypeConfigUpdate is a UpdateType enum value
	UpdateTypeConfigUpdate = "ConfigUpdate"
)
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"

	// 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"

	// 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. You can view your available managed node groups with ListNodegroups.
	// Amazon EKS clusters and node groups 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"
)
View Source
const (
	ServiceName = "eks"       // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "EKS"       // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AutoScalingGroup added in v1.25.36

type AutoScalingGroup struct {

	// The name of the Auto Scaling group associated with an Amazon EKS managed
	// node group.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

An Auto Scaling group that is associated with an Amazon EKS managed node group.

func (AutoScalingGroup) GoString added in v1.25.36

func (s AutoScalingGroup) GoString() string

GoString returns the string representation

func (*AutoScalingGroup) SetName added in v1.25.36

func (s *AutoScalingGroup) SetName(v string) *AutoScalingGroup

SetName sets the Name field's value.

func (AutoScalingGroup) String added in v1.25.36

func (s AutoScalingGroup) String() string

String returns the string representation

type BadRequestException added in v1.28.0

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*BadRequestException) Code added in v1.28.0

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0

func (s BadRequestException) GoString() string

GoString returns the string representation

func (*BadRequestException) Message added in v1.28.0

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String added in v1.28.0

func (s BadRequestException) String() string

String returns the string representation

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) GoString

func (s Certificate) GoString() string

GoString returns the string representation

func (*Certificate) SetData

func (s *Certificate) SetData(v string) *Certificate

SetData sets the Data field's value.

func (Certificate) String

func (s Certificate) String() string

String returns the string representation

type ClientException added in v1.28.0

type ClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*ClientException) Code added in v1.28.0

func (s *ClientException) Code() string

Code returns the exception type name.

func (*ClientException) Error added in v1.28.0

func (s *ClientException) Error() string

func (ClientException) GoString added in v1.28.0

func (s ClientException) GoString() string

GoString returns the string representation

func (*ClientException) Message added in v1.28.0

func (s *ClientException) Message() string

Message returns the exception's message.

func (*ClientException) OrigErr added in v1.28.0

func (s *ClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClientException) RequestID added in v1.28.0

func (s *ClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClientException) StatusCode added in v1.28.0

func (s *ClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClientException) String added in v1.28.0

func (s ClientException) 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"`

	// The encryption configuration for the cluster.
	EncryptionConfig []*EncryptionConfig `locationName:"encryptionConfig" type:"list"`

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

	// 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. Cluster tags do not propagate to any other resources
	// associated with the cluster.
	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) GoString

func (s Cluster) GoString() string

GoString returns the string representation

func (*Cluster) SetArn

func (s *Cluster) SetArn(v string) *Cluster

SetArn sets the Arn field's value.

func (*Cluster) SetCertificateAuthority

func (s *Cluster) SetCertificateAuthority(v *Certificate) *Cluster

SetCertificateAuthority sets the CertificateAuthority field's value.

func (*Cluster) SetClientRequestToken

func (s *Cluster) SetClientRequestToken(v string) *Cluster

SetClientRequestToken sets the ClientRequestToken field's value.

func (*Cluster) SetCreatedAt

func (s *Cluster) SetCreatedAt(v time.Time) *Cluster

SetCreatedAt sets the CreatedAt field's value.

func (*Cluster) SetEncryptionConfig added in v1.29.18

func (s *Cluster) SetEncryptionConfig(v []*EncryptionConfig) *Cluster

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*Cluster) SetEndpoint

func (s *Cluster) SetEndpoint(v string) *Cluster

SetEndpoint sets the Endpoint field's value.

func (*Cluster) SetIdentity added in v1.23.15

func (s *Cluster) SetIdentity(v *Identity) *Cluster

SetIdentity sets the Identity field's value.

func (*Cluster) SetLogging added in v1.19.10

func (s *Cluster) SetLogging(v *Logging) *Cluster

SetLogging sets the Logging field's value.

func (*Cluster) SetName

func (s *Cluster) SetName(v string) *Cluster

SetName sets the Name field's value.

func (*Cluster) SetPlatformVersion added in v1.15.26

func (s *Cluster) SetPlatformVersion(v string) *Cluster

SetPlatformVersion sets the PlatformVersion field's value.

func (*Cluster) SetResourcesVpcConfig

func (s *Cluster) SetResourcesVpcConfig(v *VpcConfigResponse) *Cluster

SetResourcesVpcConfig sets the ResourcesVpcConfig field's value.

func (*Cluster) SetRoleArn

func (s *Cluster) SetRoleArn(v string) *Cluster

SetRoleArn sets the RoleArn field's value.

func (*Cluster) SetStatus

func (s *Cluster) SetStatus(v string) *Cluster

SetStatus sets the Status field's value.

func (*Cluster) SetTags added in v1.23.22

func (s *Cluster) SetTags(v map[string]*string) *Cluster

SetTags sets the Tags field's value.

func (*Cluster) SetVersion

func (s *Cluster) SetVersion(v string) *Cluster

SetVersion sets the Version field's value.

func (Cluster) String

func (s Cluster) String() string

String returns the string representation

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 encryption configuration for the cluster.
	EncryptionConfig []*EncryptionConfig `locationName:"encryptionConfig" type:"list"`

	// 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) GoString

func (s CreateClusterInput) GoString() string

GoString returns the string representation

func (*CreateClusterInput) SetClientRequestToken

func (s *CreateClusterInput) SetClientRequestToken(v string) *CreateClusterInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateClusterInput) SetEncryptionConfig added in v1.29.18

func (s *CreateClusterInput) SetEncryptionConfig(v []*EncryptionConfig) *CreateClusterInput

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*CreateClusterInput) SetLogging added in v1.19.10

func (s *CreateClusterInput) SetLogging(v *Logging) *CreateClusterInput

SetLogging sets the Logging field's value.

func (*CreateClusterInput) SetName

SetName sets the Name field's value.

func (*CreateClusterInput) SetResourcesVpcConfig

func (s *CreateClusterInput) SetResourcesVpcConfig(v *VpcConfigRequest) *CreateClusterInput

SetResourcesVpcConfig sets the ResourcesVpcConfig field's value.

func (*CreateClusterInput) SetRoleArn

func (s *CreateClusterInput) SetRoleArn(v string) *CreateClusterInput

SetRoleArn sets the RoleArn field's value.

func (*CreateClusterInput) SetTags added in v1.23.22

func (s *CreateClusterInput) SetTags(v map[string]*string) *CreateClusterInput

SetTags sets the Tags field's value.

func (*CreateClusterInput) SetVersion

func (s *CreateClusterInput) SetVersion(v string) *CreateClusterInput

SetVersion sets the Version field's value.

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) GoString

func (s CreateClusterOutput) GoString() string

GoString returns the string representation

func (*CreateClusterOutput) SetCluster

func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput

SetCluster sets the Cluster field's value.

func (CreateClusterOutput) String

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateFargateProfileInput added in v1.25.46

type CreateFargateProfileInput 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 apply the Fargate profile to.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The name of the Fargate profile.
	//
	// FargateProfileName is a required field
	FargateProfileName *string `locationName:"fargateProfileName" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the pod execution role to use for pods
	// that match the selectors in the Fargate profile. The pod execution role allows
	// Fargate infrastructure to register with your cluster as a node, and it provides
	// read access to Amazon ECR image repositories. For more information, see Pod
	// Execution Role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html)
	// in the Amazon EKS User Guide.
	//
	// PodExecutionRoleArn is a required field
	PodExecutionRoleArn *string `locationName:"podExecutionRoleArn" type:"string" required:"true"`

	// The selectors to match for pods to use this Fargate profile. Each selector
	// must have an associated namespace. Optionally, you can also specify labels
	// for a namespace. You may specify up to five selectors in a Fargate profile.
	Selectors []*FargateProfileSelector `locationName:"selectors" type:"list"`

	// The IDs of subnets to launch your pods into. At this time, pods running on
	// Fargate are not assigned public IP addresses, so only private subnets (with
	// no direct route to an Internet Gateway) are accepted for this parameter.
	Subnets []*string `locationName:"subnets" type:"list"`

	// The metadata to apply to the Fargate profile to assist with categorization
	// and organization. Each tag consists of a key and an optional value, both
	// of which you define. Fargate profile tags do not propagate to any other resources
	// associated with the Fargate profile, such as the pods that are scheduled
	// with it.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateFargateProfileInput) GoString added in v1.25.46

func (s CreateFargateProfileInput) GoString() string

GoString returns the string representation

func (*CreateFargateProfileInput) SetClientRequestToken added in v1.25.46

func (s *CreateFargateProfileInput) SetClientRequestToken(v string) *CreateFargateProfileInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateFargateProfileInput) SetClusterName added in v1.25.46

SetClusterName sets the ClusterName field's value.

func (*CreateFargateProfileInput) SetFargateProfileName added in v1.25.46

func (s *CreateFargateProfileInput) SetFargateProfileName(v string) *CreateFargateProfileInput

SetFargateProfileName sets the FargateProfileName field's value.

func (*CreateFargateProfileInput) SetPodExecutionRoleArn added in v1.25.46

func (s *CreateFargateProfileInput) SetPodExecutionRoleArn(v string) *CreateFargateProfileInput

SetPodExecutionRoleArn sets the PodExecutionRoleArn field's value.

func (*CreateFargateProfileInput) SetSelectors added in v1.25.46

SetSelectors sets the Selectors field's value.

func (*CreateFargateProfileInput) SetSubnets added in v1.25.46

SetSubnets sets the Subnets field's value.

func (*CreateFargateProfileInput) SetTags added in v1.25.46

SetTags sets the Tags field's value.

func (CreateFargateProfileInput) String added in v1.25.46

func (s CreateFargateProfileInput) String() string

String returns the string representation

func (*CreateFargateProfileInput) Validate added in v1.25.46

func (s *CreateFargateProfileInput) Validate() error

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

type CreateFargateProfileOutput added in v1.25.46

type CreateFargateProfileOutput struct {

	// The full description of your new Fargate profile.
	FargateProfile *FargateProfile `locationName:"fargateProfile" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateFargateProfileOutput) GoString added in v1.25.46

func (s CreateFargateProfileOutput) GoString() string

GoString returns the string representation

func (*CreateFargateProfileOutput) SetFargateProfile added in v1.25.46

SetFargateProfile sets the FargateProfile field's value.

func (CreateFargateProfileOutput) String added in v1.25.46

String returns the string representation

type CreateNodegroupInput added in v1.25.36

type CreateNodegroupInput struct {

	// The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU
	// AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support.
	// Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon
	// EKS-optimized Linux AMI.
	AmiType *string `locationName:"amiType" type:"string" enum:"AMITypes"`

	// 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 cluster to create the node group in.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The root device disk size (in GiB) for your node group instances. The default
	// disk size is 20 GiB.
	DiskSize *int64 `locationName:"diskSize" type:"integer"`

	// The instance type to use for your node group. Currently, you can specify
	// a single instance type for a node group. The default value for this parameter
	// is t3.medium. If you choose a GPU instance type, be sure to specify the AL2_x86_64_GPU
	// with the amiType parameter.
	InstanceTypes []*string `locationName:"instanceTypes" type:"list"`

	// The Kubernetes labels to be applied to the nodes in the node group when they
	// are created.
	Labels map[string]*string `locationName:"labels" type:"map"`

	// The Amazon Resource Name (ARN) of the IAM role to associate with your node
	// group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs
	// on your behalf. Worker nodes receive permissions for these API calls through
	// an IAM instance profile and associated policies. Before you can launch worker
	// nodes and register them into a cluster, you must create an IAM role for those
	// worker nodes to use when they are launched. For more information, see Amazon
	// EKS Worker Node IAM Role (https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html)
	// in the Amazon EKS User Guide .
	//
	// NodeRole is a required field
	NodeRole *string `locationName:"nodeRole" type:"string" required:"true"`

	// The unique name to give your node group.
	//
	// NodegroupName is a required field
	NodegroupName *string `locationName:"nodegroupName" type:"string" required:"true"`

	// The AMI version of the Amazon EKS-optimized AMI to use with your node group.
	// By default, the latest available AMI version for the node group's current
	// Kubernetes version is used. For more information, see Amazon EKS-Optimized
	// Linux AMI Versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html)
	// in the Amazon EKS User Guide.
	ReleaseVersion *string `locationName:"releaseVersion" type:"string"`

	// The remote access (SSH) configuration to use with your node group.
	RemoteAccess *RemoteAccessConfig `locationName:"remoteAccess" type:"structure"`

	// The scaling configuration details for the Auto Scaling group that is created
	// for your node group.
	ScalingConfig *NodegroupScalingConfig `locationName:"scalingConfig" type:"structure"`

	// The subnets to use for the Auto Scaling group that is created for your node
	// group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME
	// with a value of shared, where CLUSTER_NAME is replaced with the name of your
	// cluster.
	//
	// Subnets is a required field
	Subnets []*string `locationName:"subnets" type:"list" required:"true"`

	// The metadata to apply to the node group to assist with categorization and
	// organization. Each tag consists of a key and an optional value, both of which
	// you define. Node group tags do not propagate to any other resources associated
	// with the node group, such as the Amazon EC2 instances or subnets.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The Kubernetes version to use for your managed nodes. By default, the Kubernetes
	// version of the cluster is used, and this is the only accepted specified value.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (CreateNodegroupInput) GoString added in v1.25.36

func (s CreateNodegroupInput) GoString() string

GoString returns the string representation

func (*CreateNodegroupInput) SetAmiType added in v1.25.36

SetAmiType sets the AmiType field's value.

func (*CreateNodegroupInput) SetClientRequestToken added in v1.25.36

func (s *CreateNodegroupInput) SetClientRequestToken(v string) *CreateNodegroupInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateNodegroupInput) SetClusterName added in v1.25.36

func (s *CreateNodegroupInput) SetClusterName(v string) *CreateNodegroupInput

SetClusterName sets the ClusterName field's value.

func (*CreateNodegroupInput) SetDiskSize added in v1.25.36

func (s *CreateNodegroupInput) SetDiskSize(v int64) *CreateNodegroupInput

SetDiskSize sets the DiskSize field's value.

func (*CreateNodegroupInput) SetInstanceTypes added in v1.25.36

func (s *CreateNodegroupInput) SetInstanceTypes(v []*string) *CreateNodegroupInput

SetInstanceTypes sets the InstanceTypes field's value.

func (*CreateNodegroupInput) SetLabels added in v1.25.36

SetLabels sets the Labels field's value.

func (*CreateNodegroupInput) SetNodeRole added in v1.25.36

SetNodeRole sets the NodeRole field's value.

func (*CreateNodegroupInput) SetNodegroupName added in v1.25.36

func (s *CreateNodegroupInput) SetNodegroupName(v string) *CreateNodegroupInput

SetNodegroupName sets the NodegroupName field's value.

func (*CreateNodegroupInput) SetReleaseVersion added in v1.25.36

func (s *CreateNodegroupInput) SetReleaseVersion(v string) *CreateNodegroupInput

SetReleaseVersion sets the ReleaseVersion field's value.

func (*CreateNodegroupInput) SetRemoteAccess added in v1.25.36

SetRemoteAccess sets the RemoteAccess field's value.

func (*CreateNodegroupInput) SetScalingConfig added in v1.25.36

SetScalingConfig sets the ScalingConfig field's value.

func (*CreateNodegroupInput) SetSubnets added in v1.25.36

func (s *CreateNodegroupInput) SetSubnets(v []*string) *CreateNodegroupInput

SetSubnets sets the Subnets field's value.

func (*CreateNodegroupInput) SetTags added in v1.25.36

SetTags sets the Tags field's value.

func (*CreateNodegroupInput) SetVersion added in v1.25.36

SetVersion sets the Version field's value.

func (CreateNodegroupInput) String added in v1.25.36

func (s CreateNodegroupInput) String() string

String returns the string representation

func (*CreateNodegroupInput) Validate added in v1.25.36

func (s *CreateNodegroupInput) Validate() error

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

type CreateNodegroupOutput added in v1.25.36

type CreateNodegroupOutput struct {

	// The full description of your new node group.
	Nodegroup *Nodegroup `locationName:"nodegroup" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateNodegroupOutput) GoString added in v1.25.36

func (s CreateNodegroupOutput) GoString() string

GoString returns the string representation

func (*CreateNodegroupOutput) SetNodegroup added in v1.25.36

SetNodegroup sets the Nodegroup field's value.

func (CreateNodegroupOutput) String added in v1.25.36

func (s CreateNodegroupOutput) String() string

String returns the string representation

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) GoString

func (s DeleteClusterInput) GoString() string

GoString returns the string representation

func (*DeleteClusterInput) SetName

SetName sets the Name field's value.

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) GoString

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation

func (*DeleteClusterOutput) SetCluster

func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput

SetCluster sets the Cluster field's value.

func (DeleteClusterOutput) String

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteFargateProfileInput added in v1.25.46

type DeleteFargateProfileInput struct {

	// The name of the Amazon EKS cluster associated with the Fargate profile to
	// delete.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

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

func (DeleteFargateProfileInput) GoString added in v1.25.46

func (s DeleteFargateProfileInput) GoString() string

GoString returns the string representation

func (*DeleteFargateProfileInput) SetClusterName added in v1.25.46

SetClusterName sets the ClusterName field's value.

func (*DeleteFargateProfileInput) SetFargateProfileName added in v1.25.46

func (s *DeleteFargateProfileInput) SetFargateProfileName(v string) *DeleteFargateProfileInput

SetFargateProfileName sets the FargateProfileName field's value.

func (DeleteFargateProfileInput) String added in v1.25.46

func (s DeleteFargateProfileInput) String() string

String returns the string representation

func (*DeleteFargateProfileInput) Validate added in v1.25.46

func (s *DeleteFargateProfileInput) Validate() error

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

type DeleteFargateProfileOutput added in v1.25.46

type DeleteFargateProfileOutput struct {

	// The deleted Fargate profile.
	FargateProfile *FargateProfile `locationName:"fargateProfile" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteFargateProfileOutput) GoString added in v1.25.46

func (s DeleteFargateProfileOutput) GoString() string

GoString returns the string representation

func (*DeleteFargateProfileOutput) SetFargateProfile added in v1.25.46

SetFargateProfile sets the FargateProfile field's value.

func (DeleteFargateProfileOutput) String added in v1.25.46

String returns the string representation

type DeleteNodegroupInput added in v1.25.36

type DeleteNodegroupInput struct {

	// The name of the Amazon EKS cluster that is associated with your node group.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

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

func (DeleteNodegroupInput) GoString added in v1.25.36

func (s DeleteNodegroupInput) GoString() string

GoString returns the string representation

func (*DeleteNodegroupInput) SetClusterName added in v1.25.36

func (s *DeleteNodegroupInput) SetClusterName(v string) *DeleteNodegroupInput

SetClusterName sets the ClusterName field's value.

func (*DeleteNodegroupInput) SetNodegroupName added in v1.25.36

func (s *DeleteNodegroupInput) SetNodegroupName(v string) *DeleteNodegroupInput

SetNodegroupName sets the NodegroupName field's value.

func (DeleteNodegroupInput) String added in v1.25.36

func (s DeleteNodegroupInput) String() string

String returns the string representation

func (*DeleteNodegroupInput) Validate added in v1.25.36

func (s *DeleteNodegroupInput) Validate() error

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

type DeleteNodegroupOutput added in v1.25.36

type DeleteNodegroupOutput struct {

	// The full description of your deleted node group.
	Nodegroup *Nodegroup `locationName:"nodegroup" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteNodegroupOutput) GoString added in v1.25.36

func (s DeleteNodegroupOutput) GoString() string

GoString returns the string representation

func (*DeleteNodegroupOutput) SetNodegroup added in v1.25.36

SetNodegroup sets the Nodegroup field's value.

func (DeleteNodegroupOutput) String added in v1.25.36

func (s DeleteNodegroupOutput) String() string

String returns the string representation

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) GoString

func (s DescribeClusterInput) GoString() string

GoString returns the string representation

func (*DescribeClusterInput) SetName

SetName sets the Name field's value.

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) GoString

func (s DescribeClusterOutput) GoString() string

GoString returns the string representation

func (*DescribeClusterOutput) SetCluster

SetCluster sets the Cluster field's value.

func (DescribeClusterOutput) String

func (s DescribeClusterOutput) String() string

String returns the string representation

type DescribeFargateProfileInput added in v1.25.46

type DescribeFargateProfileInput struct {

	// The name of the Amazon EKS cluster associated with the Fargate profile.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

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

func (DescribeFargateProfileInput) GoString added in v1.25.46

func (s DescribeFargateProfileInput) GoString() string

GoString returns the string representation

func (*DescribeFargateProfileInput) SetClusterName added in v1.25.46

SetClusterName sets the ClusterName field's value.

func (*DescribeFargateProfileInput) SetFargateProfileName added in v1.25.46

func (s *DescribeFargateProfileInput) SetFargateProfileName(v string) *DescribeFargateProfileInput

SetFargateProfileName sets the FargateProfileName field's value.

func (DescribeFargateProfileInput) String added in v1.25.46

String returns the string representation

func (*DescribeFargateProfileInput) Validate added in v1.25.46

func (s *DescribeFargateProfileInput) Validate() error

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

type DescribeFargateProfileOutput added in v1.25.46

type DescribeFargateProfileOutput struct {

	// The full description of your Fargate profile.
	FargateProfile *FargateProfile `locationName:"fargateProfile" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFargateProfileOutput) GoString added in v1.25.46

func (s DescribeFargateProfileOutput) GoString() string

GoString returns the string representation

func (*DescribeFargateProfileOutput) SetFargateProfile added in v1.25.46

SetFargateProfile sets the FargateProfile field's value.

func (DescribeFargateProfileOutput) String added in v1.25.46

String returns the string representation

type DescribeNodegroupInput added in v1.25.36

type DescribeNodegroupInput struct {

	// The name of the Amazon EKS cluster associated with the node group.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

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

func (DescribeNodegroupInput) GoString added in v1.25.36

func (s DescribeNodegroupInput) GoString() string

GoString returns the string representation

func (*DescribeNodegroupInput) SetClusterName added in v1.25.36

SetClusterName sets the ClusterName field's value.

func (*DescribeNodegroupInput) SetNodegroupName added in v1.25.36

func (s *DescribeNodegroupInput) SetNodegroupName(v string) *DescribeNodegroupInput

SetNodegroupName sets the NodegroupName field's value.

func (DescribeNodegroupInput) String added in v1.25.36

func (s DescribeNodegroupInput) String() string

String returns the string representation

func (*DescribeNodegroupInput) Validate added in v1.25.36

func (s *DescribeNodegroupInput) Validate() error

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

type DescribeNodegroupOutput added in v1.25.36

type DescribeNodegroupOutput struct {

	// The full description of your node group.
	Nodegroup *Nodegroup `locationName:"nodegroup" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeNodegroupOutput) GoString added in v1.25.36

func (s DescribeNodegroupOutput) GoString() string

GoString returns the string representation

func (*DescribeNodegroupOutput) SetNodegroup added in v1.25.36

SetNodegroup sets the Nodegroup field's value.

func (DescribeNodegroupOutput) String added in v1.25.36

func (s DescribeNodegroupOutput) String() string

String returns the string representation

type DescribeUpdateInput added in v1.16.4

type DescribeUpdateInput struct {

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

	// The name of the Amazon EKS node group associated with the update.
	NodegroupName *string `location:"querystring" locationName:"nodegroupName" type:"string"`

	// 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) GoString added in v1.16.4

func (s DescribeUpdateInput) GoString() string

GoString returns the string representation

func (*DescribeUpdateInput) SetName added in v1.16.4

SetName sets the Name field's value.

func (*DescribeUpdateInput) SetNodegroupName added in v1.25.36

func (s *DescribeUpdateInput) SetNodegroupName(v string) *DescribeUpdateInput

SetNodegroupName sets the NodegroupName field's value.

func (*DescribeUpdateInput) SetUpdateId added in v1.16.4

func (s *DescribeUpdateInput) SetUpdateId(v string) *DescribeUpdateInput

SetUpdateId sets the UpdateId field's value.

func (DescribeUpdateInput) String added in v1.16.4

func (s DescribeUpdateInput) String() string

String returns the string representation

func (*DescribeUpdateInput) Validate added in v1.16.4

func (s *DescribeUpdateInput) Validate() error

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

type DescribeUpdateOutput added in v1.16.4

type DescribeUpdateOutput struct {

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

func (DescribeUpdateOutput) GoString added in v1.16.4

func (s DescribeUpdateOutput) GoString() string

GoString returns the string representation

func (*DescribeUpdateOutput) SetUpdate added in v1.16.4

SetUpdate sets the Update field's value.

func (DescribeUpdateOutput) String added in v1.16.4

func (s DescribeUpdateOutput) String() string

String returns the string representation

type EKS

type EKS struct {
	*client.Client
}

EKS provides the API operation methods for making requests to Amazon Elastic Kubernetes Service. 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

func New(p client.ConfigProvider, cfgs ...*aws.Config) *EKS

New creates a new instance of the EKS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a EKS client from just a session.
svc := eks.New(mySession)

// Create a EKS client with additional configuration
svc := eks.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*EKS) CreateCluster

func (c *EKS) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)

CreateCluster 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation CreateCluster for usage and error information.

Returned Error Types:

  • ResourceInUseException The specified resource is in use.

  • ResourceLimitExceededException You have encountered a service limit on the specified resource.

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

  • 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.

See also, 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 (
	"fmt"

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

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

	result, err := svc.CreateCluster(input)
	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.ErrCodeClientException:
				fmt.Println(eks.ErrCodeClientException, 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 (*EKS) CreateClusterRequest

func (c *EKS) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)

CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCluster for more information on using the CreateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateClusterRequest method.
req, resp := client.CreateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) CreateClusterWithContext

func (c *EKS) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)

CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.

See CreateCluster for details on how to use this API operation.

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) CreateFargateProfile added in v1.25.46

func (c *EKS) CreateFargateProfile(input *CreateFargateProfileInput) (*CreateFargateProfileOutput, error)

CreateFargateProfile API operation for Amazon Elastic Kubernetes Service.

Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.

The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.

When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (https://kubernetes.io/docs/admin/authorization/rbac/) (RBAC) for authorization so that the kubelet that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the Amazon EKS User Guide.

Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.

If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.

For more information, see AWS Fargate Profile (https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) in the Amazon EKS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation CreateFargateProfile for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceLimitExceededException You have encountered a service limit on the specified resource.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateFargateProfile

func (*EKS) CreateFargateProfileRequest added in v1.25.46

func (c *EKS) CreateFargateProfileRequest(input *CreateFargateProfileInput) (req *request.Request, output *CreateFargateProfileOutput)

CreateFargateProfileRequest generates a "aws/request.Request" representing the client's request for the CreateFargateProfile operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFargateProfile for more information on using the CreateFargateProfile API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFargateProfileRequest method.
req, resp := client.CreateFargateProfileRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateFargateProfile

func (*EKS) CreateFargateProfileWithContext added in v1.25.46

func (c *EKS) CreateFargateProfileWithContext(ctx aws.Context, input *CreateFargateProfileInput, opts ...request.Option) (*CreateFargateProfileOutput, error)

CreateFargateProfileWithContext is the same as CreateFargateProfile with the addition of the ability to pass a context and additional request options.

See CreateFargateProfile for details on how to use this API operation.

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) CreateNodegroup added in v1.25.36

func (c *EKS) CreateNodegroup(input *CreateNodegroupInput) (*CreateNodegroupOutput, error)

CreateNodegroup API operation for Amazon Elastic Kubernetes Service.

Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster.

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS-optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in the Amazon EKS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation CreateNodegroup for usage and error information.

Returned Error Types:

  • ResourceInUseException The specified resource is in use.

  • ResourceLimitExceededException You have encountered a service limit on the specified resource.

  • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateNodegroup

func (*EKS) CreateNodegroupRequest added in v1.25.36

func (c *EKS) CreateNodegroupRequest(input *CreateNodegroupInput) (req *request.Request, output *CreateNodegroupOutput)

CreateNodegroupRequest generates a "aws/request.Request" representing the client's request for the CreateNodegroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateNodegroup for more information on using the CreateNodegroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateNodegroupRequest method.
req, resp := client.CreateNodegroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateNodegroup

func (*EKS) CreateNodegroupWithContext added in v1.25.36

func (c *EKS) CreateNodegroupWithContext(ctx aws.Context, input *CreateNodegroupInput, opts ...request.Option) (*CreateNodegroupOutput, error)

CreateNodegroupWithContext is the same as CreateNodegroup with the addition of the ability to pass a context and additional request options.

See CreateNodegroup for details on how to use this API operation.

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) DeleteCluster

func (c *EKS) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)

DeleteCluster 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.

If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation DeleteCluster for usage and error information.

Returned Error Types:

  • ResourceInUseException The specified resource is in use.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DeleteCluster(input)
	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.ErrCodeClientException:
				fmt.Println(eks.ErrCodeClientException, 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 (*EKS) DeleteClusterRequest

func (c *EKS) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)

DeleteClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCluster for more information on using the DeleteCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteClusterRequest method.
req, resp := client.DeleteClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) DeleteClusterWithContext

func (c *EKS) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)

DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.

See DeleteCluster for details on how to use this API operation.

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) DeleteFargateProfile added in v1.25.46

func (c *EKS) DeleteFargateProfile(input *DeleteFargateProfileInput) (*DeleteFargateProfileOutput, error)

DeleteFargateProfile API operation for Amazon Elastic Kubernetes Service.

Deletes an AWS Fargate profile.

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.

Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation DeleteFargateProfile for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteFargateProfile

func (*EKS) DeleteFargateProfileRequest added in v1.25.46

func (c *EKS) DeleteFargateProfileRequest(input *DeleteFargateProfileInput) (req *request.Request, output *DeleteFargateProfileOutput)

DeleteFargateProfileRequest generates a "aws/request.Request" representing the client's request for the DeleteFargateProfile operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFargateProfile for more information on using the DeleteFargateProfile API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFargateProfileRequest method.
req, resp := client.DeleteFargateProfileRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteFargateProfile

func (*EKS) DeleteFargateProfileWithContext added in v1.25.46

func (c *EKS) DeleteFargateProfileWithContext(ctx aws.Context, input *DeleteFargateProfileInput, opts ...request.Option) (*DeleteFargateProfileOutput, error)

DeleteFargateProfileWithContext is the same as DeleteFargateProfile with the addition of the ability to pass a context and additional request options.

See DeleteFargateProfile for details on how to use this API operation.

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) DeleteNodegroup added in v1.25.36

func (c *EKS) DeleteNodegroup(input *DeleteNodegroupInput) (*DeleteNodegroupOutput, error)

DeleteNodegroup API operation for Amazon Elastic Kubernetes Service.

Deletes an Amazon EKS node group for a cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation DeleteNodegroup for usage and error information.

Returned Error Types:

  • ResourceInUseException The specified resource is in use.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteNodegroup

func (*EKS) DeleteNodegroupRequest added in v1.25.36

func (c *EKS) DeleteNodegroupRequest(input *DeleteNodegroupInput) (req *request.Request, output *DeleteNodegroupOutput)

DeleteNodegroupRequest generates a "aws/request.Request" representing the client's request for the DeleteNodegroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNodegroup for more information on using the DeleteNodegroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteNodegroupRequest method.
req, resp := client.DeleteNodegroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DeleteNodegroup

func (*EKS) DeleteNodegroupWithContext added in v1.25.36

func (c *EKS) DeleteNodegroupWithContext(ctx aws.Context, input *DeleteNodegroupInput, opts ...request.Option) (*DeleteNodegroupOutput, error)

DeleteNodegroupWithContext is the same as DeleteNodegroup with the addition of the ability to pass a context and additional request options.

See DeleteNodegroup for details on how to use this API operation.

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) DescribeCluster

func (c *EKS) DescribeCluster(input *DescribeClusterInput) (*DescribeClusterOutput, error)

DescribeCluster 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation DescribeCluster for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeCluster(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case eks.ErrCodeResourceNotFoundException:
				fmt.Println(eks.ErrCodeResourceNotFoundException, aerr.Error())
			case eks.ErrCodeClientException:
				fmt.Println(eks.ErrCodeClientException, 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 (*EKS) DescribeClusterRequest

func (c *EKS) DescribeClusterRequest(input *DescribeClusterInput) (req *request.Request, output *DescribeClusterOutput)

DescribeClusterRequest generates a "aws/request.Request" representing the client's request for the DescribeCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCluster for more information on using the DescribeCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeClusterRequest method.
req, resp := client.DescribeClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) DescribeClusterWithContext

func (c *EKS) DescribeClusterWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.Option) (*DescribeClusterOutput, error)

DescribeClusterWithContext is the same as DescribeCluster with the addition of the ability to pass a context and additional request options.

See DescribeCluster for details on how to use this API operation.

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) DescribeFargateProfile added in v1.25.46

func (c *EKS) DescribeFargateProfile(input *DescribeFargateProfileInput) (*DescribeFargateProfileOutput, error)

DescribeFargateProfile API operation for Amazon Elastic Kubernetes Service.

Returns descriptive information about an AWS Fargate profile.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation DescribeFargateProfile for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeFargateProfile

func (*EKS) DescribeFargateProfileRequest added in v1.25.46

func (c *EKS) DescribeFargateProfileRequest(input *DescribeFargateProfileInput) (req *request.Request, output *DescribeFargateProfileOutput)

DescribeFargateProfileRequest generates a "aws/request.Request" representing the client's request for the DescribeFargateProfile operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFargateProfile for more information on using the DescribeFargateProfile API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFargateProfileRequest method.
req, resp := client.DescribeFargateProfileRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeFargateProfile

func (*EKS) DescribeFargateProfileWithContext added in v1.25.46

func (c *EKS) DescribeFargateProfileWithContext(ctx aws.Context, input *DescribeFargateProfileInput, opts ...request.Option) (*DescribeFargateProfileOutput, error)

DescribeFargateProfileWithContext is the same as DescribeFargateProfile with the addition of the ability to pass a context and additional request options.

See DescribeFargateProfile for details on how to use this API operation.

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) DescribeNodegroup added in v1.25.36

func (c *EKS) DescribeNodegroup(input *DescribeNodegroupInput) (*DescribeNodegroupOutput, error)

DescribeNodegroup API operation for Amazon Elastic Kubernetes Service.

Returns descriptive information about an Amazon EKS node group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation DescribeNodegroup for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeNodegroup

func (*EKS) DescribeNodegroupRequest added in v1.25.36

func (c *EKS) DescribeNodegroupRequest(input *DescribeNodegroupInput) (req *request.Request, output *DescribeNodegroupOutput)

DescribeNodegroupRequest generates a "aws/request.Request" representing the client's request for the DescribeNodegroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNodegroup for more information on using the DescribeNodegroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeNodegroupRequest method.
req, resp := client.DescribeNodegroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeNodegroup

func (*EKS) DescribeNodegroupWithContext added in v1.25.36

func (c *EKS) DescribeNodegroupWithContext(ctx aws.Context, input *DescribeNodegroupInput, opts ...request.Option) (*DescribeNodegroupOutput, error)

DescribeNodegroupWithContext is the same as DescribeNodegroup with the addition of the ability to pass a context and additional request options.

See DescribeNodegroup for details on how to use this API operation.

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) DescribeUpdate added in v1.16.4

func (c *EKS) DescribeUpdate(input *DescribeUpdateInput) (*DescribeUpdateOutput, error)

DescribeUpdate API operation for Amazon Elastic Kubernetes Service.

Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation DescribeUpdate for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

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

func (*EKS) DescribeUpdateRequest added in v1.16.4

func (c *EKS) DescribeUpdateRequest(input *DescribeUpdateInput) (req *request.Request, output *DescribeUpdateOutput)

DescribeUpdateRequest generates a "aws/request.Request" representing the client's request for the DescribeUpdate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUpdate for more information on using the DescribeUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeUpdateRequest method.
req, resp := client.DescribeUpdateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) DescribeUpdateWithContext added in v1.16.4

func (c *EKS) DescribeUpdateWithContext(ctx aws.Context, input *DescribeUpdateInput, opts ...request.Option) (*DescribeUpdateOutput, error)

DescribeUpdateWithContext is the same as DescribeUpdate with the addition of the ability to pass a context and additional request options.

See DescribeUpdate for details on how to use this API operation.

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) ListClusters

func (c *EKS) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)

ListClusters API operation for Amazon Elastic Kubernetes Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation ListClusters for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

See also, 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 (
	"fmt"

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

func main() {
	svc := eks.New(session.New())
	input := &eks.ListClustersInput{}

	result, err := svc.ListClusters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case eks.ErrCodeInvalidParameterException:
				fmt.Println(eks.ErrCodeInvalidParameterException, aerr.Error())
			case eks.ErrCodeClientException:
				fmt.Println(eks.ErrCodeClientException, 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 (*EKS) ListClustersPages added in v1.23.15

func (c *EKS) ListClustersPages(input *ListClustersInput, fn func(*ListClustersOutput, bool) bool) error

ListClustersPages iterates over the pages of a ListClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClusters method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListClusters operation.
pageNum := 0
err := client.ListClustersPages(params,
    func(page *eks.ListClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EKS) ListClustersPagesWithContext added in v1.23.15

func (c *EKS) ListClustersPagesWithContext(ctx aws.Context, input *ListClustersInput, fn func(*ListClustersOutput, bool) bool, opts ...request.Option) error

ListClustersPagesWithContext same as ListClustersPages except it takes a Context and allows setting request options on the pages.

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) ListClustersRequest

func (c *EKS) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)

ListClustersRequest generates a "aws/request.Request" representing the client's request for the ListClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClusters for more information on using the ListClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListClustersRequest method.
req, resp := client.ListClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) ListClustersWithContext

func (c *EKS) ListClustersWithContext(ctx aws.Context, input *ListClustersInput, opts ...request.Option) (*ListClustersOutput, error)

ListClustersWithContext is the same as ListClusters with the addition of the ability to pass a context and additional request options.

See ListClusters for details on how to use this API operation.

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) ListFargateProfiles added in v1.25.46

func (c *EKS) ListFargateProfiles(input *ListFargateProfilesInput) (*ListFargateProfilesOutput, error)

ListFargateProfiles API operation for Amazon Elastic Kubernetes Service.

Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation ListFargateProfiles for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListFargateProfiles

func (*EKS) ListFargateProfilesPages added in v1.25.46

func (c *EKS) ListFargateProfilesPages(input *ListFargateProfilesInput, fn func(*ListFargateProfilesOutput, bool) bool) error

ListFargateProfilesPages iterates over the pages of a ListFargateProfiles operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFargateProfiles method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListFargateProfiles operation.
pageNum := 0
err := client.ListFargateProfilesPages(params,
    func(page *eks.ListFargateProfilesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EKS) ListFargateProfilesPagesWithContext added in v1.25.46

func (c *EKS) ListFargateProfilesPagesWithContext(ctx aws.Context, input *ListFargateProfilesInput, fn func(*ListFargateProfilesOutput, bool) bool, opts ...request.Option) error

ListFargateProfilesPagesWithContext same as ListFargateProfilesPages except it takes a Context and allows setting request options on the pages.

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) ListFargateProfilesRequest added in v1.25.46

func (c *EKS) ListFargateProfilesRequest(input *ListFargateProfilesInput) (req *request.Request, output *ListFargateProfilesOutput)

ListFargateProfilesRequest generates a "aws/request.Request" representing the client's request for the ListFargateProfiles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFargateProfiles for more information on using the ListFargateProfiles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFargateProfilesRequest method.
req, resp := client.ListFargateProfilesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListFargateProfiles

func (*EKS) ListFargateProfilesWithContext added in v1.25.46

func (c *EKS) ListFargateProfilesWithContext(ctx aws.Context, input *ListFargateProfilesInput, opts ...request.Option) (*ListFargateProfilesOutput, error)

ListFargateProfilesWithContext is the same as ListFargateProfiles with the addition of the ability to pass a context and additional request options.

See ListFargateProfiles for details on how to use this API operation.

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) ListNodegroups added in v1.25.36

func (c *EKS) ListNodegroups(input *ListNodegroupsInput) (*ListNodegroupsOutput, error)

ListNodegroups API operation for Amazon Elastic Kubernetes Service.

Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation ListNodegroups for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ServiceUnavailableException The service is unavailable. Back off and retry the operation.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListNodegroups

func (*EKS) ListNodegroupsPages added in v1.25.36

func (c *EKS) ListNodegroupsPages(input *ListNodegroupsInput, fn func(*ListNodegroupsOutput, bool) bool) error

ListNodegroupsPages iterates over the pages of a ListNodegroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListNodegroups method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListNodegroups operation.
pageNum := 0
err := client.ListNodegroupsPages(params,
    func(page *eks.ListNodegroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EKS) ListNodegroupsPagesWithContext added in v1.25.36

func (c *EKS) ListNodegroupsPagesWithContext(ctx aws.Context, input *ListNodegroupsInput, fn func(*ListNodegroupsOutput, bool) bool, opts ...request.Option) error

ListNodegroupsPagesWithContext same as ListNodegroupsPages except it takes a Context and allows setting request options on the pages.

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) ListNodegroupsRequest added in v1.25.36

func (c *EKS) ListNodegroupsRequest(input *ListNodegroupsInput) (req *request.Request, output *ListNodegroupsOutput)

ListNodegroupsRequest generates a "aws/request.Request" representing the client's request for the ListNodegroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNodegroups for more information on using the ListNodegroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNodegroupsRequest method.
req, resp := client.ListNodegroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListNodegroups

func (*EKS) ListNodegroupsWithContext added in v1.25.36

func (c *EKS) ListNodegroupsWithContext(ctx aws.Context, input *ListNodegroupsInput, opts ...request.Option) (*ListNodegroupsOutput, error)

ListNodegroupsWithContext is the same as ListNodegroups with the addition of the ability to pass a context and additional request options.

See ListNodegroups for details on how to use this API operation.

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) ListTagsForResource added in v1.23.22

func (c *EKS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Elastic Kubernetes Service.

List the tags for an Amazon EKS resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • 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.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

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

Example (Shared00)

To list tags for a cluster

This example lists all of the tags for the `beta` cluster.

package main

import (
	"fmt"

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

func main() {
	svc := eks.New(session.New())
	input := &eks.ListTagsForResourceInput{
		ResourceArn: aws.String("arn:aws:eks:us-west-2:012345678910:cluster/beta"),
	}

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case eks.ErrCodeBadRequestException:
				fmt.Println(eks.ErrCodeBadRequestException, aerr.Error())
			case eks.ErrCodeNotFoundException:
				fmt.Println(eks.ErrCodeNotFoundException, 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 (*EKS) ListTagsForResourceRequest added in v1.23.22

func (c *EKS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) ListTagsForResourceWithContext added in v1.23.22

func (c *EKS) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

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) ListUpdates added in v1.16.4

func (c *EKS) ListUpdates(input *ListUpdatesInput) (*ListUpdatesOutput, error)

ListUpdates API operation for Amazon Elastic Kubernetes Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation ListUpdates for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

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

func (*EKS) ListUpdatesPages added in v1.23.15

func (c *EKS) ListUpdatesPages(input *ListUpdatesInput, fn func(*ListUpdatesOutput, bool) bool) error

ListUpdatesPages iterates over the pages of a ListUpdates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListUpdates method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListUpdates operation.
pageNum := 0
err := client.ListUpdatesPages(params,
    func(page *eks.ListUpdatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EKS) ListUpdatesPagesWithContext added in v1.23.15

func (c *EKS) ListUpdatesPagesWithContext(ctx aws.Context, input *ListUpdatesInput, fn func(*ListUpdatesOutput, bool) bool, opts ...request.Option) error

ListUpdatesPagesWithContext same as ListUpdatesPages except it takes a Context and allows setting request options on the pages.

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) ListUpdatesRequest added in v1.16.4

func (c *EKS) ListUpdatesRequest(input *ListUpdatesInput) (req *request.Request, output *ListUpdatesOutput)

ListUpdatesRequest generates a "aws/request.Request" representing the client's request for the ListUpdates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUpdates for more information on using the ListUpdates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListUpdatesRequest method.
req, resp := client.ListUpdatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) ListUpdatesWithContext added in v1.16.4

func (c *EKS) ListUpdatesWithContext(ctx aws.Context, input *ListUpdatesInput, opts ...request.Option) (*ListUpdatesOutput, error)

ListUpdatesWithContext is the same as ListUpdates with the addition of the ability to pass a context and additional request options.

See ListUpdates for details on how to use this API operation.

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) TagResource added in v1.23.22

func (c *EKS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource 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. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and worker nodes associated with the cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation TagResource for usage and error information.

Returned Error Types:

  • 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.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

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

func (*EKS) TagResourceRequest added in v1.23.22

func (c *EKS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) TagResourceWithContext added in v1.23.22

func (c *EKS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

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) UntagResource added in v1.23.22

func (c *EKS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Elastic Kubernetes Service.

Deletes specified tags from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation UntagResource for usage and error information.

Returned Error Types:

  • 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.

  • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.

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

func (*EKS) UntagResourceRequest added in v1.23.22

func (c *EKS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) UntagResourceWithContext added in v1.23.22

func (c *EKS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

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) UpdateClusterConfig added in v1.18.5

func (c *EKS) UpdateClusterConfig(input *UpdateClusterConfigInput) (*UpdateClusterConfigOutput, error)

UpdateClusterConfig 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation UpdateClusterConfig for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceInUseException The specified resource is in use.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

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

func (*EKS) UpdateClusterConfigRequest added in v1.18.5

func (c *EKS) UpdateClusterConfigRequest(input *UpdateClusterConfigInput) (req *request.Request, output *UpdateClusterConfigOutput)

UpdateClusterConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateClusterConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateClusterConfig for more information on using the UpdateClusterConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateClusterConfigRequest method.
req, resp := client.UpdateClusterConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) UpdateClusterConfigWithContext added in v1.18.5

func (c *EKS) UpdateClusterConfigWithContext(ctx aws.Context, input *UpdateClusterConfigInput, opts ...request.Option) (*UpdateClusterConfigOutput, error)

UpdateClusterConfigWithContext is the same as UpdateClusterConfig with the addition of the ability to pass a context and additional request options.

See UpdateClusterConfig for details on how to use this API operation.

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) UpdateClusterVersion added in v1.16.4

func (c *EKS) UpdateClusterVersion(input *UpdateClusterVersionInput) (*UpdateClusterVersionOutput, error)

UpdateClusterVersion 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.

If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation UpdateClusterVersion for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceInUseException The specified resource is in use.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

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

func (*EKS) UpdateClusterVersionRequest added in v1.16.4

func (c *EKS) UpdateClusterVersionRequest(input *UpdateClusterVersionInput) (req *request.Request, output *UpdateClusterVersionOutput)

UpdateClusterVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateClusterVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateClusterVersion for more information on using the UpdateClusterVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateClusterVersionRequest method.
req, resp := client.UpdateClusterVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*EKS) UpdateClusterVersionWithContext added in v1.16.4

func (c *EKS) UpdateClusterVersionWithContext(ctx aws.Context, input *UpdateClusterVersionInput, opts ...request.Option) (*UpdateClusterVersionOutput, error)

UpdateClusterVersionWithContext is the same as UpdateClusterVersion with the addition of the ability to pass a context and additional request options.

See UpdateClusterVersion for details on how to use this API operation.

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) UpdateNodegroupConfig added in v1.25.36

func (c *EKS) UpdateNodegroupConfig(input *UpdateNodegroupConfigInput) (*UpdateNodegroupConfigOutput, error)

UpdateNodegroupConfig API operation for Amazon Elastic Kubernetes Service.

Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation UpdateNodegroupConfig for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceInUseException The specified resource is in use.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateNodegroupConfig

func (*EKS) UpdateNodegroupConfigRequest added in v1.25.36

func (c *EKS) UpdateNodegroupConfigRequest(input *UpdateNodegroupConfigInput) (req *request.Request, output *UpdateNodegroupConfigOutput)

UpdateNodegroupConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateNodegroupConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNodegroupConfig for more information on using the UpdateNodegroupConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateNodegroupConfigRequest method.
req, resp := client.UpdateNodegroupConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateNodegroupConfig

func (*EKS) UpdateNodegroupConfigWithContext added in v1.25.36

func (c *EKS) UpdateNodegroupConfigWithContext(ctx aws.Context, input *UpdateNodegroupConfigInput, opts ...request.Option) (*UpdateNodegroupConfigOutput, error)

UpdateNodegroupConfigWithContext is the same as UpdateNodegroupConfig with the addition of the ability to pass a context and additional request options.

See UpdateNodegroupConfig for details on how to use this API operation.

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) UpdateNodegroupVersion added in v1.25.36

func (c *EKS) UpdateNodegroupVersion(input *UpdateNodegroupVersionInput) (*UpdateNodegroupVersionOutput, error)

UpdateNodegroupVersion API operation for Amazon Elastic Kubernetes Service.

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

You can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS-Optimized Linux AMI Versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the Amazon EKS User Guide.

You cannot roll back a node group to an earlier Kubernetes version or AMI version.

When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic Kubernetes Service's API operation UpdateNodegroupVersion for usage and error information.

Returned Error Types:

  • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.

  • 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.

  • ServerException These errors are usually caused by a server-side issue.

  • ResourceInUseException The specified resource is in use.

  • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateNodegroupVersion

func (*EKS) UpdateNodegroupVersionRequest added in v1.25.36

func (c *EKS) UpdateNodegroupVersionRequest(input *UpdateNodegroupVersionInput) (req *request.Request, output *UpdateNodegroupVersionOutput)

UpdateNodegroupVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateNodegroupVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNodegroupVersion for more information on using the UpdateNodegroupVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateNodegroupVersionRequest method.
req, resp := client.UpdateNodegroupVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/UpdateNodegroupVersion

func (*EKS) UpdateNodegroupVersionWithContext added in v1.25.36

func (c *EKS) UpdateNodegroupVersionWithContext(ctx aws.Context, input *UpdateNodegroupVersionInput, opts ...request.Option) (*UpdateNodegroupVersionOutput, error)

UpdateNodegroupVersionWithContext is the same as UpdateNodegroupVersion with the addition of the ability to pass a context and additional request options.

See UpdateNodegroupVersion for details on how to use this API operation.

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) WaitUntilClusterActive added in v1.15.69

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 v1.15.69

func (c *EKS) WaitUntilClusterActiveWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.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 v1.15.69

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 v1.15.69

func (c *EKS) WaitUntilClusterDeletedWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.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.

func (*EKS) WaitUntilNodegroupActive added in v1.25.36

func (c *EKS) WaitUntilNodegroupActive(input *DescribeNodegroupInput) error

WaitUntilNodegroupActive uses the Amazon EKS API operation DescribeNodegroup 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) WaitUntilNodegroupActiveWithContext added in v1.25.36

func (c *EKS) WaitUntilNodegroupActiveWithContext(ctx aws.Context, input *DescribeNodegroupInput, opts ...request.WaiterOption) error

WaitUntilNodegroupActiveWithContext is an extended version of WaitUntilNodegroupActive. 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) WaitUntilNodegroupDeleted added in v1.25.36

func (c *EKS) WaitUntilNodegroupDeleted(input *DescribeNodegroupInput) error

WaitUntilNodegroupDeleted uses the Amazon EKS API operation DescribeNodegroup 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) WaitUntilNodegroupDeletedWithContext added in v1.25.36

func (c *EKS) WaitUntilNodegroupDeletedWithContext(ctx aws.Context, input *DescribeNodegroupInput, opts ...request.WaiterOption) error

WaitUntilNodegroupDeletedWithContext is an extended version of WaitUntilNodegroupDeleted. 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 EncryptionConfig added in v1.29.18

type EncryptionConfig struct {

	// AWS Key Management Service (AWS KMS) customer master key (CMK). Either the
	// ARN or the alias can be used.
	Provider *Provider `locationName:"provider" type:"structure"`

	// Specifies the resources to be encrypted. The only supported value is "secrets".
	Resources []*string `locationName:"resources" type:"list"`
	// contains filtered or unexported fields
}

The encryption configuration for the cluster.

func (EncryptionConfig) GoString added in v1.29.18

func (s EncryptionConfig) GoString() string

GoString returns the string representation

func (*EncryptionConfig) SetProvider added in v1.29.18

func (s *EncryptionConfig) SetProvider(v *Provider) *EncryptionConfig

SetProvider sets the Provider field's value.

func (*EncryptionConfig) SetResources added in v1.29.18

func (s *EncryptionConfig) SetResources(v []*string) *EncryptionConfig

SetResources sets the Resources field's value.

func (EncryptionConfig) String added in v1.29.18

func (s EncryptionConfig) String() string

String returns the string representation

type ErrorDetail added in v1.16.4

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 *string `locationName:"errorCode" type:"string" enum:"ErrorCode"`

	// 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) GoString added in v1.16.4

func (s ErrorDetail) GoString() string

GoString returns the string representation

func (*ErrorDetail) SetErrorCode added in v1.16.4

func (s *ErrorDetail) SetErrorCode(v string) *ErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*ErrorDetail) SetErrorMessage added in v1.16.4

func (s *ErrorDetail) SetErrorMessage(v string) *ErrorDetail

SetErrorMessage sets the ErrorMessage field's value.

func (*ErrorDetail) SetResourceIds added in v1.16.4

func (s *ErrorDetail) SetResourceIds(v []*string) *ErrorDetail

SetResourceIds sets the ResourceIds field's value.

func (ErrorDetail) String added in v1.16.4

func (s ErrorDetail) String() string

String returns the string representation

type FargateProfile added in v1.25.46

type FargateProfile struct {

	// The name of the Amazon EKS cluster that the Fargate profile belongs to.
	ClusterName *string `locationName:"clusterName" type:"string"`

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

	// The full Amazon Resource Name (ARN) of the Fargate profile.
	FargateProfileArn *string `locationName:"fargateProfileArn" type:"string"`

	// The name of the Fargate profile.
	FargateProfileName *string `locationName:"fargateProfileName" type:"string"`

	// The Amazon Resource Name (ARN) of the pod execution role to use for pods
	// that match the selectors in the Fargate profile. For more information, see
	// Pod Execution Role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html)
	// in the Amazon EKS User Guide.
	PodExecutionRoleArn *string `locationName:"podExecutionRoleArn" type:"string"`

	// The selectors to match for pods to use this Fargate profile.
	Selectors []*FargateProfileSelector `locationName:"selectors" type:"list"`

	// The current status of the Fargate profile.
	Status *string `locationName:"status" type:"string" enum:"FargateProfileStatus"`

	// The IDs of subnets to launch pods into.
	Subnets []*string `locationName:"subnets" type:"list"`

	// The metadata applied to the Fargate profile to assist with categorization
	// and organization. Each tag consists of a key and an optional value, both
	// of which you define. Fargate profile tags do not propagate to any other resources
	// associated with the Fargate profile, such as the pods that are scheduled
	// with it.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

An object representing an AWS Fargate profile.

func (FargateProfile) GoString added in v1.25.46

func (s FargateProfile) GoString() string

GoString returns the string representation

func (*FargateProfile) SetClusterName added in v1.25.46

func (s *FargateProfile) SetClusterName(v string) *FargateProfile

SetClusterName sets the ClusterName field's value.

func (*FargateProfile) SetCreatedAt added in v1.25.46

func (s *FargateProfile) SetCreatedAt(v time.Time) *FargateProfile

SetCreatedAt sets the CreatedAt field's value.

func (*FargateProfile) SetFargateProfileArn added in v1.25.46

func (s *FargateProfile) SetFargateProfileArn(v string) *FargateProfile

SetFargateProfileArn sets the FargateProfileArn field's value.

func (*FargateProfile) SetFargateProfileName added in v1.25.46

func (s *FargateProfile) SetFargateProfileName(v string) *FargateProfile

SetFargateProfileName sets the FargateProfileName field's value.

func (*FargateProfile) SetPodExecutionRoleArn added in v1.25.46

func (s *FargateProfile) SetPodExecutionRoleArn(v string) *FargateProfile

SetPodExecutionRoleArn sets the PodExecutionRoleArn field's value.

func (*FargateProfile) SetSelectors added in v1.25.46

func (s *FargateProfile) SetSelectors(v []*FargateProfileSelector) *FargateProfile

SetSelectors sets the Selectors field's value.

func (*FargateProfile) SetStatus added in v1.25.46

func (s *FargateProfile) SetStatus(v string) *FargateProfile

SetStatus sets the Status field's value.

func (*FargateProfile) SetSubnets added in v1.25.46

func (s *FargateProfile) SetSubnets(v []*string) *FargateProfile

SetSubnets sets the Subnets field's value.

func (*FargateProfile) SetTags added in v1.25.46

func (s *FargateProfile) SetTags(v map[string]*string) *FargateProfile

SetTags sets the Tags field's value.

func (FargateProfile) String added in v1.25.46

func (s FargateProfile) String() string

String returns the string representation

type FargateProfileSelector added in v1.25.46

type FargateProfileSelector struct {

	// The Kubernetes labels that the selector should match. A pod must contain
	// all of the labels that are specified in the selector for it to be considered
	// a match.
	Labels map[string]*string `locationName:"labels" type:"map"`

	// The Kubernetes namespace that the selector should match.
	Namespace *string `locationName:"namespace" type:"string"`
	// contains filtered or unexported fields
}

An object representing an AWS Fargate profile selector.

func (FargateProfileSelector) GoString added in v1.25.46

func (s FargateProfileSelector) GoString() string

GoString returns the string representation

func (*FargateProfileSelector) SetLabels added in v1.25.46

SetLabels sets the Labels field's value.

func (*FargateProfileSelector) SetNamespace added in v1.25.46

SetNamespace sets the Namespace field's value.

func (FargateProfileSelector) String added in v1.25.46

func (s FargateProfileSelector) String() string

String returns the string representation

type Identity added in v1.23.15

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) GoString added in v1.23.15

func (s Identity) GoString() string

GoString returns the string representation

func (*Identity) SetOidc added in v1.23.15

func (s *Identity) SetOidc(v *OIDC) *Identity

SetOidc sets the Oidc field's value.

func (Identity) String added in v1.23.15

func (s Identity) String() string

String returns the string representation

type InvalidParameterException added in v1.28.0

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	// The Fargate profile associated with the exception.
	FargateProfileName *string `locationName:"fargateProfileName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

The specified parameter is invalid. Review the available parameters for the API request.

func (*InvalidParameterException) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0

func (s InvalidParameterException) GoString() string

GoString returns the string representation

func (*InvalidParameterException) Message added in v1.28.0

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0

func (s InvalidParameterException) String() string

String returns the string representation

type InvalidRequestException added in v1.28.0

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

func (*InvalidRequestException) Code added in v1.28.0

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (*InvalidRequestException) Message added in v1.28.0

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0

func (s InvalidRequestException) String() string

String returns the string representation

type Issue added in v1.25.36

type Issue struct {

	// A brief description of the error.
	//
	//    * AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated
	//    with the managed node group. You may be able to recreate an Auto Scaling
	//    group with the same settings to recover.
	//
	//    * Ec2SecurityGroupNotFound: We couldn't find the cluster security group
	//    for the cluster. You must recreate your cluster.
	//
	//    * Ec2SecurityGroupDeletionFailure: We could not delete the remote access
	//    security group for your managed node group. Remove any dependencies from
	//    the security group.
	//
	//    * Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template
	//    for your managed node group. You may be able to recreate a launch template
	//    with the same settings to recover.
	//
	//    * Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version
	//    for your managed node group does not match the version that Amazon EKS
	//    created. You may be able to revert to the version that Amazon EKS created
	//    to recover.
	//
	//    * IamInstanceProfileNotFound: We couldn't find the IAM instance profile
	//    for your managed node group. You may be able to recreate an instance profile
	//    with the same settings to recover.
	//
	//    * IamNodeRoleNotFound: We couldn't find the IAM role for your managed
	//    node group. You may be able to recreate an IAM role with the same settings
	//    to recover.
	//
	//    * AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures
	//    while attempting to launch instances.
	//
	//    * NodeCreationFailure: Your launched instances are unable to register
	//    with your Amazon EKS cluster. Common causes of this failure are insufficient
	//    worker node IAM role (https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html)
	//    permissions or lack of outbound internet access for the nodes.
	//
	//    * InstanceLimitExceeded: Your AWS account is unable to launch any more
	//    instances of the specified instance type. You may be able to request an
	//    Amazon EC2 instance limit increase to recover.
	//
	//    * InsufficientFreeAddresses: One or more of the subnets associated with
	//    your managed node group does not have enough available IP addresses for
	//    new nodes.
	//
	//    * AccessDenied: Amazon EKS or one or more of your managed nodes is unable
	//    to communicate with your cluster API server.
	//
	//    * InternalFailure: These errors are usually caused by an Amazon EKS server-side
	//    issue.
	Code *string `locationName:"code" type:"string" enum:"NodegroupIssueCode"`

	// The error message associated with the issue.
	Message *string `locationName:"message" type:"string"`

	// The AWS resources that are afflicted by this issue.
	ResourceIds []*string `locationName:"resourceIds" type:"list"`
	// contains filtered or unexported fields
}

An object representing an issue with an Amazon EKS resource.

func (Issue) GoString added in v1.25.36

func (s Issue) GoString() string

GoString returns the string representation

func (*Issue) SetCode added in v1.25.36

func (s *Issue) SetCode(v string) *Issue

SetCode sets the Code field's value.

func (*Issue) SetMessage added in v1.25.36

func (s *Issue) SetMessage(v string) *Issue

SetMessage sets the Message field's value.

func (*Issue) SetResourceIds added in v1.25.36

func (s *Issue) SetResourceIds(v []*string) *Issue

SetResourceIds sets the ResourceIds field's value.

func (Issue) String added in v1.25.36

func (s Issue) 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) GoString

func (s ListClustersInput) GoString() string

GoString returns the string representation

func (*ListClustersInput) SetMaxResults

func (s *ListClustersInput) SetMaxResults(v int64) *ListClustersInput

SetMaxResults sets the MaxResults field's value.

func (*ListClustersInput) SetNextToken

func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput

SetNextToken sets the NextToken field's value.

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) GoString

func (s ListClustersOutput) GoString() string

GoString returns the string representation

func (*ListClustersOutput) SetClusters

func (s *ListClustersOutput) SetClusters(v []*string) *ListClustersOutput

SetClusters sets the Clusters field's value.

func (*ListClustersOutput) SetNextToken

func (s *ListClustersOutput) SetNextToken(v string) *ListClustersOutput

SetNextToken sets the NextToken field's value.

func (ListClustersOutput) String

func (s ListClustersOutput) String() string

String returns the string representation

type ListFargateProfilesInput added in v1.25.46

type ListFargateProfilesInput struct {

	// The name of the Amazon EKS cluster that you would like to listFargate profiles
	// in.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The maximum number of Fargate profile results returned by ListFargateProfiles
	// in paginated output. When you use this parameter, ListFargateProfiles 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 ListFargateProfiles request with the returned nextToken value. This
	// value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles
	// 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 ListFargateProfiles
	// 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 (ListFargateProfilesInput) GoString added in v1.25.46

func (s ListFargateProfilesInput) GoString() string

GoString returns the string representation

func (*ListFargateProfilesInput) SetClusterName added in v1.25.46

SetClusterName sets the ClusterName field's value.

func (*ListFargateProfilesInput) SetMaxResults added in v1.25.46

SetMaxResults sets the MaxResults field's value.

func (*ListFargateProfilesInput) SetNextToken added in v1.25.46

SetNextToken sets the NextToken field's value.

func (ListFargateProfilesInput) String added in v1.25.46

func (s ListFargateProfilesInput) String() string

String returns the string representation

func (*ListFargateProfilesInput) Validate added in v1.25.46

func (s *ListFargateProfilesInput) Validate() error

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

type ListFargateProfilesOutput added in v1.25.46

type ListFargateProfilesOutput struct {

	// A list of all of the Fargate profiles associated with the specified cluster.
	FargateProfileNames []*string `locationName:"fargateProfileNames" type:"list"`

	// The nextToken value to include in a future ListFargateProfiles request. When
	// the results of a ListFargateProfiles 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 (ListFargateProfilesOutput) GoString added in v1.25.46

func (s ListFargateProfilesOutput) GoString() string

GoString returns the string representation

func (*ListFargateProfilesOutput) SetFargateProfileNames added in v1.25.46

func (s *ListFargateProfilesOutput) SetFargateProfileNames(v []*string) *ListFargateProfilesOutput

SetFargateProfileNames sets the FargateProfileNames field's value.

func (*ListFargateProfilesOutput) SetNextToken added in v1.25.46

SetNextToken sets the NextToken field's value.

func (ListFargateProfilesOutput) String added in v1.25.46

func (s ListFargateProfilesOutput) String() string

String returns the string representation

type ListNodegroupsInput added in v1.25.36

type ListNodegroupsInput struct {

	// The name of the Amazon EKS cluster that you would like to list node groups
	// in.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The maximum number of node group results returned by ListNodegroups in paginated
	// output. When you use this parameter, ListNodegroups 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 ListNodegroups
	// request with the returned nextToken value. This value can be between 1 and
	// 100. If you don't use this parameter, ListNodegroups 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 ListNodegroups 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 (ListNodegroupsInput) GoString added in v1.25.36

func (s ListNodegroupsInput) GoString() string

GoString returns the string representation

func (*ListNodegroupsInput) SetClusterName added in v1.25.36

func (s *ListNodegroupsInput) SetClusterName(v string) *ListNodegroupsInput

SetClusterName sets the ClusterName field's value.

func (*ListNodegroupsInput) SetMaxResults added in v1.25.36

func (s *ListNodegroupsInput) SetMaxResults(v int64) *ListNodegroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListNodegroupsInput) SetNextToken added in v1.25.36

func (s *ListNodegroupsInput) SetNextToken(v string) *ListNodegroupsInput

SetNextToken sets the NextToken field's value.

func (ListNodegroupsInput) String added in v1.25.36

func (s ListNodegroupsInput) String() string

String returns the string representation

func (*ListNodegroupsInput) Validate added in v1.25.36

func (s *ListNodegroupsInput) Validate() error

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

type ListNodegroupsOutput added in v1.25.36

type ListNodegroupsOutput struct {

	// The nextToken value to include in a future ListNodegroups request. When the
	// results of a ListNodegroups 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 of the node groups associated with the specified cluster.
	Nodegroups []*string `locationName:"nodegroups" type:"list"`
	// contains filtered or unexported fields
}

func (ListNodegroupsOutput) GoString added in v1.25.36

func (s ListNodegroupsOutput) GoString() string

GoString returns the string representation

func (*ListNodegroupsOutput) SetNextToken added in v1.25.36

func (s *ListNodegroupsOutput) SetNextToken(v string) *ListNodegroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListNodegroupsOutput) SetNodegroups added in v1.25.36

func (s *ListNodegroupsOutput) SetNodegroups(v []*string) *ListNodegroupsOutput

SetNodegroups sets the Nodegroups field's value.

func (ListNodegroupsOutput) String added in v1.25.36

func (s ListNodegroupsOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.23.22

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
	// and managed node groups.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.23.22

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn added in v1.23.22

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.23.22

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.23.22

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.23.22

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) GoString added in v1.23.22

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.23.22

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.23.22

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListUpdatesInput added in v1.16.4

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"`

	// The name of the Amazon EKS managed node group to list updates for.
	NodegroupName *string `location:"querystring" locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

func (ListUpdatesInput) GoString added in v1.16.4

func (s ListUpdatesInput) GoString() string

GoString returns the string representation

func (*ListUpdatesInput) SetMaxResults added in v1.16.4

func (s *ListUpdatesInput) SetMaxResults(v int64) *ListUpdatesInput

SetMaxResults sets the MaxResults field's value.

func (*ListUpdatesInput) SetName added in v1.16.4

func (s *ListUpdatesInput) SetName(v string) *ListUpdatesInput

SetName sets the Name field's value.

func (*ListUpdatesInput) SetNextToken added in v1.16.4

func (s *ListUpdatesInput) SetNextToken(v string) *ListUpdatesInput

SetNextToken sets the NextToken field's value.

func (*ListUpdatesInput) SetNodegroupName added in v1.25.36

func (s *ListUpdatesInput) SetNodegroupName(v string) *ListUpdatesInput

SetNodegroupName sets the NodegroupName field's value.

func (ListUpdatesInput) String added in v1.16.4

func (s ListUpdatesInput) String() string

String returns the string representation

func (*ListUpdatesInput) Validate added in v1.16.4

func (s *ListUpdatesInput) Validate() error

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

type ListUpdatesOutput added in v1.16.4

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) GoString added in v1.16.4

func (s ListUpdatesOutput) GoString() string

GoString returns the string representation

func (*ListUpdatesOutput) SetNextToken added in v1.16.4

func (s *ListUpdatesOutput) SetNextToken(v string) *ListUpdatesOutput

SetNextToken sets the NextToken field's value.

func (*ListUpdatesOutput) SetUpdateIds added in v1.16.4

func (s *ListUpdatesOutput) SetUpdateIds(v []*string) *ListUpdatesOutput

SetUpdateIds sets the UpdateIds field's value.

func (ListUpdatesOutput) String added in v1.16.4

func (s ListUpdatesOutput) String() string

String returns the string representation

type LogSetup added in v1.19.10

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 []*string `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) GoString added in v1.19.10

func (s LogSetup) GoString() string

GoString returns the string representation

func (*LogSetup) SetEnabled added in v1.19.10

func (s *LogSetup) SetEnabled(v bool) *LogSetup

SetEnabled sets the Enabled field's value.

func (*LogSetup) SetTypes added in v1.19.10

func (s *LogSetup) SetTypes(v []*string) *LogSetup

SetTypes sets the Types field's value.

func (LogSetup) String added in v1.19.10

func (s LogSetup) String() string

String returns the string representation

type Logging added in v1.19.10

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) GoString added in v1.19.10

func (s Logging) GoString() string

GoString returns the string representation

func (*Logging) SetClusterLogging added in v1.19.10

func (s *Logging) SetClusterLogging(v []*LogSetup) *Logging

SetClusterLogging sets the ClusterLogging field's value.

func (Logging) String added in v1.19.10

func (s Logging) String() string

String returns the string representation

type Nodegroup added in v1.25.36

type Nodegroup struct {

	// The AMI type associated with your node group. GPU instance types should use
	// the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI
	// with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which
	// uses the Amazon EKS-optimized Linux AMI.
	AmiType *string `locationName:"amiType" type:"string" enum:"AMITypes"`

	// The name of the cluster that the managed node group resides in.
	ClusterName *string `locationName:"clusterName" type:"string"`

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

	// The root device disk size (in GiB) for your node group instances. The default
	// disk size is 20 GiB.
	DiskSize *int64 `locationName:"diskSize" type:"integer"`

	// The health status of the node group. If there are issues with your node group's
	// health, they are listed here.
	Health *NodegroupHealth `locationName:"health" type:"structure"`

	// The instance types associated with your node group.
	InstanceTypes []*string `locationName:"instanceTypes" type:"list"`

	// The Kubernetes labels applied to the nodes in the node group.
	//
	// Only labels that are applied with the Amazon EKS API are shown here. There
	// may be other Kubernetes labels applied to the nodes in this group.
	Labels map[string]*string `locationName:"labels" type:"map"`

	// The Unix epoch timestamp in seconds for when the managed node group was last
	// modified.
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp"`

	// The IAM role associated with your node group. The Amazon EKS worker node
	// kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive
	// permissions for these API calls through an IAM instance profile and associated
	// policies. Before you can launch worker nodes and register them into a cluster,
	// you must create an IAM role for those worker nodes to use when they are launched.
	// For more information, see Amazon EKS Worker Node IAM Role (https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html)
	// in the Amazon EKS User Guide .
	NodeRole *string `locationName:"nodeRole" type:"string"`

	// The Amazon Resource Name (ARN) associated with the managed node group.
	NodegroupArn *string `locationName:"nodegroupArn" type:"string"`

	// The name associated with an Amazon EKS managed node group.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`

	// The AMI version of the managed node group. For more information, see Amazon
	// EKS-Optimized Linux AMI Versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html)
	// in the Amazon EKS User Guide.
	ReleaseVersion *string `locationName:"releaseVersion" type:"string"`

	// The remote access (SSH) configuration that is associated with the node group.
	RemoteAccess *RemoteAccessConfig `locationName:"remoteAccess" type:"structure"`

	// The resources associated with the node group, such as Auto Scaling groups
	// and security groups for remote access.
	Resources *NodegroupResources `locationName:"resources" type:"structure"`

	// The scaling configuration details for the Auto Scaling group that is associated
	// with your node group.
	ScalingConfig *NodegroupScalingConfig `locationName:"scalingConfig" type:"structure"`

	// The current status of the managed node group.
	Status *string `locationName:"status" type:"string" enum:"NodegroupStatus"`

	// The subnets allowed for the Auto Scaling group that is associated with your
	// node group. These subnets must have the following tag: kubernetes.io/cluster/CLUSTER_NAME,
	// where CLUSTER_NAME is replaced with the name of your cluster.
	Subnets []*string `locationName:"subnets" type:"list"`

	// The metadata applied to the node group to assist with categorization and
	// organization. Each tag consists of a key and an optional value, both of which
	// you define. Node group tags do not propagate to any other resources associated
	// with the node group, such as the Amazon EC2 instances or subnets.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The Kubernetes version of the managed node group.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

An object representing an Amazon EKS managed node group.

func (Nodegroup) GoString added in v1.25.36

func (s Nodegroup) GoString() string

GoString returns the string representation

func (*Nodegroup) SetAmiType added in v1.25.36

func (s *Nodegroup) SetAmiType(v string) *Nodegroup

SetAmiType sets the AmiType field's value.

func (*Nodegroup) SetClusterName added in v1.25.36

func (s *Nodegroup) SetClusterName(v string) *Nodegroup

SetClusterName sets the ClusterName field's value.

func (*Nodegroup) SetCreatedAt added in v1.25.36

func (s *Nodegroup) SetCreatedAt(v time.Time) *Nodegroup

SetCreatedAt sets the CreatedAt field's value.

func (*Nodegroup) SetDiskSize added in v1.25.36

func (s *Nodegroup) SetDiskSize(v int64) *Nodegroup

SetDiskSize sets the DiskSize field's value.

func (*Nodegroup) SetHealth added in v1.25.36

func (s *Nodegroup) SetHealth(v *NodegroupHealth) *Nodegroup

SetHealth sets the Health field's value.

func (*Nodegroup) SetInstanceTypes added in v1.25.36

func (s *Nodegroup) SetInstanceTypes(v []*string) *Nodegroup

SetInstanceTypes sets the InstanceTypes field's value.

func (*Nodegroup) SetLabels added in v1.25.36

func (s *Nodegroup) SetLabels(v map[string]*string) *Nodegroup

SetLabels sets the Labels field's value.

func (*Nodegroup) SetModifiedAt added in v1.25.36

func (s *Nodegroup) SetModifiedAt(v time.Time) *Nodegroup

SetModifiedAt sets the ModifiedAt field's value.

func (*Nodegroup) SetNodeRole added in v1.25.36

func (s *Nodegroup) SetNodeRole(v string) *Nodegroup

SetNodeRole sets the NodeRole field's value.

func (*Nodegroup) SetNodegroupArn added in v1.25.36

func (s *Nodegroup) SetNodegroupArn(v string) *Nodegroup

SetNodegroupArn sets the NodegroupArn field's value.

func (*Nodegroup) SetNodegroupName added in v1.25.36

func (s *Nodegroup) SetNodegroupName(v string) *Nodegroup

SetNodegroupName sets the NodegroupName field's value.

func (*Nodegroup) SetReleaseVersion added in v1.25.36

func (s *Nodegroup) SetReleaseVersion(v string) *Nodegroup

SetReleaseVersion sets the ReleaseVersion field's value.

func (*Nodegroup) SetRemoteAccess added in v1.25.36

func (s *Nodegroup) SetRemoteAccess(v *RemoteAccessConfig) *Nodegroup

SetRemoteAccess sets the RemoteAccess field's value.

func (*Nodegroup) SetResources added in v1.25.36

func (s *Nodegroup) SetResources(v *NodegroupResources) *Nodegroup

SetResources sets the Resources field's value.

func (*Nodegroup) SetScalingConfig added in v1.25.36

func (s *Nodegroup) SetScalingConfig(v *NodegroupScalingConfig) *Nodegroup

SetScalingConfig sets the ScalingConfig field's value.

func (*Nodegroup) SetStatus added in v1.25.36

func (s *Nodegroup) SetStatus(v string) *Nodegroup

SetStatus sets the Status field's value.

func (*Nodegroup) SetSubnets added in v1.25.36

func (s *Nodegroup) SetSubnets(v []*string) *Nodegroup

SetSubnets sets the Subnets field's value.

func (*Nodegroup) SetTags added in v1.25.36

func (s *Nodegroup) SetTags(v map[string]*string) *Nodegroup

SetTags sets the Tags field's value.

func (*Nodegroup) SetVersion added in v1.25.36

func (s *Nodegroup) SetVersion(v string) *Nodegroup

SetVersion sets the Version field's value.

func (Nodegroup) String added in v1.25.36

func (s Nodegroup) String() string

String returns the string representation

type NodegroupHealth added in v1.25.36

type NodegroupHealth struct {

	// Any issues that are associated with the node group.
	Issues []*Issue `locationName:"issues" type:"list"`
	// contains filtered or unexported fields
}

An object representing the health status of the node group.

func (NodegroupHealth) GoString added in v1.25.36

func (s NodegroupHealth) GoString() string

GoString returns the string representation

func (*NodegroupHealth) SetIssues added in v1.25.36

func (s *NodegroupHealth) SetIssues(v []*Issue) *NodegroupHealth

SetIssues sets the Issues field's value.

func (NodegroupHealth) String added in v1.25.36

func (s NodegroupHealth) String() string

String returns the string representation

type NodegroupResources added in v1.25.36

type NodegroupResources struct {

	// The Auto Scaling groups associated with the node group.
	AutoScalingGroups []*AutoScalingGroup `locationName:"autoScalingGroups" type:"list"`

	// The remote access security group associated with the node group. This security
	// group controls SSH access to the worker nodes.
	RemoteAccessSecurityGroup *string `locationName:"remoteAccessSecurityGroup" type:"string"`
	// contains filtered or unexported fields
}

An object representing the resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

func (NodegroupResources) GoString added in v1.25.36

func (s NodegroupResources) GoString() string

GoString returns the string representation

func (*NodegroupResources) SetAutoScalingGroups added in v1.25.36

func (s *NodegroupResources) SetAutoScalingGroups(v []*AutoScalingGroup) *NodegroupResources

SetAutoScalingGroups sets the AutoScalingGroups field's value.

func (*NodegroupResources) SetRemoteAccessSecurityGroup added in v1.25.36

func (s *NodegroupResources) SetRemoteAccessSecurityGroup(v string) *NodegroupResources

SetRemoteAccessSecurityGroup sets the RemoteAccessSecurityGroup field's value.

func (NodegroupResources) String added in v1.25.36

func (s NodegroupResources) String() string

String returns the string representation

type NodegroupScalingConfig added in v1.25.36

type NodegroupScalingConfig struct {

	// The current number of worker nodes that the managed node group should maintain.
	DesiredSize *int64 `locationName:"desiredSize" min:"1" type:"integer"`

	// The maximum number of worker nodes that the managed node group can scale
	// out to. Managed node groups can support up to 100 nodes by default.
	MaxSize *int64 `locationName:"maxSize" min:"1" type:"integer"`

	// The minimum number of worker nodes that the managed node group can scale
	// in to. This number must be greater than zero.
	MinSize *int64 `locationName:"minSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group.

func (NodegroupScalingConfig) GoString added in v1.25.36

func (s NodegroupScalingConfig) GoString() string

GoString returns the string representation

func (*NodegroupScalingConfig) SetDesiredSize added in v1.25.36

func (s *NodegroupScalingConfig) SetDesiredSize(v int64) *NodegroupScalingConfig

SetDesiredSize sets the DesiredSize field's value.

func (*NodegroupScalingConfig) SetMaxSize added in v1.25.36

SetMaxSize sets the MaxSize field's value.

func (*NodegroupScalingConfig) SetMinSize added in v1.25.36

SetMinSize sets the MinSize field's value.

func (NodegroupScalingConfig) String added in v1.25.36

func (s NodegroupScalingConfig) String() string

String returns the string representation

func (*NodegroupScalingConfig) Validate added in v1.25.36

func (s *NodegroupScalingConfig) Validate() error

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

type NotFoundException added in v1.28.0

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A service resource associated with the request could not be found. Clients should not retry such requests.

func (*NotFoundException) Code added in v1.28.0

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0

func (s NotFoundException) GoString() string

GoString returns the string representation

func (*NotFoundException) Message added in v1.28.0

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0

func (s NotFoundException) String() string

String returns the string representation

type OIDC added in v1.23.15

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) GoString added in v1.23.15

func (s OIDC) GoString() string

GoString returns the string representation

func (*OIDC) SetIssuer added in v1.23.15

func (s *OIDC) SetIssuer(v string) *OIDC

SetIssuer sets the Issuer field's value.

func (OIDC) String added in v1.23.15

func (s OIDC) String() string

String returns the string representation

type Provider added in v1.29.18

type Provider struct {

	// Amazon Resource Name (ARN) or alias of the customer master key (CMK). The
	// CMK must be symmetric, created in the same region as the cluster, and if
	// the CMK was created in a different account, the user must have access to
	// the CMK. For more information, see Allowing Users in Other Accounts to Use
	// a CMK (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html)
	// in the AWS Key Management Service Developer Guide.
	KeyArn *string `locationName:"keyArn" type:"string"`
	// contains filtered or unexported fields
}

Identifies the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the secrets.

func (Provider) GoString added in v1.29.18

func (s Provider) GoString() string

GoString returns the string representation

func (*Provider) SetKeyArn added in v1.29.18

func (s *Provider) SetKeyArn(v string) *Provider

SetKeyArn sets the KeyArn field's value.

func (Provider) String added in v1.29.18

func (s Provider) String() string

String returns the string representation

type RemoteAccessConfig added in v1.25.36

type RemoteAccessConfig struct {

	// The Amazon EC2 SSH key that provides access for SSH communication with the
	// worker nodes in the managed node group. For more information, see Amazon
	// EC2 Key Pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html)
	// in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
	Ec2SshKey *string `locationName:"ec2SshKey" type:"string"`

	// The security groups that are allowed SSH access (port 22) to the worker nodes.
	// If you specify an Amazon EC2 SSH key but do not specify a source security
	// group when you create a managed node group, then port 22 on the worker nodes
	// is opened to the internet (0.0.0.0/0). For more information, see Security
	// Groups for Your VPC (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html)
	// in the Amazon Virtual Private Cloud User Guide.
	SourceSecurityGroups []*string `locationName:"sourceSecurityGroups" type:"list"`
	// contains filtered or unexported fields
}

An object representing the remote access configuration for the managed node group.

func (RemoteAccessConfig) GoString added in v1.25.36

func (s RemoteAccessConfig) GoString() string

GoString returns the string representation

func (*RemoteAccessConfig) SetEc2SshKey added in v1.25.36

func (s *RemoteAccessConfig) SetEc2SshKey(v string) *RemoteAccessConfig

SetEc2SshKey sets the Ec2SshKey field's value.

func (*RemoteAccessConfig) SetSourceSecurityGroups added in v1.25.36

func (s *RemoteAccessConfig) SetSourceSecurityGroups(v []*string) *RemoteAccessConfig

SetSourceSecurityGroups sets the SourceSecurityGroups field's value.

func (RemoteAccessConfig) String added in v1.25.36

func (s RemoteAccessConfig) String() string

String returns the string representation

type ResourceInUseException added in v1.28.0

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is in use.

func (*ResourceInUseException) Code added in v1.28.0

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0

func (s ResourceInUseException) GoString() string

GoString returns the string representation

func (*ResourceInUseException) Message added in v1.28.0

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.28.0

func (s ResourceInUseException) String() string

String returns the string representation

type ResourceLimitExceededException added in v1.28.0

type ResourceLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

You have encountered a service limit on the specified resource.

func (*ResourceLimitExceededException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceLimitExceededException) Error added in v1.28.0

func (ResourceLimitExceededException) GoString added in v1.28.0

GoString returns the string representation

func (*ResourceLimitExceededException) Message added in v1.28.0

Message returns the exception's message.

func (*ResourceLimitExceededException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceededException) RequestID added in v1.28.0

func (s *ResourceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceededException) StatusCode added in v1.28.0

func (s *ResourceLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitExceededException) String added in v1.28.0

String returns the string representation

type ResourceNotFoundException added in v1.28.0

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	// The Fargate profile associated with the exception.
	FargateProfileName *string `locationName:"fargateProfileName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

func (*ResourceNotFoundException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0

func (s ResourceNotFoundException) String() string

String returns the string representation

type ServerException added in v1.28.0

type ServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`
	// contains filtered or unexported fields
}

These errors are usually caused by a server-side issue.

func (*ServerException) Code added in v1.28.0

func (s *ServerException) Code() string

Code returns the exception type name.

func (*ServerException) Error added in v1.28.0

func (s *ServerException) Error() string

func (ServerException) GoString added in v1.28.0

func (s ServerException) GoString() string

GoString returns the string representation

func (*ServerException) Message added in v1.28.0

func (s *ServerException) Message() string

Message returns the exception's message.

func (*ServerException) OrigErr added in v1.28.0

func (s *ServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServerException) RequestID added in v1.28.0

func (s *ServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServerException) StatusCode added in v1.28.0

func (s *ServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServerException) String added in v1.28.0

func (s ServerException) String() string

String returns the string representation

type ServiceUnavailableException added in v1.28.0

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service is unavailable. Back off and retry the operation.

func (*ServiceUnavailableException) Code added in v1.28.0

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0

func (ServiceUnavailableException) GoString added in v1.28.0

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (*ServiceUnavailableException) Message added in v1.28.0

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0

String returns the string representation

type TagResourceInput added in v1.23.22

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to which to add tags. Currently,
	// the supported resources are Amazon EKS clusters and managed node groups.
	//
	// 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) GoString added in v1.23.22

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn added in v1.23.22

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.23.22

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.23.22

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.23.22

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.23.22

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

func (TagResourceOutput) GoString added in v1.23.22

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.23.22

func (s TagResourceOutput) String() string

String returns the string representation

type UnsupportedAvailabilityZoneException added in v1.28.0

type UnsupportedAvailabilityZoneException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The Amazon EKS cluster associated with the exception.
	ClusterName *string `locationName:"clusterName" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	// The Amazon EKS managed node group associated with the exception.
	NodegroupName *string `locationName:"nodegroupName" type:"string"`

	// The supported Availability Zones for your account. Choose subnets in these
	// Availability Zones for your cluster.
	ValidZones []*string `locationName:"validZones" type:"list"`
	// contains filtered or unexported fields
}

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.

func (*UnsupportedAvailabilityZoneException) Code added in v1.28.0

Code returns the exception type name.

func (*UnsupportedAvailabilityZoneException) Error added in v1.28.0

func (UnsupportedAvailabilityZoneException) GoString added in v1.28.0

GoString returns the string representation

func (*UnsupportedAvailabilityZoneException) Message added in v1.28.0

Message returns the exception's message.

func (*UnsupportedAvailabilityZoneException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedAvailabilityZoneException) RequestID added in v1.28.0

RequestID returns the service's response RequestID for request.

func (*UnsupportedAvailabilityZoneException) StatusCode added in v1.28.0

func (s *UnsupportedAvailabilityZoneException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedAvailabilityZoneException) String added in v1.28.0

String returns the string representation

type UntagResourceInput added in v1.23.22

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which to delete tags.
	// Currently, the supported resources are Amazon EKS clusters and managed node
	// groups.
	//
	// 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) GoString added in v1.23.22

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn added in v1.23.22

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.23.22

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.23.22

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.23.22

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.23.22

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

func (UntagResourceOutput) GoString added in v1.23.22

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.23.22

func (s UntagResourceOutput) String() string

String returns the string representation

type Update added in v1.16.4

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 *string `locationName:"status" type:"string" enum:"UpdateStatus"`

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

An object representing an asynchronous update.

func (Update) GoString added in v1.16.4

func (s Update) GoString() string

GoString returns the string representation

func (*Update) SetCreatedAt added in v1.16.4

func (s *Update) SetCreatedAt(v time.Time) *Update

SetCreatedAt sets the CreatedAt field's value.

func (*Update) SetErrors added in v1.16.4

func (s *Update) SetErrors(v []*ErrorDetail) *Update

SetErrors sets the Errors field's value.

func (*Update) SetId added in v1.16.4

func (s *Update) SetId(v string) *Update

SetId sets the Id field's value.

func (*Update) SetParams added in v1.16.4

func (s *Update) SetParams(v []*UpdateParam) *Update

SetParams sets the Params field's value.

func (*Update) SetStatus added in v1.16.4

func (s *Update) SetStatus(v string) *Update

SetStatus sets the Status field's value.

func (*Update) SetType added in v1.16.4

func (s *Update) SetType(v string) *Update

SetType sets the Type field's value.

func (Update) String added in v1.16.4

func (s Update) String() string

String returns the string representation

type UpdateClusterConfigInput added in v1.18.5

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) GoString added in v1.18.5

func (s UpdateClusterConfigInput) GoString() string

GoString returns the string representation

func (*UpdateClusterConfigInput) SetClientRequestToken added in v1.18.5

func (s *UpdateClusterConfigInput) SetClientRequestToken(v string) *UpdateClusterConfigInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateClusterConfigInput) SetLogging added in v1.19.10

SetLogging sets the Logging field's value.

func (*UpdateClusterConfigInput) SetName added in v1.18.5

SetName sets the Name field's value.

func (*UpdateClusterConfigInput) SetResourcesVpcConfig added in v1.18.5

SetResourcesVpcConfig sets the ResourcesVpcConfig field's value.

func (UpdateClusterConfigInput) String added in v1.18.5

func (s UpdateClusterConfigInput) String() string

String returns the string representation

func (*UpdateClusterConfigInput) Validate added in v1.18.5

func (s *UpdateClusterConfigInput) Validate() error

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

type UpdateClusterConfigOutput added in v1.18.5

type UpdateClusterConfigOutput struct {

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

func (UpdateClusterConfigOutput) GoString added in v1.18.5

func (s UpdateClusterConfigOutput) GoString() string

GoString returns the string representation

func (*UpdateClusterConfigOutput) SetUpdate added in v1.18.5

SetUpdate sets the Update field's value.

func (UpdateClusterConfigOutput) String added in v1.18.5

func (s UpdateClusterConfigOutput) String() string

String returns the string representation

type UpdateClusterVersionInput added in v1.16.4

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) GoString added in v1.16.4

func (s UpdateClusterVersionInput) GoString() string

GoString returns the string representation

func (*UpdateClusterVersionInput) SetClientRequestToken added in v1.16.4

func (s *UpdateClusterVersionInput) SetClientRequestToken(v string) *UpdateClusterVersionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateClusterVersionInput) SetName added in v1.16.4

SetName sets the Name field's value.

func (*UpdateClusterVersionInput) SetVersion added in v1.16.4

SetVersion sets the Version field's value.

func (UpdateClusterVersionInput) String added in v1.16.4

func (s UpdateClusterVersionInput) String() string

String returns the string representation

func (*UpdateClusterVersionInput) Validate added in v1.16.4

func (s *UpdateClusterVersionInput) Validate() error

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

type UpdateClusterVersionOutput added in v1.16.4

type UpdateClusterVersionOutput struct {

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

func (UpdateClusterVersionOutput) GoString added in v1.16.4

func (s UpdateClusterVersionOutput) GoString() string

GoString returns the string representation

func (*UpdateClusterVersionOutput) SetUpdate added in v1.16.4

SetUpdate sets the Update field's value.

func (UpdateClusterVersionOutput) String added in v1.16.4

String returns the string representation

type UpdateLabelsPayload added in v1.25.36

type UpdateLabelsPayload struct {

	// Kubernetes labels to be added or updated.
	AddOrUpdateLabels map[string]*string `locationName:"addOrUpdateLabels" type:"map"`

	// Kubernetes labels to be removed.
	RemoveLabels []*string `locationName:"removeLabels" type:"list"`
	// contains filtered or unexported fields
}

An object representing a Kubernetes label change for a managed node group.

func (UpdateLabelsPayload) GoString added in v1.25.36

func (s UpdateLabelsPayload) GoString() string

GoString returns the string representation

func (*UpdateLabelsPayload) SetAddOrUpdateLabels added in v1.25.36

func (s *UpdateLabelsPayload) SetAddOrUpdateLabels(v map[string]*string) *UpdateLabelsPayload

SetAddOrUpdateLabels sets the AddOrUpdateLabels field's value.

func (*UpdateLabelsPayload) SetRemoveLabels added in v1.25.36

func (s *UpdateLabelsPayload) SetRemoveLabels(v []*string) *UpdateLabelsPayload

SetRemoveLabels sets the RemoveLabels field's value.

func (UpdateLabelsPayload) String added in v1.25.36

func (s UpdateLabelsPayload) String() string

String returns the string representation

type UpdateNodegroupConfigInput added in v1.25.36

type UpdateNodegroupConfigInput 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 that the managed node group resides in.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// The Kubernetes labels to be applied to the nodes in the node group after
	// the update.
	Labels *UpdateLabelsPayload `locationName:"labels" type:"structure"`

	// The name of the managed node group to update.
	//
	// NodegroupName is a required field
	NodegroupName *string `location:"uri" locationName:"nodegroupName" type:"string" required:"true"`

	// The scaling configuration details for the Auto Scaling group after the update.
	ScalingConfig *NodegroupScalingConfig `locationName:"scalingConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateNodegroupConfigInput) GoString added in v1.25.36

func (s UpdateNodegroupConfigInput) GoString() string

GoString returns the string representation

func (*UpdateNodegroupConfigInput) SetClientRequestToken added in v1.25.36

func (s *UpdateNodegroupConfigInput) SetClientRequestToken(v string) *UpdateNodegroupConfigInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateNodegroupConfigInput) SetClusterName added in v1.25.36

SetClusterName sets the ClusterName field's value.

func (*UpdateNodegroupConfigInput) SetLabels added in v1.25.36

SetLabels sets the Labels field's value.

func (*UpdateNodegroupConfigInput) SetNodegroupName added in v1.25.36

SetNodegroupName sets the NodegroupName field's value.

func (*UpdateNodegroupConfigInput) SetScalingConfig added in v1.25.36

SetScalingConfig sets the ScalingConfig field's value.

func (UpdateNodegroupConfigInput) String added in v1.25.36

String returns the string representation

func (*UpdateNodegroupConfigInput) Validate added in v1.25.36

func (s *UpdateNodegroupConfigInput) Validate() error

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

type UpdateNodegroupConfigOutput added in v1.25.36

type UpdateNodegroupConfigOutput struct {

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

func (UpdateNodegroupConfigOutput) GoString added in v1.25.36

func (s UpdateNodegroupConfigOutput) GoString() string

GoString returns the string representation

func (*UpdateNodegroupConfigOutput) SetUpdate added in v1.25.36

SetUpdate sets the Update field's value.

func (UpdateNodegroupConfigOutput) String added in v1.25.36

String returns the string representation

type UpdateNodegroupVersionInput added in v1.25.36

type UpdateNodegroupVersionInput 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 that is associated with the managed node
	// group to update.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"name" type:"string" required:"true"`

	// Force the update if the existing node group's pods are unable to be drained
	// due to a pod disruption budget issue. If an update fails because pods could
	// not be drained, you can force the update after it fails to terminate the
	// old node whether or not any pods are running on the node.
	Force *bool `locationName:"force" type:"boolean"`

	// The name of the managed node group to update.
	//
	// NodegroupName is a required field
	NodegroupName *string `location:"uri" locationName:"nodegroupName" type:"string" required:"true"`

	// The AMI version of the Amazon EKS-optimized AMI to use for the update. By
	// default, the latest available AMI version for the node group's Kubernetes
	// version is used. For more information, see Amazon EKS-Optimized Linux AMI
	// Versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html)
	// in the Amazon EKS User Guide.
	ReleaseVersion *string `locationName:"releaseVersion" type:"string"`

	// The Kubernetes version to update to. If no version is specified, then the
	// Kubernetes version of the node group does not change. You can specify the
	// Kubernetes version of the cluster to update the node group to the latest
	// AMI version of the cluster's Kubernetes version.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateNodegroupVersionInput) GoString added in v1.25.36

func (s UpdateNodegroupVersionInput) GoString() string

GoString returns the string representation

func (*UpdateNodegroupVersionInput) SetClientRequestToken added in v1.25.36

func (s *UpdateNodegroupVersionInput) SetClientRequestToken(v string) *UpdateNodegroupVersionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateNodegroupVersionInput) SetClusterName added in v1.25.36

SetClusterName sets the ClusterName field's value.

func (*UpdateNodegroupVersionInput) SetForce added in v1.25.36

SetForce sets the Force field's value.

func (*UpdateNodegroupVersionInput) SetNodegroupName added in v1.25.36

SetNodegroupName sets the NodegroupName field's value.

func (*UpdateNodegroupVersionInput) SetReleaseVersion added in v1.25.36

SetReleaseVersion sets the ReleaseVersion field's value.

func (*UpdateNodegroupVersionInput) SetVersion added in v1.25.36

SetVersion sets the Version field's value.

func (UpdateNodegroupVersionInput) String added in v1.25.36

String returns the string representation

func (*UpdateNodegroupVersionInput) Validate added in v1.25.36

func (s *UpdateNodegroupVersionInput) Validate() error

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

type UpdateNodegroupVersionOutput added in v1.25.36

type UpdateNodegroupVersionOutput struct {

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

func (UpdateNodegroupVersionOutput) GoString added in v1.25.36

func (s UpdateNodegroupVersionOutput) GoString() string

GoString returns the string representation

func (*UpdateNodegroupVersionOutput) SetUpdate added in v1.25.36

SetUpdate sets the Update field's value.

func (UpdateNodegroupVersionOutput) String added in v1.25.36

String returns the string representation

type UpdateParam added in v1.16.4

type UpdateParam struct {

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

	// 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) GoString added in v1.16.4

func (s UpdateParam) GoString() string

GoString returns the string representation

func (*UpdateParam) SetType added in v1.16.4

func (s *UpdateParam) SetType(v string) *UpdateParam

SetType sets the Type field's value.

func (*UpdateParam) SetValue added in v1.16.4

func (s *UpdateParam) SetValue(v string) *UpdateParam

SetValue sets the Value field's value.

func (UpdateParam) String added in v1.16.4

func (s UpdateParam) String() string

String returns the string representation

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. If you disable private access and you have worker
	// nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs
	// includes the necessary CIDR blocks for communication with the worker nodes
	// or Fargate pods. 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 to your cluster's Kubernetes
	// API server endpoint. If you disable public access, your cluster's Kubernetes
	// API server can only receive 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"`

	// The CIDR blocks that are allowed access to your cluster's public Kubernetes
	// API server endpoint. Communication to the endpoint from addresses outside
	// of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0.
	// If you've disabled private endpoint access and you have worker nodes or AWS
	// Fargate pods in the cluster, then ensure that you specify the necessary CIDR
	// blocks. 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 .
	PublicAccessCidrs []*string `locationName:"publicAccessCidrs" type:"list"`

	// 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) GoString

func (s VpcConfigRequest) GoString() string

GoString returns the string representation

func (*VpcConfigRequest) SetEndpointPrivateAccess added in v1.18.5

func (s *VpcConfigRequest) SetEndpointPrivateAccess(v bool) *VpcConfigRequest

SetEndpointPrivateAccess sets the EndpointPrivateAccess field's value.

func (*VpcConfigRequest) SetEndpointPublicAccess added in v1.18.5

func (s *VpcConfigRequest) SetEndpointPublicAccess(v bool) *VpcConfigRequest

SetEndpointPublicAccess sets the EndpointPublicAccess field's value.

func (*VpcConfigRequest) SetPublicAccessCidrs added in v1.26.7

func (s *VpcConfigRequest) SetPublicAccessCidrs(v []*string) *VpcConfigRequest

SetPublicAccessCidrs sets the PublicAccessCidrs field's value.

func (*VpcConfigRequest) SetSecurityGroupIds

func (s *VpcConfigRequest) SetSecurityGroupIds(v []*string) *VpcConfigRequest

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfigRequest) SetSubnetIds

func (s *VpcConfigRequest) SetSubnetIds(v []*string) *VpcConfigRequest

SetSubnetIds sets the SubnetIds field's value.

func (VpcConfigRequest) String

func (s VpcConfigRequest) String() string

String returns the string representation

type VpcConfigResponse

type VpcConfigResponse struct {

	// The cluster security group that was created by Amazon EKS for the cluster.
	// Managed node groups use this security group for control-plane-to-data-plane
	// communication.
	ClusterSecurityGroupId *string `locationName:"clusterSecurityGroupId" type:"string"`

	// 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. If this value is disabled
	// and you have worker nodes or AWS Fargate pods in the cluster, then ensure
	// that publicAccessCidrs includes the necessary CIDR blocks for communication
	// with the worker nodes or Fargate pods. 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"`

	// 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 only receive requests that originate
	// from within the cluster VPC.
	EndpointPublicAccess *bool `locationName:"endpointPublicAccess" type:"boolean"`

	// The CIDR blocks that are allowed access to your cluster's public Kubernetes
	// API server endpoint. Communication to the endpoint from addresses outside
	// of the listed CIDR blocks is denied. The default value is 0.0.0.0/0. If you've
	// disabled private endpoint access and you have worker nodes or AWS Fargate
	// pods in the cluster, then ensure that the necessary CIDR blocks are listed.
	// 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 .
	PublicAccessCidrs []*string `locationName:"publicAccessCidrs" type:"list"`

	// 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) GoString

func (s VpcConfigResponse) GoString() string

GoString returns the string representation

func (*VpcConfigResponse) SetClusterSecurityGroupId added in v1.25.36

func (s *VpcConfigResponse) SetClusterSecurityGroupId(v string) *VpcConfigResponse

SetClusterSecurityGroupId sets the ClusterSecurityGroupId field's value.

func (*VpcConfigResponse) SetEndpointPrivateAccess added in v1.18.5

func (s *VpcConfigResponse) SetEndpointPrivateAccess(v bool) *VpcConfigResponse

SetEndpointPrivateAccess sets the EndpointPrivateAccess field's value.

func (*VpcConfigResponse) SetEndpointPublicAccess added in v1.18.5

func (s *VpcConfigResponse) SetEndpointPublicAccess(v bool) *VpcConfigResponse

SetEndpointPublicAccess sets the EndpointPublicAccess field's value.

func (*VpcConfigResponse) SetPublicAccessCidrs added in v1.26.7

func (s *VpcConfigResponse) SetPublicAccessCidrs(v []*string) *VpcConfigResponse

SetPublicAccessCidrs sets the PublicAccessCidrs field's value.

func (*VpcConfigResponse) SetSecurityGroupIds

func (s *VpcConfigResponse) SetSecurityGroupIds(v []*string) *VpcConfigResponse

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfigResponse) SetSubnetIds

func (s *VpcConfigResponse) SetSubnetIds(v []*string) *VpcConfigResponse

SetSubnetIds sets the SubnetIds field's value.

func (*VpcConfigResponse) SetVpcId

func (s *VpcConfigResponse) SetVpcId(v string) *VpcConfigResponse

SetVpcId sets the VpcId field's value.

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