Documentation ¶
Overview ¶
Package eks provides the API client, operations, and parameter types for Amazon Elastic Kubernetes Service.
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to setup 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.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AddonActiveWaiter
- type AddonActiveWaiterOptions
- type AddonDeletedWaiter
- type AddonDeletedWaiterOptions
- type AssociateAccessPolicyInput
- type AssociateAccessPolicyOutput
- type AssociateEncryptionConfigInput
- type AssociateEncryptionConfigOutput
- type AssociateIdentityProviderConfigInput
- type AssociateIdentityProviderConfigOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AssociateAccessPolicy(ctx context.Context, params *AssociateAccessPolicyInput, ...) (*AssociateAccessPolicyOutput, error)
- func (c *Client) AssociateEncryptionConfig(ctx context.Context, params *AssociateEncryptionConfigInput, ...) (*AssociateEncryptionConfigOutput, error)
- func (c *Client) AssociateIdentityProviderConfig(ctx context.Context, params *AssociateIdentityProviderConfigInput, ...) (*AssociateIdentityProviderConfigOutput, error)
- func (c *Client) CreateAccessEntry(ctx context.Context, params *CreateAccessEntryInput, optFns ...func(*Options)) (*CreateAccessEntryOutput, error)
- func (c *Client) CreateAddon(ctx context.Context, params *CreateAddonInput, optFns ...func(*Options)) (*CreateAddonOutput, error)
- func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)
- func (c *Client) CreateEksAnywhereSubscription(ctx context.Context, params *CreateEksAnywhereSubscriptionInput, ...) (*CreateEksAnywhereSubscriptionOutput, error)
- func (c *Client) CreateFargateProfile(ctx context.Context, params *CreateFargateProfileInput, ...) (*CreateFargateProfileOutput, error)
- func (c *Client) CreateNodegroup(ctx context.Context, params *CreateNodegroupInput, optFns ...func(*Options)) (*CreateNodegroupOutput, error)
- func (c *Client) CreatePodIdentityAssociation(ctx context.Context, params *CreatePodIdentityAssociationInput, ...) (*CreatePodIdentityAssociationOutput, error)
- func (c *Client) DeleteAccessEntry(ctx context.Context, params *DeleteAccessEntryInput, optFns ...func(*Options)) (*DeleteAccessEntryOutput, error)
- func (c *Client) DeleteAddon(ctx context.Context, params *DeleteAddonInput, optFns ...func(*Options)) (*DeleteAddonOutput, error)
- func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)
- func (c *Client) DeleteEksAnywhereSubscription(ctx context.Context, params *DeleteEksAnywhereSubscriptionInput, ...) (*DeleteEksAnywhereSubscriptionOutput, error)
- func (c *Client) DeleteFargateProfile(ctx context.Context, params *DeleteFargateProfileInput, ...) (*DeleteFargateProfileOutput, error)
- func (c *Client) DeleteNodegroup(ctx context.Context, params *DeleteNodegroupInput, optFns ...func(*Options)) (*DeleteNodegroupOutput, error)
- func (c *Client) DeletePodIdentityAssociation(ctx context.Context, params *DeletePodIdentityAssociationInput, ...) (*DeletePodIdentityAssociationOutput, error)
- func (c *Client) DeregisterCluster(ctx context.Context, params *DeregisterClusterInput, optFns ...func(*Options)) (*DeregisterClusterOutput, error)
- func (c *Client) DescribeAccessEntry(ctx context.Context, params *DescribeAccessEntryInput, ...) (*DescribeAccessEntryOutput, error)
- func (c *Client) DescribeAddon(ctx context.Context, params *DescribeAddonInput, optFns ...func(*Options)) (*DescribeAddonOutput, error)
- func (c *Client) DescribeAddonConfiguration(ctx context.Context, params *DescribeAddonConfigurationInput, ...) (*DescribeAddonConfigurationOutput, error)
- func (c *Client) DescribeAddonVersions(ctx context.Context, params *DescribeAddonVersionsInput, ...) (*DescribeAddonVersionsOutput, error)
- func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error)
- func (c *Client) DescribeEksAnywhereSubscription(ctx context.Context, params *DescribeEksAnywhereSubscriptionInput, ...) (*DescribeEksAnywhereSubscriptionOutput, error)
- func (c *Client) DescribeFargateProfile(ctx context.Context, params *DescribeFargateProfileInput, ...) (*DescribeFargateProfileOutput, error)
- func (c *Client) DescribeIdentityProviderConfig(ctx context.Context, params *DescribeIdentityProviderConfigInput, ...) (*DescribeIdentityProviderConfigOutput, error)
- func (c *Client) DescribeInsight(ctx context.Context, params *DescribeInsightInput, optFns ...func(*Options)) (*DescribeInsightOutput, error)
- func (c *Client) DescribeNodegroup(ctx context.Context, params *DescribeNodegroupInput, optFns ...func(*Options)) (*DescribeNodegroupOutput, error)
- func (c *Client) DescribePodIdentityAssociation(ctx context.Context, params *DescribePodIdentityAssociationInput, ...) (*DescribePodIdentityAssociationOutput, error)
- func (c *Client) DescribeUpdate(ctx context.Context, params *DescribeUpdateInput, optFns ...func(*Options)) (*DescribeUpdateOutput, error)
- func (c *Client) DisassociateAccessPolicy(ctx context.Context, params *DisassociateAccessPolicyInput, ...) (*DisassociateAccessPolicyOutput, error)
- func (c *Client) DisassociateIdentityProviderConfig(ctx context.Context, params *DisassociateIdentityProviderConfigInput, ...) (*DisassociateIdentityProviderConfigOutput, error)
- func (c *Client) ListAccessEntries(ctx context.Context, params *ListAccessEntriesInput, optFns ...func(*Options)) (*ListAccessEntriesOutput, error)
- func (c *Client) ListAccessPolicies(ctx context.Context, params *ListAccessPoliciesInput, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)
- func (c *Client) ListAddons(ctx context.Context, params *ListAddonsInput, optFns ...func(*Options)) (*ListAddonsOutput, error)
- func (c *Client) ListAssociatedAccessPolicies(ctx context.Context, params *ListAssociatedAccessPoliciesInput, ...) (*ListAssociatedAccessPoliciesOutput, error)
- func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)
- func (c *Client) ListEksAnywhereSubscriptions(ctx context.Context, params *ListEksAnywhereSubscriptionsInput, ...) (*ListEksAnywhereSubscriptionsOutput, error)
- func (c *Client) ListFargateProfiles(ctx context.Context, params *ListFargateProfilesInput, ...) (*ListFargateProfilesOutput, error)
- func (c *Client) ListIdentityProviderConfigs(ctx context.Context, params *ListIdentityProviderConfigsInput, ...) (*ListIdentityProviderConfigsOutput, error)
- func (c *Client) ListInsights(ctx context.Context, params *ListInsightsInput, optFns ...func(*Options)) (*ListInsightsOutput, error)
- func (c *Client) ListNodegroups(ctx context.Context, params *ListNodegroupsInput, optFns ...func(*Options)) (*ListNodegroupsOutput, error)
- func (c *Client) ListPodIdentityAssociations(ctx context.Context, params *ListPodIdentityAssociationsInput, ...) (*ListPodIdentityAssociationsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListUpdates(ctx context.Context, params *ListUpdatesInput, optFns ...func(*Options)) (*ListUpdatesOutput, error)
- func (c *Client) Options() Options
- func (c *Client) RegisterCluster(ctx context.Context, params *RegisterClusterInput, optFns ...func(*Options)) (*RegisterClusterOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateAccessEntry(ctx context.Context, params *UpdateAccessEntryInput, optFns ...func(*Options)) (*UpdateAccessEntryOutput, error)
- func (c *Client) UpdateAddon(ctx context.Context, params *UpdateAddonInput, optFns ...func(*Options)) (*UpdateAddonOutput, error)
- func (c *Client) UpdateClusterConfig(ctx context.Context, params *UpdateClusterConfigInput, ...) (*UpdateClusterConfigOutput, error)
- func (c *Client) UpdateClusterVersion(ctx context.Context, params *UpdateClusterVersionInput, ...) (*UpdateClusterVersionOutput, error)
- func (c *Client) UpdateEksAnywhereSubscription(ctx context.Context, params *UpdateEksAnywhereSubscriptionInput, ...) (*UpdateEksAnywhereSubscriptionOutput, error)
- func (c *Client) UpdateNodegroupConfig(ctx context.Context, params *UpdateNodegroupConfigInput, ...) (*UpdateNodegroupConfigOutput, error)
- func (c *Client) UpdateNodegroupVersion(ctx context.Context, params *UpdateNodegroupVersionInput, ...) (*UpdateNodegroupVersionOutput, error)
- func (c *Client) UpdatePodIdentityAssociation(ctx context.Context, params *UpdatePodIdentityAssociationInput, ...) (*UpdatePodIdentityAssociationOutput, error)
- type ClusterActiveWaiter
- type ClusterActiveWaiterOptions
- type ClusterDeletedWaiter
- type ClusterDeletedWaiterOptions
- type CreateAccessEntryInput
- type CreateAccessEntryOutput
- type CreateAddonInput
- type CreateAddonOutput
- type CreateClusterInput
- type CreateClusterOutput
- type CreateEksAnywhereSubscriptionInput
- type CreateEksAnywhereSubscriptionOutput
- type CreateFargateProfileInput
- type CreateFargateProfileOutput
- type CreateNodegroupInput
- type CreateNodegroupOutput
- type CreatePodIdentityAssociationInput
- type CreatePodIdentityAssociationOutput
- type DeleteAccessEntryInput
- type DeleteAccessEntryOutput
- type DeleteAddonInput
- type DeleteAddonOutput
- type DeleteClusterInput
- type DeleteClusterOutput
- type DeleteEksAnywhereSubscriptionInput
- type DeleteEksAnywhereSubscriptionOutput
- type DeleteFargateProfileInput
- type DeleteFargateProfileOutput
- type DeleteNodegroupInput
- type DeleteNodegroupOutput
- type DeletePodIdentityAssociationInput
- type DeletePodIdentityAssociationOutput
- type DeregisterClusterInput
- type DeregisterClusterOutput
- type DescribeAccessEntryInput
- type DescribeAccessEntryOutput
- type DescribeAddonAPIClient
- type DescribeAddonConfigurationInput
- type DescribeAddonConfigurationOutput
- type DescribeAddonInput
- type DescribeAddonOutput
- type DescribeAddonVersionsAPIClient
- type DescribeAddonVersionsInput
- type DescribeAddonVersionsOutput
- type DescribeAddonVersionsPaginator
- type DescribeAddonVersionsPaginatorOptions
- type DescribeClusterAPIClient
- type DescribeClusterInput
- type DescribeClusterOutput
- type DescribeEksAnywhereSubscriptionInput
- type DescribeEksAnywhereSubscriptionOutput
- type DescribeFargateProfileAPIClient
- type DescribeFargateProfileInput
- type DescribeFargateProfileOutput
- type DescribeIdentityProviderConfigInput
- type DescribeIdentityProviderConfigOutput
- type DescribeInsightInput
- type DescribeInsightOutput
- type DescribeNodegroupAPIClient
- type DescribeNodegroupInput
- type DescribeNodegroupOutput
- type DescribePodIdentityAssociationInput
- type DescribePodIdentityAssociationOutput
- type DescribeUpdateInput
- type DescribeUpdateOutput
- type DisassociateAccessPolicyInput
- type DisassociateAccessPolicyOutput
- type DisassociateIdentityProviderConfigInput
- type DisassociateIdentityProviderConfigOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type FargateProfileActiveWaiter
- type FargateProfileActiveWaiterOptions
- type FargateProfileDeletedWaiter
- type FargateProfileDeletedWaiterOptions
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAccessEntriesAPIClient
- type ListAccessEntriesInput
- type ListAccessEntriesOutput
- type ListAccessEntriesPaginator
- type ListAccessEntriesPaginatorOptions
- type ListAccessPoliciesAPIClient
- type ListAccessPoliciesInput
- type ListAccessPoliciesOutput
- type ListAccessPoliciesPaginator
- type ListAccessPoliciesPaginatorOptions
- type ListAddonsAPIClient
- type ListAddonsInput
- type ListAddonsOutput
- type ListAddonsPaginator
- type ListAddonsPaginatorOptions
- type ListAssociatedAccessPoliciesAPIClient
- type ListAssociatedAccessPoliciesInput
- type ListAssociatedAccessPoliciesOutput
- type ListAssociatedAccessPoliciesPaginator
- type ListAssociatedAccessPoliciesPaginatorOptions
- type ListClustersAPIClient
- type ListClustersInput
- type ListClustersOutput
- type ListClustersPaginator
- type ListClustersPaginatorOptions
- type ListEksAnywhereSubscriptionsAPIClient
- type ListEksAnywhereSubscriptionsInput
- type ListEksAnywhereSubscriptionsOutput
- type ListEksAnywhereSubscriptionsPaginator
- type ListEksAnywhereSubscriptionsPaginatorOptions
- type ListFargateProfilesAPIClient
- type ListFargateProfilesInput
- type ListFargateProfilesOutput
- type ListFargateProfilesPaginator
- type ListFargateProfilesPaginatorOptions
- type ListIdentityProviderConfigsAPIClient
- type ListIdentityProviderConfigsInput
- type ListIdentityProviderConfigsOutput
- type ListIdentityProviderConfigsPaginator
- type ListIdentityProviderConfigsPaginatorOptions
- type ListInsightsAPIClient
- type ListInsightsInput
- type ListInsightsOutput
- type ListInsightsPaginator
- type ListInsightsPaginatorOptions
- type ListNodegroupsAPIClient
- type ListNodegroupsInput
- type ListNodegroupsOutput
- type ListNodegroupsPaginator
- type ListNodegroupsPaginatorOptions
- type ListPodIdentityAssociationsAPIClient
- type ListPodIdentityAssociationsInput
- type ListPodIdentityAssociationsOutput
- type ListPodIdentityAssociationsPaginator
- type ListPodIdentityAssociationsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListUpdatesAPIClient
- type ListUpdatesInput
- type ListUpdatesOutput
- type ListUpdatesPaginator
- type ListUpdatesPaginatorOptions
- type NodegroupActiveWaiter
- type NodegroupActiveWaiterOptions
- type NodegroupDeletedWaiter
- type NodegroupDeletedWaiterOptions
- type Options
- type RegisterClusterInput
- type RegisterClusterOutput
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAccessEntryInput
- type UpdateAccessEntryOutput
- type UpdateAddonInput
- type UpdateAddonOutput
- type UpdateClusterConfigInput
- type UpdateClusterConfigOutput
- type UpdateClusterVersionInput
- type UpdateClusterVersionOutput
- type UpdateEksAnywhereSubscriptionInput
- type UpdateEksAnywhereSubscriptionOutput
- type UpdateNodegroupConfigInput
- type UpdateNodegroupConfigOutput
- type UpdateNodegroupVersionInput
- type UpdateNodegroupVersionOutput
- type UpdatePodIdentityAssociationInput
- type UpdatePodIdentityAssociationOutput
Constants ¶
const ServiceAPIVersion = "2017-11-01"
const ServiceID = "EKS"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.29.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.33.1
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.33.1
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AddonActiveWaiter ¶ added in v0.31.0
type AddonActiveWaiter struct {
// contains filtered or unexported fields
}
AddonActiveWaiter defines the waiters for AddonActive
func NewAddonActiveWaiter ¶ added in v0.31.0
func NewAddonActiveWaiter(client DescribeAddonAPIClient, optFns ...func(*AddonActiveWaiterOptions)) *AddonActiveWaiter
NewAddonActiveWaiter constructs a AddonActiveWaiter.
func (*AddonActiveWaiter) Wait ¶ added in v0.31.0
func (w *AddonActiveWaiter) Wait(ctx context.Context, params *DescribeAddonInput, maxWaitDur time.Duration, optFns ...func(*AddonActiveWaiterOptions)) error
Wait calls the waiter function for AddonActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*AddonActiveWaiter) WaitForOutput ¶ added in v1.13.0
func (w *AddonActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeAddonInput, maxWaitDur time.Duration, optFns ...func(*AddonActiveWaiterOptions)) (*DescribeAddonOutput, error)
WaitForOutput calls the waiter function for AddonActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type AddonActiveWaiterOptions ¶ added in v0.31.0
type AddonActiveWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // AddonActiveWaiter will use default minimum delay of 10 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, AddonActiveWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAddonInput, *DescribeAddonOutput, error) (bool, error) }
AddonActiveWaiterOptions are waiter options for AddonActiveWaiter
type AddonDeletedWaiter ¶ added in v0.31.0
type AddonDeletedWaiter struct {
// contains filtered or unexported fields
}
AddonDeletedWaiter defines the waiters for AddonDeleted
func NewAddonDeletedWaiter ¶ added in v0.31.0
func NewAddonDeletedWaiter(client DescribeAddonAPIClient, optFns ...func(*AddonDeletedWaiterOptions)) *AddonDeletedWaiter
NewAddonDeletedWaiter constructs a AddonDeletedWaiter.
func (*AddonDeletedWaiter) Wait ¶ added in v0.31.0
func (w *AddonDeletedWaiter) Wait(ctx context.Context, params *DescribeAddonInput, maxWaitDur time.Duration, optFns ...func(*AddonDeletedWaiterOptions)) error
Wait calls the waiter function for AddonDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*AddonDeletedWaiter) WaitForOutput ¶ added in v1.13.0
func (w *AddonDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeAddonInput, maxWaitDur time.Duration, optFns ...func(*AddonDeletedWaiterOptions)) (*DescribeAddonOutput, error)
WaitForOutput calls the waiter function for AddonDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type AddonDeletedWaiterOptions ¶ added in v0.31.0
type AddonDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // AddonDeletedWaiter will use default minimum delay of 10 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, AddonDeletedWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAddonInput, *DescribeAddonOutput, error) (bool, error) }
AddonDeletedWaiterOptions are waiter options for AddonDeletedWaiter
type AssociateAccessPolicyInput ¶ added in v1.36.0
type AssociateAccessPolicyInput struct { // The scope for the AccessPolicy . You can scope access policies to an entire // cluster or to specific Kubernetes namespaces. // // This member is required. AccessScope *types.AccessScope // The name of your cluster. // // This member is required. ClusterName *string // The ARN of the AccessPolicy that you're associating. For a list of ARNs, use // ListAccessPolicies . // // This member is required. PolicyArn *string // The Amazon Resource Name (ARN) of the IAM user or role for the AccessEntry that // you're associating the access policy to. // // This member is required. PrincipalArn *string // contains filtered or unexported fields }
type AssociateAccessPolicyOutput ¶ added in v1.36.0
type AssociateAccessPolicyOutput struct { // The AccessPolicy and scope associated to the AccessEntry . AssociatedAccessPolicy *types.AssociatedAccessPolicy // The name of your cluster. ClusterName *string // The ARN of the IAM principal for the AccessEntry . PrincipalArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateEncryptionConfigInput ¶ added in v1.2.0
type AssociateEncryptionConfigInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The configuration you are using for encryption. // // This member is required. EncryptionConfig []types.EncryptionConfig // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // contains filtered or unexported fields }
type AssociateEncryptionConfigOutput ¶ added in v1.2.0
type AssociateEncryptionConfigOutput struct { // An object representing an asynchronous update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateIdentityProviderConfigInput ¶ added in v1.2.0
type AssociateIdentityProviderConfigInput struct { // The name of your cluster. // // This member is required. ClusterName *string // An object representing an OpenID Connect (OIDC) identity provider configuration. // // This member is required. Oidc *types.OidcIdentityProviderConfigRequest // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. Tags map[string]string // contains filtered or unexported fields }
type AssociateIdentityProviderConfigOutput ¶ added in v1.2.0
type AssociateIdentityProviderConfigOutput struct { // The tags for the resource. Tags map[string]string // An object representing an asynchronous update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶ added in v1.33.1
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.33.1
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Elastic Kubernetes Service.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateAccessPolicy ¶ added in v1.36.0
func (c *Client) AssociateAccessPolicy(ctx context.Context, params *AssociateAccessPolicyInput, optFns ...func(*Options)) (*AssociateAccessPolicyOutput, error)
Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entriesin the Amazon EKS User Guide.
func (*Client) AssociateEncryptionConfig ¶ added in v1.2.0
func (c *Client) AssociateEncryptionConfig(ctx context.Context, params *AssociateEncryptionConfigInput, optFns ...func(*Options)) (*AssociateEncryptionConfigOutput, error)
Associates an encryption configuration to an existing cluster.
Use this API to enable encryption on existing clusters that don't already have encryption enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.
func (*Client) AssociateIdentityProviderConfig ¶ added in v1.2.0
func (c *Client) AssociateIdentityProviderConfig(ctx context.Context, params *AssociateIdentityProviderConfigInput, optFns ...func(*Options)) (*AssociateIdentityProviderConfigOutput, error)
Associates an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes Role and ClusterRole objects, assign permissions to them, and then bind them to the identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For more information see Using RBAC Authorizationin the Kubernetes documentation.
func (*Client) CreateAccessEntry ¶ added in v1.36.0
func (c *Client) CreateAccessEntry(ctx context.Context, params *CreateAccessEntryInput, optFns ...func(*Options)) (*CreateAccessEntryOutput, error)
Creates an access entry.
An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the aws-auth ConfigMap for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes Role , ClusterRole , RoleBinding , and ClusterRoleBinding objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage Kubernetes Role , ClusterRole , RoleBinding , and ClusterRoleBinding objects.
For more information about access entries, see Access entries in the Amazon EKS User Guide.
func (*Client) CreateAddon ¶ added in v0.31.0
func (c *Client) CreateAddon(ctx context.Context, params *CreateAddonInput, optFns ...func(*Options)) (*CreateAddonOutput, error)
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-onsin the Amazon EKS User Guide.
func (*Client) CreateCluster ¶
func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)
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 Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It 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 nodes (for example, to support kubectl exec , logs , and proxy data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over 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 Controlin 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 Logsin the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Allowing users to access your clusterand Launching Amazon EKS nodes in the Amazon EKS User Guide.
func (*Client) CreateEksAnywhereSubscription ¶ added in v1.33.0
func (c *Client) CreateEksAnywhereSubscription(ctx context.Context, params *CreateEksAnywhereSubscriptionInput, optFns ...func(*Options)) (*CreateEksAnywhereSubscriptionOutput, error)
Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.
func (*Client) CreateFargateProfile ¶
func (c *Client) CreateFargateProfile(ctx context.Context, params *CreateFargateProfileInput, optFns ...func(*Options)) (*CreateFargateProfileOutput, error)
Creates an 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(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 Rolein 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 Fargate profile in the Amazon EKS User Guide.
func (*Client) CreateNodegroup ¶
func (c *Client) CreateNodegroup(ctx context.Context, params *CreateNodegroupInput, optFns ...func(*Options)) (*CreateNodegroupOutput, error)
Creates a managed 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, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Customizing managed nodes with launch templates.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groupsin the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS.
func (*Client) CreatePodIdentityAssociation ¶ added in v1.34.0
func (c *Client) CreatePodIdentityAssociation(ctx context.Context, params *CreatePodIdentityAssociationInput, optFns ...func(*Options)) (*CreatePodIdentityAssociationOutput, error)
Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically.
Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials.
Pod Identity is a simpler method than IAM roles for service accounts, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters.
func (*Client) DeleteAccessEntry ¶ added in v1.36.0
func (c *Client) DeleteAccessEntry(ctx context.Context, params *DeleteAccessEntryInput, optFns ...func(*Options)) (*DeleteAccessEntryOutput, error)
Deletes an access entry.
Deleting an access entry of a type other than Standard can cause your cluster to function improperly. If you delete an access entry in error, you can recreate it.
func (*Client) DeleteAddon ¶ added in v0.31.0
func (c *Client) DeleteAddon(ctx context.Context, params *DeleteAddonInput, optFns ...func(*Options)) (*DeleteAddonOutput, error)
Deletes an Amazon EKS add-on.
When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
func (*Client) DeleteCluster ¶
func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)
Deletes an 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 clusterin 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 DeleteNodgroup and DeleteFargateProfile .
func (*Client) DeleteEksAnywhereSubscription ¶ added in v1.33.0
func (c *Client) DeleteEksAnywhereSubscription(ctx context.Context, params *DeleteEksAnywhereSubscriptionInput, optFns ...func(*Options)) (*DeleteEksAnywhereSubscriptionOutput, error)
Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.
func (*Client) DeleteFargateProfile ¶
func (c *Client) DeleteFargateProfile(ctx context.Context, params *DeleteFargateProfileInput, optFns ...func(*Options)) (*DeleteFargateProfileOutput, error)
Deletes an Fargate profile.
When you delete a Fargate profile, any Pod running on Fargate that was created with the profile is deleted. If the Pod matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and 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.
func (*Client) DeleteNodegroup ¶
func (c *Client) DeleteNodegroup(ctx context.Context, params *DeleteNodegroupInput, optFns ...func(*Options)) (*DeleteNodegroupOutput, error)
Deletes a managed node group.
func (*Client) DeletePodIdentityAssociation ¶ added in v1.34.0
func (c *Client) DeletePodIdentityAssociation(ctx context.Context, params *DeletePodIdentityAssociationInput, optFns ...func(*Options)) (*DeletePodIdentityAssociationOutput, error)
Deletes a EKS Pod Identity association.
The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.
func (*Client) DeregisterCluster ¶ added in v1.10.0
func (c *Client) DeregisterCluster(ctx context.Context, params *DeregisterClusterInput, optFns ...func(*Options)) (*DeregisterClusterOutput, error)
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.
func (*Client) DescribeAccessEntry ¶ added in v1.36.0
func (c *Client) DescribeAccessEntry(ctx context.Context, params *DescribeAccessEntryInput, optFns ...func(*Options)) (*DescribeAccessEntryOutput, error)
Describes an access entry.
func (*Client) DescribeAddon ¶ added in v0.31.0
func (c *Client) DescribeAddon(ctx context.Context, params *DescribeAddonInput, optFns ...func(*Options)) (*DescribeAddonOutput, error)
Describes an Amazon EKS add-on.
func (*Client) DescribeAddonConfiguration ¶ added in v1.25.0
func (c *Client) DescribeAddonConfiguration(ctx context.Context, params *DescribeAddonConfigurationInput, optFns ...func(*Options)) (*DescribeAddonConfigurationOutput, error)
Returns configuration options.
func (*Client) DescribeAddonVersions ¶ added in v0.31.0
func (c *Client) DescribeAddonVersions(ctx context.Context, params *DescribeAddonVersionsInput, optFns ...func(*Options)) (*DescribeAddonVersionsOutput, error)
Describes the versions for an add-on.
Information such as the Kubernetes versions that you can use the add-on with, the owner , publisher , and the type of the add-on are returned.
func (*Client) DescribeCluster ¶
func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error)
Describes 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 Creating or updating a kubeconfig file for an Amazon EKS clusterkubeconfig .
The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.
func (*Client) DescribeEksAnywhereSubscription ¶ added in v1.33.0
func (c *Client) DescribeEksAnywhereSubscription(ctx context.Context, params *DescribeEksAnywhereSubscriptionInput, optFns ...func(*Options)) (*DescribeEksAnywhereSubscriptionOutput, error)
Returns descriptive information about a subscription.
func (*Client) DescribeFargateProfile ¶
func (c *Client) DescribeFargateProfile(ctx context.Context, params *DescribeFargateProfileInput, optFns ...func(*Options)) (*DescribeFargateProfileOutput, error)
Describes an Fargate profile.
func (*Client) DescribeIdentityProviderConfig ¶ added in v1.2.0
func (c *Client) DescribeIdentityProviderConfig(ctx context.Context, params *DescribeIdentityProviderConfigInput, optFns ...func(*Options)) (*DescribeIdentityProviderConfigOutput, error)
Describes an identity provider configuration.
func (*Client) DescribeInsight ¶ added in v1.37.0
func (c *Client) DescribeInsight(ctx context.Context, params *DescribeInsightInput, optFns ...func(*Options)) (*DescribeInsightOutput, error)
Returns details about an insight that you specify using its ID.
func (*Client) DescribeNodegroup ¶
func (c *Client) DescribeNodegroup(ctx context.Context, params *DescribeNodegroupInput, optFns ...func(*Options)) (*DescribeNodegroupOutput, error)
Describes a managed node group.
func (*Client) DescribePodIdentityAssociation ¶ added in v1.34.0
func (c *Client) DescribePodIdentityAssociation(ctx context.Context, params *DescribePodIdentityAssociationInput, optFns ...func(*Options)) (*DescribePodIdentityAssociationOutput, error)
Returns descriptive information about an EKS Pod Identity association.
This action requires the ID of the association. You can get the ID from the response to the CreatePodIdentityAssocation for newly created associations. Or, you can list the IDs for associations with ListPodIdentityAssociations and filter the list by namespace or service account.
func (*Client) DescribeUpdate ¶
func (c *Client) DescribeUpdate(ctx context.Context, params *DescribeUpdateInput, optFns ...func(*Options)) (*DescribeUpdateOutput, error)
Describes an update to an Amazon EKS resource.
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.
func (*Client) DisassociateAccessPolicy ¶ added in v1.36.0
func (c *Client) DisassociateAccessPolicy(ctx context.Context, params *DisassociateAccessPolicyInput, optFns ...func(*Options)) (*DisassociateAccessPolicyOutput, error)
Disassociates an access policy from an access entry.
func (*Client) DisassociateIdentityProviderConfig ¶ added in v1.2.0
func (c *Client) DisassociateIdentityProviderConfig(ctx context.Context, params *DisassociateIdentityProviderConfigInput, optFns ...func(*Options)) (*DisassociateIdentityProviderConfigOutput, error)
Disassociates an identity provider configuration from a cluster.
If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals.
func (*Client) ListAccessEntries ¶ added in v1.36.0
func (c *Client) ListAccessEntries(ctx context.Context, params *ListAccessEntriesInput, optFns ...func(*Options)) (*ListAccessEntriesOutput, error)
Lists the access entries for your cluster.
func (*Client) ListAccessPolicies ¶ added in v1.36.0
func (c *Client) ListAccessPolicies(ctx context.Context, params *ListAccessPoliciesInput, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)
Lists the available access policies.
func (*Client) ListAddons ¶ added in v0.31.0
func (c *Client) ListAddons(ctx context.Context, params *ListAddonsInput, optFns ...func(*Options)) (*ListAddonsOutput, error)
Lists the installed add-ons.
func (*Client) ListAssociatedAccessPolicies ¶ added in v1.36.0
func (c *Client) ListAssociatedAccessPolicies(ctx context.Context, params *ListAssociatedAccessPoliciesInput, optFns ...func(*Options)) (*ListAssociatedAccessPoliciesOutput, error)
Lists the access policies associated with an access entry.
func (*Client) ListClusters ¶
func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
func (*Client) ListEksAnywhereSubscriptions ¶ added in v1.33.0
func (c *Client) ListEksAnywhereSubscriptions(ctx context.Context, params *ListEksAnywhereSubscriptionsInput, optFns ...func(*Options)) (*ListEksAnywhereSubscriptionsOutput, error)
Displays the full description of the subscription.
func (*Client) ListFargateProfiles ¶
func (c *Client) ListFargateProfiles(ctx context.Context, params *ListFargateProfilesInput, optFns ...func(*Options)) (*ListFargateProfilesOutput, error)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.
func (*Client) ListIdentityProviderConfigs ¶ added in v1.2.0
func (c *Client) ListIdentityProviderConfigs(ctx context.Context, params *ListIdentityProviderConfigsInput, optFns ...func(*Options)) (*ListIdentityProviderConfigsOutput, error)
Lists the identity provider configurations for your cluster.
func (*Client) ListInsights ¶ added in v1.37.0
func (c *Client) ListInsights(ctx context.Context, params *ListInsightsInput, optFns ...func(*Options)) (*ListInsightsOutput, error)
Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
func (*Client) ListNodegroups ¶
func (c *Client) ListNodegroups(ctx context.Context, params *ListNodegroupsInput, optFns ...func(*Options)) (*ListNodegroupsOutput, error)
Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.
func (*Client) ListPodIdentityAssociations ¶ added in v1.34.0
func (c *Client) ListPodIdentityAssociations(ctx context.Context, params *ListPodIdentityAssociationsInput, optFns ...func(*Options)) (*ListPodIdentityAssociationsOutput, error)
List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
List the tags for an Amazon EKS resource.
func (*Client) ListUpdates ¶
func (c *Client) ListUpdates(ctx context.Context, params *ListUpdatesInput, optFns ...func(*Options)) (*ListUpdatesOutput, error)
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
func (*Client) Options ¶ added in v1.35.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) RegisterCluster ¶ added in v1.10.0
func (c *Client) RegisterCluster(ctx context.Context, params *RegisterClusterInput, optFns ...func(*Options)) (*RegisterClusterOutput, error)
Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane.
Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.
After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using DeregisterCluster .
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Associates the specified tags to an Amazon EKS resource with the specified resourceArn . If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Deletes specified tags from an Amazon EKS resource.
func (*Client) UpdateAccessEntry ¶ added in v1.36.0
func (c *Client) UpdateAccessEntry(ctx context.Context, params *UpdateAccessEntryInput, optFns ...func(*Options)) (*UpdateAccessEntryOutput, error)
Updates an access entry.
func (*Client) UpdateAddon ¶ added in v0.31.0
func (c *Client) UpdateAddon(ctx context.Context, params *UpdateAddonInput, optFns ...func(*Options)) (*UpdateAddonOutput, error)
Updates an Amazon EKS add-on.
func (*Client) UpdateClusterConfig ¶
func (c *Client) UpdateClusterConfig(ctx context.Context, params *UpdateClusterConfigInput, optFns ...func(*Options)) (*UpdateClusterConfigOutput, error)
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 DescribeUpdate "/>.
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 logsin the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see 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 controlin the Amazon EKS User Guide .
You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.htmlin the Amazon EKS User Guide .
You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the 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 .
func (*Client) UpdateClusterVersion ¶
func (c *Client) UpdateClusterVersion(ctx context.Context, params *UpdateClusterVersionInput, optFns ...func(*Options)) (*UpdateClusterVersionOutput, error)
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 DescribeUpdateAPI 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.
func (*Client) UpdateEksAnywhereSubscription ¶ added in v1.33.0
func (c *Client) UpdateEksAnywhereSubscription(ctx context.Context, params *UpdateEksAnywhereSubscriptionInput, optFns ...func(*Options)) (*UpdateEksAnywhereSubscriptionOutput, error)
Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
func (*Client) UpdateNodegroupConfig ¶
func (c *Client) UpdateNodegroupConfig(ctx context.Context, params *UpdateNodegroupConfigInput, optFns ...func(*Options)) (*UpdateNodegroupConfigOutput, error)
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 DescribeUpdateAPI operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
func (*Client) UpdateNodegroupVersion ¶
func (c *Client) UpdateNodegroupVersion(ctx context.Context, params *UpdateNodegroupVersionInput, optFns ...func(*Options)) (*UpdateNodegroupVersionOutput, error)
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then 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 information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versionsin the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versionsin 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, every Pod on that node is 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.
func (*Client) UpdatePodIdentityAssociation ¶ added in v1.34.0
func (c *Client) UpdatePodIdentityAssociation(ctx context.Context, params *UpdatePodIdentityAssociationInput, optFns ...func(*Options)) (*UpdatePodIdentityAssociationOutput, error)
Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.
type ClusterActiveWaiter ¶ added in v0.31.0
type ClusterActiveWaiter struct {
// contains filtered or unexported fields
}
ClusterActiveWaiter defines the waiters for ClusterActive
func NewClusterActiveWaiter ¶ added in v0.31.0
func NewClusterActiveWaiter(client DescribeClusterAPIClient, optFns ...func(*ClusterActiveWaiterOptions)) *ClusterActiveWaiter
NewClusterActiveWaiter constructs a ClusterActiveWaiter.
func (*ClusterActiveWaiter) Wait ¶ added in v0.31.0
func (w *ClusterActiveWaiter) Wait(ctx context.Context, params *DescribeClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterActiveWaiterOptions)) error
Wait calls the waiter function for ClusterActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*ClusterActiveWaiter) WaitForOutput ¶ added in v1.13.0
func (w *ClusterActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterActiveWaiterOptions)) (*DescribeClusterOutput, error)
WaitForOutput calls the waiter function for ClusterActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type ClusterActiveWaiterOptions ¶ added in v0.31.0
type ClusterActiveWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // ClusterActiveWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, ClusterActiveWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) }
ClusterActiveWaiterOptions are waiter options for ClusterActiveWaiter
type ClusterDeletedWaiter ¶ added in v0.31.0
type ClusterDeletedWaiter struct {
// contains filtered or unexported fields
}
ClusterDeletedWaiter defines the waiters for ClusterDeleted
func NewClusterDeletedWaiter ¶ added in v0.31.0
func NewClusterDeletedWaiter(client DescribeClusterAPIClient, optFns ...func(*ClusterDeletedWaiterOptions)) *ClusterDeletedWaiter
NewClusterDeletedWaiter constructs a ClusterDeletedWaiter.
func (*ClusterDeletedWaiter) Wait ¶ added in v0.31.0
func (w *ClusterDeletedWaiter) Wait(ctx context.Context, params *DescribeClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterDeletedWaiterOptions)) error
Wait calls the waiter function for ClusterDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*ClusterDeletedWaiter) WaitForOutput ¶ added in v1.13.0
func (w *ClusterDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterDeletedWaiterOptions)) (*DescribeClusterOutput, error)
WaitForOutput calls the waiter function for ClusterDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type ClusterDeletedWaiterOptions ¶ added in v0.31.0
type ClusterDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // ClusterDeletedWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, ClusterDeletedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) }
ClusterDeletedWaiterOptions are waiter options for ClusterDeletedWaiter
type CreateAccessEntryInput ¶ added in v1.36.0
type CreateAccessEntryInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The ARN of the IAM principal for the AccessEntry . You can specify one ARN for // each access entry. You can't specify the same ARN in more than one access entry. // This value can't be changed after access entry creation. // // The valid principals differ depending on the type of the access entry in the // type field. The only valid ARN is IAM roles for the types of access entries for // nodes: . You can use every IAM principal type for STANDARD access entries. You // can't use the STS session principal type with access entries because this is a // temporary principal for each session and not a permanent identity that can be // assigned permissions. // // [IAM best practices]recommend using IAM roles with temporary credentials, rather than IAM users // with long-term credentials. // // [IAM best practices]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp // // This member is required. PrincipalArn *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The value for name that you've specified for kind: Group as a subject in a // Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't confirm // that the value for name exists in any bindings on your cluster. You can specify // one or more names. // // Kubernetes authorizes the principalArn of the access entry to access any // cluster objects that you've specified in a Kubernetes Role or ClusterRole // object that is also specified in a binding's roleRef . For more information // about creating Kubernetes RoleBinding , ClusterRoleBinding , Role , or // ClusterRole objects, see [Using RBAC Authorization in the Kubernetes documentation]. // // If you want Amazon EKS to authorize the principalArn (instead of, or in // addition to Kubernetes authorizing the principalArn ), you can associate one or // more access policies to the access entry using AssociateAccessPolicy . If you // associate any access policies, the principalARN has all permissions assigned in // the associated access policies and all permissions in any Kubernetes Role or // ClusterRole objects that the group names are bound to. // // [Using RBAC Authorization in the Kubernetes documentation]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ KubernetesGroups []string // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. Tags map[string]string // The type of the new access entry. Valid values are Standard , FARGATE_LINUX , // EC2_LINUX , and EC2_WINDOWS . // // If the principalArn is for an IAM role that's used for self-managed Amazon EC2 // nodes, specify EC2_LINUX or EC2_WINDOWS . Amazon EKS grants the necessary // permissions to the node for you. If the principalArn is for any other purpose, // specify STANDARD . If you don't specify a value, Amazon EKS sets the value to // STANDARD . It's unnecessary to create access entries for IAM roles used with // Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries // in the aws-auth ConfigMap for the roles. You can't change this value once // you've created the access entry. // // If you set the value to EC2_LINUX or EC2_WINDOWS , you can't specify values for // kubernetesGroups , or associate an AccessPolicy to the access entry. Type *string // The username to authenticate to Kubernetes with. We recommend not specifying a // username and letting Amazon EKS specify it for you. For more information about // the value Amazon EKS specifies for you, or constraints before specifying your // own username, see [Creating access entries]in the Amazon EKS User Guide. // // [Creating access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries Username *string // contains filtered or unexported fields }
type CreateAccessEntryOutput ¶ added in v1.36.0
type CreateAccessEntryOutput struct { // An access entry allows an IAM principal (user or role) to access your cluster. // Access entries can replace the need to maintain the aws-auth ConfigMap for // authentication. For more information about access entries, see [Access entries]in the Amazon // EKS User Guide. // // [Access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html AccessEntry *types.AccessEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateAddonInput ¶ added in v0.31.0
type CreateAddonInput struct { // The name of the add-on. The name must match one of the names returned by // DescribeAddonVersions . // // This member is required. AddonName *string // The name of your cluster. // // This member is required. ClusterName *string // The version of the add-on. The version must match one of the versions returned // by [DescribeAddonVersions]DescribeAddonVersions . // // [DescribeAddonVersions]: https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html AddonVersion *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The set of configuration values for the add-on that's created. The values that // you provide are validated against the schema returned by // DescribeAddonConfiguration . ConfigurationValues *string // An array of Pod Identity Assocations to be created. Each EKS Pod Identity // association maps a Kubernetes service account to an IAM Role. // // For more information, see [Attach an IAM Role to an Amazon EKS add-on using Pod Identity] in the EKS User Guide. // // [Attach an IAM Role to an Amazon EKS add-on using Pod Identity]: https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html PodIdentityAssociations []types.AddonPodIdentityAssociations // How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are // handled based on the value you choose: // // - None – If the self-managed version of the add-on is installed on your // cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail. // // - Overwrite – If the self-managed version of the add-on is installed on your // cluster and the Amazon EKS default value is different than the existing value, // Amazon EKS changes the value to the Amazon EKS default value. // // - Preserve – This is similar to the NONE option. If the self-managed version // of the add-on is installed on your cluster Amazon EKS doesn't change the add-on // resource properties. Creation of the add-on might fail if conflicts are // detected. This option works differently during the update operation. For more // information, see [UpdateAddon]. // // If you don't currently have the self-managed version of the add-on installed on // your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to // default values, regardless of the option that you specify. // // [UpdateAddon]: https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html ResolveConflicts types.ResolveConflicts // The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's // service account. The role must be assigned the IAM permissions required by the // add-on. If you don't specify an existing IAM role, then the add-on uses the // permissions assigned to the node IAM role. For more information, see [Amazon EKS node IAM role]in the // Amazon EKS User Guide. // // To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) // provider created for your cluster. For more information, see [Enabling IAM roles for service accounts on your cluster]in the Amazon EKS // User Guide. // // [Enabling IAM roles for service accounts on your cluster]: https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html // [Amazon EKS node IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html ServiceAccountRoleArn *string // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. Tags map[string]string // contains filtered or unexported fields }
type CreateAddonOutput ¶ added in v0.31.0
type CreateAddonOutput struct { // An Amazon EKS add-on. For more information, see [Amazon EKS add-ons] in the Amazon EKS User Guide. // // [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html Addon *types.Addon // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateClusterInput ¶
type CreateClusterInput struct { // The unique name to give to your cluster. The name can contain only alphanumeric // characters (case-sensitive), hyphens, and underscores. It must start with an // alphanumeric character and can't be longer than 100 characters. The name must be // unique within the Amazon Web Services Region and Amazon Web Services account // that you're creating the cluster in. // // This member is required. Name *string // The VPC configuration that's 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]and [Cluster Security Group Considerations] in the Amazon EKS User Guide. You must specify at least // two subnets. You can specify up to five security groups. However, we recommend // that you use a dedicated security group for your cluster control plane. // // [Cluster Security Group Considerations]: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html // [Cluster VPC Considerations]: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html // // This member is required. ResourcesVpcConfig *types.VpcConfigRequest // The Amazon Resource Name (ARN) of the IAM role that provides permissions for // the Kubernetes control plane to make calls to Amazon Web Services API operations // on your behalf. For more information, see [Amazon EKS Service IAM Role]in the Amazon EKS User Guide . // // [Amazon EKS Service IAM Role]: https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html // // This member is required. RoleArn *string // The access configuration for the cluster. AccessConfig *types.CreateAccessConfigRequest // If you set this value to False when creating a cluster, the default networking // add-ons will not be installed. // // The default networking addons include vpc-cni, coredns, and kube-proxy. // // Use this option when you plan to install third-party alternative add-ons or // self-manage the default networking add-ons. BootstrapSelfManagedAddons *bool // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The encryption configuration for the cluster. EncryptionConfig []types.EncryptionConfig // The Kubernetes network configuration for the cluster. KubernetesNetworkConfig *types.KubernetesNetworkConfigRequest // 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]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 [CloudWatch Pricing]. // // [Amazon EKS Cluster control plane logs]: https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html // [CloudWatch Pricing]: http://aws.amazon.com/cloudwatch/pricing/ Logging *types.Logging // An object representing the configuration of your local Amazon EKS cluster on an // Amazon Web Services Outpost. Before creating a local cluster on an Outpost, // review [Local clusters for Amazon EKS on Amazon Web Services Outposts]in the Amazon EKS User Guide. This object isn't available for creating // Amazon EKS clusters on the Amazon Web Services cloud. // // [Local clusters for Amazon EKS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html OutpostConfig *types.OutpostConfigRequest // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. Tags map[string]string // New clusters, by default, have extended support enabled. You can disable // extended support when creating a cluster by setting this value to STANDARD . UpgradePolicy *types.UpgradePolicyRequest // The desired Kubernetes version for your cluster. If you don't specify a value // here, the default version available in Amazon EKS is used. // // The default version might not be the latest version available. Version *string // Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, // Amazon Web Services configures zonal autoshift for the cluster. // // Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC // zonal shift is designed to be a temporary measure that allows you to move // traffic for a resource away from an impaired AZ until the zonal shift expires or // you cancel it. You can extend the zonal shift if necessary. // // You can start a zonal shift for an EKS cluster, or you can allow Amazon Web // Services to do it for you by enabling zonal autoshift. This shift updates the // flow of east-to-west network traffic in your cluster to only consider network // endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB // or NLB handling ingress traffic for applications in your EKS cluster will // automatically route traffic to targets in the healthy AZs. For more information // about zonal shift in EKS, see [Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS]in the Amazon EKS User Guide . // // [Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS]: https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html ZonalShiftConfig *types.ZonalShiftConfigRequest // contains filtered or unexported fields }
type CreateClusterOutput ¶
type CreateClusterOutput struct { // The full description of your new cluster. Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateEksAnywhereSubscriptionInput ¶ added in v1.33.0
type CreateEksAnywhereSubscriptionInput struct { // The unique name for your subscription. It must be unique in your Amazon Web // Services account in the Amazon Web Services Region you're creating the // subscription in. The name can contain only alphanumeric characters // (case-sensitive), hyphens, and underscores. It must start with an alphabetic // character and can't be longer than 100 characters. // // This member is required. Name *string // An object representing the term duration and term unit type of your // subscription. This determines the term length of your subscription. Valid values // are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month // or 36 month subscription. This value cannot be changed after creating the // subscription. // // This member is required. Term *types.EksAnywhereSubscriptionTerm // A boolean indicating whether the subscription auto renews at the end of the // term. AutoRenew bool // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The number of licenses to purchase with the subscription. Valid values are // between 1 and 100. This value can't be changed after creating the subscription. LicenseQuantity int32 // The license type for all licenses in the subscription. Valid value is CLUSTER. // With the CLUSTER license type, each license covers support for a single EKS // Anywhere cluster. LicenseType types.EksAnywhereSubscriptionLicenseType // The metadata for a subscription to assist with categorization and organization. // Each tag consists of a key and an optional value. Subscription tags don't // propagate to any other resources associated with the subscription. Tags map[string]string // contains filtered or unexported fields }
type CreateEksAnywhereSubscriptionOutput ¶ added in v1.33.0
type CreateEksAnywhereSubscriptionOutput struct { // The full description of the subscription. Subscription *types.EksAnywhereSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateFargateProfileInput ¶
type CreateFargateProfileInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The name of the Fargate profile. // // This member is required. FargateProfileName *string // The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that // matches 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]Pod in // the Amazon EKS User Guide. // // [Pod execution role]: https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html // // This member is required. PodExecutionRoleArn *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The selectors to match for a Pod to use this Fargate profile. Each selector // must have an associated Kubernetes namespace . Optionally, you can also specify // labels for a namespace . You may specify up to five selectors in a Fargate // profile. Selectors []types.FargateProfileSelector // The IDs of subnets to launch a Pod into. A Pod running on Fargate isn't // assigned a public IP address, so only private subnets (with no direct route to // an Internet Gateway) are accepted for this parameter. Subnets []string // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. Tags map[string]string // contains filtered or unexported fields }
type CreateFargateProfileOutput ¶
type CreateFargateProfileOutput struct { // The full description of your new Fargate profile. FargateProfile *types.FargateProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateNodegroupInput ¶
type CreateNodegroupInput struct { // The name of your cluster. // // This member is required. ClusterName *string // 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 Amazon Web // Services APIs on your behalf. Nodes receive permissions for these API calls // through an IAM instance profile and associated policies. Before you can launch // nodes and register them into a cluster, you must create an IAM role for those // nodes to use when they are launched. For more information, see [Amazon EKS node IAM role]in the Amazon // EKS User Guide . If you specify launchTemplate , then don't specify [IamInstanceProfile] in your // launch template, or the node group deployment will fail. For more information // about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates]in the Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html // [IamInstanceProfile]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html // [Amazon EKS node IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html // // This member is required. NodeRole *string // The unique name to give your node group. // // This member is required. NodegroupName *string // The subnets to use for the Auto Scaling group that is created for your node // group. If you specify launchTemplate , then don't specify [SubnetId] in your launch // template, or the node group deployment will fail. For more information about // using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates]in the Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html // [SubnetId]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html // // This member is required. Subnets []string // The AMI type for your node group. If you specify launchTemplate , and your // launch template uses a custom AMI, then don't specify amiType , or the node // group deployment will fail. If your launch template uses a Windows custom AMI, // then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth // ConfigMap . For more information about using launch templates with Amazon EKS, // see [Customizing managed nodes with launch templates]in the Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html AmiType types.AMITypes // The capacity type for your node group. CapacityType types.CapacityTypes // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The root device disk size (in GiB) for your node group instances. The default // disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB // for Windows. If you specify launchTemplate , then don't specify diskSize , or // the node group deployment will fail. For more information about using launch // templates with Amazon EKS, see [Customizing managed nodes with launch templates]in the Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html DiskSize *int32 // Specify the instance types for a node group. If you specify a GPU instance // type, make sure to also specify an applicable GPU AMI type with the amiType // parameter. If you specify launchTemplate , then you can specify zero or one // instance type in your launch template or you can specify 0-20 instance types for // instanceTypes . If however, you specify an instance type in your launch template // and specify any instanceTypes , the node group deployment will fail. If you // don't specify an instance type in a launch template or for instanceTypes , then // t3.medium is used, by default. If you specify Spot for capacityType , then we // recommend specifying multiple values for instanceTypes . For more information, // see [Managed node group capacity types]and [Customizing managed nodes with launch templates] in the Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html // [Managed node group capacity types]: https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types InstanceTypes []string // The Kubernetes labels to apply to the nodes in the node group when they are // created. Labels map[string]string // An object representing a node group's launch template specification. When using // this object, don't directly specify instanceTypes , diskSize , or remoteAccess . // Make sure that the launch template meets the requirements in // launchTemplateSpecification . Also refer to [Customizing managed nodes with launch templates] in the Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html LaunchTemplate *types.LaunchTemplateSpecification // 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 information about Linux versions, see [Amazon EKS optimized Amazon Linux AMI versions]in the // Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 // and later releases of the Windows AMIs. For information about Windows versions, // see [Amazon EKS optimized Windows AMI versions]in the Amazon EKS User Guide. // // If you specify launchTemplate , and your launch template uses a custom AMI, then // don't specify releaseVersion , or the node group deployment will fail. For more // information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates]in the Amazon EKS // User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html // [Amazon EKS optimized Amazon Linux AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html // [Amazon EKS optimized Windows AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html ReleaseVersion *string // The remote access configuration to use with your node group. For Linux, the // protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate // , then don't specify remoteAccess , or the node group deployment will fail. For // more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates]in the // Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html RemoteAccess *types.RemoteAccessConfig // The scaling configuration details for the Auto Scaling group that is created // for your node group. ScalingConfig *types.NodegroupScalingConfig // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. Tags map[string]string // The Kubernetes taints to be applied to the nodes in the node group. For more // information, see [Node taints on managed node groups]. // // [Node taints on managed node groups]: https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html Taints []types.Taint // The node group update configuration. UpdateConfig *types.NodegroupUpdateConfig // 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. If you specify launchTemplate , and your launch template uses a // custom AMI, then don't specify version , or the node group deployment will fail. // For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates]in the // Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html Version *string // contains filtered or unexported fields }
type CreateNodegroupOutput ¶
type CreateNodegroupOutput struct { // The full description of your new node group. Nodegroup *types.Nodegroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreatePodIdentityAssociationInput ¶ added in v1.34.0
type CreatePodIdentityAssociationInput struct { // The name of the cluster to create the association in. // // This member is required. ClusterName *string // The name of the Kubernetes namespace inside the cluster to create the // association in. The service account and the pods that use the service account // must be in this namespace. // // This member is required. Namespace *string // The Amazon Resource Name (ARN) of the IAM role to associate with the service // account. The EKS Pod Identity agent manages credentials to assume this role for // applications in the containers in the pods that use this service account. // // This member is required. RoleArn *string // The name of the Kubernetes service account inside the cluster to associate the // IAM credentials with. // // This member is required. ServiceAccount *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. // // The following basic restrictions apply to tags: // // - Maximum number of tags per resource – 50 // // - For each resource, each tag key must be unique, and each tag key can have // only one value. // // - Maximum key length – 128 Unicode characters in UTF-8 // // - Maximum value length – 256 Unicode characters in UTF-8 // // - If your tagging schema is used across multiple services and resources, // remember that other services may have restrictions on allowed characters. // Generally allowed characters are: letters, numbers, and spaces representable in // UTF-8, and the following characters: + - = . _ : / @. // // - Tag keys and values are case-sensitive. // // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a // prefix for either keys or values as it is reserved for Amazon Web Services use. // You cannot edit or delete tag keys or values with this prefix. Tags with this // prefix do not count against your tags per resource limit. Tags map[string]string // contains filtered or unexported fields }
type CreatePodIdentityAssociationOutput ¶ added in v1.34.0
type CreatePodIdentityAssociationOutput struct { // The full description of your new association. // // The description includes an ID for the association. Use the ID of the // association in further actions to manage the association. Association *types.PodIdentityAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccessEntryInput ¶ added in v1.36.0
type DeleteAccessEntryOutput ¶ added in v1.36.0
type DeleteAccessEntryOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAddonInput ¶ added in v0.31.0
type DeleteAddonInput struct { // The name of the add-on. The name must match one of the names returned by [ListAddons] // ListAddons . // // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html // // This member is required. AddonName *string // The name of your cluster. // // This member is required. ClusterName *string // Specifying this option preserves the add-on software on your cluster but Amazon // EKS stops managing any settings for the add-on. If an IAM account is associated // with the add-on, it isn't removed. Preserve bool // contains filtered or unexported fields }
type DeleteAddonOutput ¶ added in v0.31.0
type DeleteAddonOutput struct { // An Amazon EKS add-on. For more information, see [Amazon EKS add-ons] in the Amazon EKS User Guide. // // [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html Addon *types.Addon // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteClusterInput ¶
type DeleteClusterInput struct { // The name of the cluster to delete. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteClusterOutput ¶
type DeleteClusterOutput struct { // The full description of the cluster to delete. Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteEksAnywhereSubscriptionInput ¶ added in v1.33.0
type DeleteEksAnywhereSubscriptionInput struct { // The ID of the subscription. // // This member is required. Id *string // contains filtered or unexported fields }
type DeleteEksAnywhereSubscriptionOutput ¶ added in v1.33.0
type DeleteEksAnywhereSubscriptionOutput struct { // The full description of the subscription to be deleted. Subscription *types.EksAnywhereSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteFargateProfileOutput ¶
type DeleteFargateProfileOutput struct { // The deleted Fargate profile. FargateProfile *types.FargateProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteNodegroupInput ¶
type DeleteNodegroupOutput ¶
type DeleteNodegroupOutput struct { // The full description of your deleted node group. Nodegroup *types.Nodegroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePodIdentityAssociationInput ¶ added in v1.34.0
type DeletePodIdentityAssociationOutput ¶ added in v1.34.0
type DeletePodIdentityAssociationOutput struct { // The full description of the EKS Pod Identity association that was deleted. Association *types.PodIdentityAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeregisterClusterInput ¶ added in v1.10.0
type DeregisterClusterInput struct { // The name of the connected cluster to deregister. // // This member is required. Name *string // contains filtered or unexported fields }
type DeregisterClusterOutput ¶ added in v1.10.0
type DeregisterClusterOutput struct { // An object representing an Amazon EKS cluster. Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAccessEntryInput ¶ added in v1.36.0
type DescribeAccessEntryOutput ¶ added in v1.36.0
type DescribeAccessEntryOutput struct { // Information about the access entry. AccessEntry *types.AccessEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAddonAPIClient ¶ added in v0.31.0
type DescribeAddonAPIClient interface {
DescribeAddon(context.Context, *DescribeAddonInput, ...func(*Options)) (*DescribeAddonOutput, error)
}
DescribeAddonAPIClient is a client that implements the DescribeAddon operation.
type DescribeAddonConfigurationInput ¶ added in v1.25.0
type DescribeAddonConfigurationInput struct { // The name of the add-on. The name must match one of the names returned by // DescribeAddonVersions . // // This member is required. AddonName *string // The version of the add-on. The version must match one of the versions returned // by [DescribeAddonVersions]DescribeAddonVersions . // // [DescribeAddonVersions]: https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html // // This member is required. AddonVersion *string // contains filtered or unexported fields }
type DescribeAddonConfigurationOutput ¶ added in v1.25.0
type DescribeAddonConfigurationOutput struct { // The name of the add-on. AddonName *string // The version of the add-on. The version must match one of the versions returned // by [DescribeAddonVersions]DescribeAddonVersions . // // [DescribeAddonVersions]: https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html AddonVersion *string // A JSON schema that's used to validate the configuration values you provide when // an add-on is created or updated. ConfigurationSchema *string // The Kubernetes service account name used by the addon, and any suggested IAM // policies. Use this information to create an IAM Role for the Addon. PodIdentityConfiguration []types.AddonPodIdentityConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAddonInput ¶ added in v0.31.0
type DescribeAddonInput struct { // The name of the add-on. The name must match one of the names returned by [ListAddons] // ListAddons . // // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html // // This member is required. AddonName *string // The name of your cluster. // // This member is required. ClusterName *string // contains filtered or unexported fields }
type DescribeAddonOutput ¶ added in v0.31.0
type DescribeAddonOutput struct { // An Amazon EKS add-on. For more information, see [Amazon EKS add-ons] in the Amazon EKS User Guide. // // [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html Addon *types.Addon // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAddonVersionsAPIClient ¶ added in v0.31.0
type DescribeAddonVersionsAPIClient interface {
DescribeAddonVersions(context.Context, *DescribeAddonVersionsInput, ...func(*Options)) (*DescribeAddonVersionsOutput, error)
}
DescribeAddonVersionsAPIClient is a client that implements the DescribeAddonVersions operation.
type DescribeAddonVersionsInput ¶ added in v0.31.0
type DescribeAddonVersionsInput struct { // The name of the add-on. The name must match one of the names returned by [ListAddons] // ListAddons . // // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html AddonName *string // The Kubernetes versions that you can use the add-on with. KubernetesVersion *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // The owner of the add-on. For valid owners , don't specify a value for this // property. Owners []string // The publisher of the add-on. For valid publishers , don't specify a value for // this property. Publishers []string // The type of the add-on. For valid types , don't specify a value for this // property. Types []string // contains filtered or unexported fields }
type DescribeAddonVersionsOutput ¶ added in v0.31.0
type DescribeAddonVersionsOutput struct { // The list of available versions with Kubernetes version compatibility and other // properties. Addons []types.AddonInfo // The nextToken value to include in a future DescribeAddonVersions request. When // the results of a DescribeAddonVersions 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. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAddonVersionsPaginator ¶ added in v0.31.0
type DescribeAddonVersionsPaginator struct {
// contains filtered or unexported fields
}
DescribeAddonVersionsPaginator is a paginator for DescribeAddonVersions
func NewDescribeAddonVersionsPaginator ¶ added in v0.31.0
func NewDescribeAddonVersionsPaginator(client DescribeAddonVersionsAPIClient, params *DescribeAddonVersionsInput, optFns ...func(*DescribeAddonVersionsPaginatorOptions)) *DescribeAddonVersionsPaginator
NewDescribeAddonVersionsPaginator returns a new DescribeAddonVersionsPaginator
func (*DescribeAddonVersionsPaginator) HasMorePages ¶ added in v0.31.0
func (p *DescribeAddonVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAddonVersionsPaginator) NextPage ¶ added in v0.31.0
func (p *DescribeAddonVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAddonVersionsOutput, error)
NextPage retrieves the next DescribeAddonVersions page.
type DescribeAddonVersionsPaginatorOptions ¶ added in v0.31.0
type DescribeAddonVersionsPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAddonVersionsPaginatorOptions is the paginator options for DescribeAddonVersions
type DescribeClusterAPIClient ¶ added in v0.31.0
type DescribeClusterAPIClient interface {
DescribeCluster(context.Context, *DescribeClusterInput, ...func(*Options)) (*DescribeClusterOutput, error)
}
DescribeClusterAPIClient is a client that implements the DescribeCluster operation.
type DescribeClusterInput ¶
type DescribeClusterInput struct { // The name of your cluster. // // This member is required. Name *string // contains filtered or unexported fields }
type DescribeClusterOutput ¶
type DescribeClusterOutput struct { // The full description of your specified cluster. Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeEksAnywhereSubscriptionInput ¶ added in v1.33.0
type DescribeEksAnywhereSubscriptionInput struct { // The ID of the subscription. // // This member is required. Id *string // contains filtered or unexported fields }
type DescribeEksAnywhereSubscriptionOutput ¶ added in v1.33.0
type DescribeEksAnywhereSubscriptionOutput struct { // The full description of the subscription. Subscription *types.EksAnywhereSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeFargateProfileAPIClient ¶ added in v1.8.0
type DescribeFargateProfileAPIClient interface {
DescribeFargateProfile(context.Context, *DescribeFargateProfileInput, ...func(*Options)) (*DescribeFargateProfileOutput, error)
}
DescribeFargateProfileAPIClient is a client that implements the DescribeFargateProfile operation.
type DescribeFargateProfileOutput ¶
type DescribeFargateProfileOutput struct { // The full description of your Fargate profile. FargateProfile *types.FargateProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeIdentityProviderConfigInput ¶ added in v1.2.0
type DescribeIdentityProviderConfigInput struct { // The name of your cluster. // // This member is required. ClusterName *string // An object representing an identity provider configuration. // // This member is required. IdentityProviderConfig *types.IdentityProviderConfig // contains filtered or unexported fields }
type DescribeIdentityProviderConfigOutput ¶ added in v1.2.0
type DescribeIdentityProviderConfigOutput struct { // The object that represents an OpenID Connect (OIDC) identity provider // configuration. IdentityProviderConfig *types.IdentityProviderConfigResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeInsightInput ¶ added in v1.37.0
type DescribeInsightOutput ¶ added in v1.37.0
type DescribeInsightOutput struct { // The full description of the insight. Insight *types.Insight // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeNodegroupAPIClient ¶ added in v0.31.0
type DescribeNodegroupAPIClient interface {
DescribeNodegroup(context.Context, *DescribeNodegroupInput, ...func(*Options)) (*DescribeNodegroupOutput, error)
}
DescribeNodegroupAPIClient is a client that implements the DescribeNodegroup operation.
type DescribeNodegroupInput ¶
type DescribeNodegroupOutput ¶
type DescribeNodegroupOutput struct { // The full description of your node group. Nodegroup *types.Nodegroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribePodIdentityAssociationInput ¶ added in v1.34.0
type DescribePodIdentityAssociationInput struct { // The ID of the association that you want the description of. // // This member is required. AssociationId *string // The name of the cluster that the association is in. // // This member is required. ClusterName *string // contains filtered or unexported fields }
type DescribePodIdentityAssociationOutput ¶ added in v1.34.0
type DescribePodIdentityAssociationOutput struct { // The full description of the EKS Pod Identity association. Association *types.PodIdentityAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeUpdateInput ¶
type DescribeUpdateInput struct { // The name of the Amazon EKS cluster associated with the update. // // This member is required. Name *string // The ID of the update to describe. // // This member is required. UpdateId *string // The name of the add-on. The name must match one of the names returned by [ListAddons] // ListAddons . This parameter is required if the update is an add-on update. // // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html AddonName *string // The name of the Amazon EKS node group associated with the update. This // parameter is required if the update is a node group update. NodegroupName *string // contains filtered or unexported fields }
Describes an update request.
type DescribeUpdateOutput ¶
type DescribeUpdateOutput struct { // The full description of the specified update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateAccessPolicyInput ¶ added in v1.36.0
type DisassociateAccessPolicyInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The ARN of the policy to disassociate from the access entry. For a list of // associated policies ARNs, use ListAssociatedAccessPolicies . // // This member is required. PolicyArn *string // The ARN of the IAM principal for the AccessEntry . // // This member is required. PrincipalArn *string // contains filtered or unexported fields }
type DisassociateAccessPolicyOutput ¶ added in v1.36.0
type DisassociateAccessPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateIdentityProviderConfigInput ¶ added in v1.2.0
type DisassociateIdentityProviderConfigInput struct { // The name of your cluster. // // This member is required. ClusterName *string // An object representing an identity provider configuration. // // This member is required. IdentityProviderConfig *types.IdentityProviderConfig // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // contains filtered or unexported fields }
type DisassociateIdentityProviderConfigOutput ¶ added in v1.2.0
type DisassociateIdentityProviderConfigOutput struct { // An object representing an asynchronous update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.29.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.29.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.29.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.29.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.29.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type FargateProfileActiveWaiter ¶ added in v1.8.0
type FargateProfileActiveWaiter struct {
// contains filtered or unexported fields
}
FargateProfileActiveWaiter defines the waiters for FargateProfileActive
func NewFargateProfileActiveWaiter ¶ added in v1.8.0
func NewFargateProfileActiveWaiter(client DescribeFargateProfileAPIClient, optFns ...func(*FargateProfileActiveWaiterOptions)) *FargateProfileActiveWaiter
NewFargateProfileActiveWaiter constructs a FargateProfileActiveWaiter.
func (*FargateProfileActiveWaiter) Wait ¶ added in v1.8.0
func (w *FargateProfileActiveWaiter) Wait(ctx context.Context, params *DescribeFargateProfileInput, maxWaitDur time.Duration, optFns ...func(*FargateProfileActiveWaiterOptions)) error
Wait calls the waiter function for FargateProfileActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*FargateProfileActiveWaiter) WaitForOutput ¶ added in v1.13.0
func (w *FargateProfileActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeFargateProfileInput, maxWaitDur time.Duration, optFns ...func(*FargateProfileActiveWaiterOptions)) (*DescribeFargateProfileOutput, error)
WaitForOutput calls the waiter function for FargateProfileActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type FargateProfileActiveWaiterOptions ¶ added in v1.8.0
type FargateProfileActiveWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // FargateProfileActiveWaiter will use default minimum delay of 10 seconds. Note // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, FargateProfileActiveWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFargateProfileInput, *DescribeFargateProfileOutput, error) (bool, error) }
FargateProfileActiveWaiterOptions are waiter options for FargateProfileActiveWaiter
type FargateProfileDeletedWaiter ¶ added in v1.8.0
type FargateProfileDeletedWaiter struct {
// contains filtered or unexported fields
}
FargateProfileDeletedWaiter defines the waiters for FargateProfileDeleted
func NewFargateProfileDeletedWaiter ¶ added in v1.8.0
func NewFargateProfileDeletedWaiter(client DescribeFargateProfileAPIClient, optFns ...func(*FargateProfileDeletedWaiterOptions)) *FargateProfileDeletedWaiter
NewFargateProfileDeletedWaiter constructs a FargateProfileDeletedWaiter.
func (*FargateProfileDeletedWaiter) Wait ¶ added in v1.8.0
func (w *FargateProfileDeletedWaiter) Wait(ctx context.Context, params *DescribeFargateProfileInput, maxWaitDur time.Duration, optFns ...func(*FargateProfileDeletedWaiterOptions)) error
Wait calls the waiter function for FargateProfileDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*FargateProfileDeletedWaiter) WaitForOutput ¶ added in v1.13.0
func (w *FargateProfileDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeFargateProfileInput, maxWaitDur time.Duration, optFns ...func(*FargateProfileDeletedWaiterOptions)) (*DescribeFargateProfileOutput, error)
WaitForOutput calls the waiter function for FargateProfileDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type FargateProfileDeletedWaiterOptions ¶ added in v1.8.0
type FargateProfileDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // FargateProfileDeletedWaiter will use default minimum delay of 30 seconds. Note // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, FargateProfileDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFargateProfileInput, *DescribeFargateProfileOutput, error) (bool, error) }
FargateProfileDeletedWaiterOptions are waiter options for FargateProfileDeletedWaiter
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListAccessEntriesAPIClient ¶ added in v1.36.0
type ListAccessEntriesAPIClient interface {
ListAccessEntries(context.Context, *ListAccessEntriesInput, ...func(*Options)) (*ListAccessEntriesOutput, error)
}
ListAccessEntriesAPIClient is a client that implements the ListAccessEntries operation.
type ListAccessEntriesInput ¶ added in v1.36.0
type ListAccessEntriesInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The ARN of an AccessPolicy . When you specify an access policy ARN, only the // access entries associated to that access policy are returned. For a list of // available policy ARNs, use ListAccessPolicies . AssociatedPolicyArn *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListAccessEntriesOutput ¶ added in v1.36.0
type ListAccessEntriesOutput struct { // The list of access entries that exist for the cluster. AccessEntries []string // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAccessEntriesPaginator ¶ added in v1.36.0
type ListAccessEntriesPaginator struct {
// contains filtered or unexported fields
}
ListAccessEntriesPaginator is a paginator for ListAccessEntries
func NewListAccessEntriesPaginator ¶ added in v1.36.0
func NewListAccessEntriesPaginator(client ListAccessEntriesAPIClient, params *ListAccessEntriesInput, optFns ...func(*ListAccessEntriesPaginatorOptions)) *ListAccessEntriesPaginator
NewListAccessEntriesPaginator returns a new ListAccessEntriesPaginator
func (*ListAccessEntriesPaginator) HasMorePages ¶ added in v1.36.0
func (p *ListAccessEntriesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAccessEntriesPaginator) NextPage ¶ added in v1.36.0
func (p *ListAccessEntriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccessEntriesOutput, error)
NextPage retrieves the next ListAccessEntries page.
type ListAccessEntriesPaginatorOptions ¶ added in v1.36.0
type ListAccessEntriesPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAccessEntriesPaginatorOptions is the paginator options for ListAccessEntries
type ListAccessPoliciesAPIClient ¶ added in v1.36.0
type ListAccessPoliciesAPIClient interface {
ListAccessPolicies(context.Context, *ListAccessPoliciesInput, ...func(*Options)) (*ListAccessPoliciesOutput, error)
}
ListAccessPoliciesAPIClient is a client that implements the ListAccessPolicies operation.
type ListAccessPoliciesInput ¶ added in v1.36.0
type ListAccessPoliciesInput struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListAccessPoliciesOutput ¶ added in v1.36.0
type ListAccessPoliciesOutput struct { // The list of available access policies. You can't view the contents of an access // policy using the API. To view the contents, see [Access policy permissions]in the Amazon EKS User Guide. // // [Access policy permissions]: https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html#access-policy-permissions AccessPolicies []types.AccessPolicy // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAccessPoliciesPaginator ¶ added in v1.36.0
type ListAccessPoliciesPaginator struct {
// contains filtered or unexported fields
}
ListAccessPoliciesPaginator is a paginator for ListAccessPolicies
func NewListAccessPoliciesPaginator ¶ added in v1.36.0
func NewListAccessPoliciesPaginator(client ListAccessPoliciesAPIClient, params *ListAccessPoliciesInput, optFns ...func(*ListAccessPoliciesPaginatorOptions)) *ListAccessPoliciesPaginator
NewListAccessPoliciesPaginator returns a new ListAccessPoliciesPaginator
func (*ListAccessPoliciesPaginator) HasMorePages ¶ added in v1.36.0
func (p *ListAccessPoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAccessPoliciesPaginator) NextPage ¶ added in v1.36.0
func (p *ListAccessPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)
NextPage retrieves the next ListAccessPolicies page.
type ListAccessPoliciesPaginatorOptions ¶ added in v1.36.0
type ListAccessPoliciesPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAccessPoliciesPaginatorOptions is the paginator options for ListAccessPolicies
type ListAddonsAPIClient ¶ added in v0.31.0
type ListAddonsAPIClient interface {
ListAddons(context.Context, *ListAddonsInput, ...func(*Options)) (*ListAddonsOutput, error)
}
ListAddonsAPIClient is a client that implements the ListAddons operation.
type ListAddonsInput ¶ added in v0.31.0
type ListAddonsInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListAddonsOutput ¶ added in v0.31.0
type ListAddonsOutput struct { // A list of installed add-ons. Addons []string // The nextToken value to include in a future ListAddons request. When the results // of a ListAddons 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. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAddonsPaginator ¶ added in v0.31.0
type ListAddonsPaginator struct {
// contains filtered or unexported fields
}
ListAddonsPaginator is a paginator for ListAddons
func NewListAddonsPaginator ¶ added in v0.31.0
func NewListAddonsPaginator(client ListAddonsAPIClient, params *ListAddonsInput, optFns ...func(*ListAddonsPaginatorOptions)) *ListAddonsPaginator
NewListAddonsPaginator returns a new ListAddonsPaginator
func (*ListAddonsPaginator) HasMorePages ¶ added in v0.31.0
func (p *ListAddonsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAddonsPaginator) NextPage ¶ added in v0.31.0
func (p *ListAddonsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAddonsOutput, error)
NextPage retrieves the next ListAddons page.
type ListAddonsPaginatorOptions ¶ added in v0.31.0
type ListAddonsPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAddonsPaginatorOptions is the paginator options for ListAddons
type ListAssociatedAccessPoliciesAPIClient ¶ added in v1.36.0
type ListAssociatedAccessPoliciesAPIClient interface {
ListAssociatedAccessPolicies(context.Context, *ListAssociatedAccessPoliciesInput, ...func(*Options)) (*ListAssociatedAccessPoliciesOutput, error)
}
ListAssociatedAccessPoliciesAPIClient is a client that implements the ListAssociatedAccessPolicies operation.
type ListAssociatedAccessPoliciesInput ¶ added in v1.36.0
type ListAssociatedAccessPoliciesInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The ARN of the IAM principal for the AccessEntry . // // This member is required. PrincipalArn *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListAssociatedAccessPoliciesOutput ¶ added in v1.36.0
type ListAssociatedAccessPoliciesOutput struct { // The list of access policies associated with the access entry. AssociatedAccessPolicies []types.AssociatedAccessPolicy // The name of your cluster. ClusterName *string // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // The ARN of the IAM principal for the AccessEntry . PrincipalArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAssociatedAccessPoliciesPaginator ¶ added in v1.36.0
type ListAssociatedAccessPoliciesPaginator struct {
// contains filtered or unexported fields
}
ListAssociatedAccessPoliciesPaginator is a paginator for ListAssociatedAccessPolicies
func NewListAssociatedAccessPoliciesPaginator ¶ added in v1.36.0
func NewListAssociatedAccessPoliciesPaginator(client ListAssociatedAccessPoliciesAPIClient, params *ListAssociatedAccessPoliciesInput, optFns ...func(*ListAssociatedAccessPoliciesPaginatorOptions)) *ListAssociatedAccessPoliciesPaginator
NewListAssociatedAccessPoliciesPaginator returns a new ListAssociatedAccessPoliciesPaginator
func (*ListAssociatedAccessPoliciesPaginator) HasMorePages ¶ added in v1.36.0
func (p *ListAssociatedAccessPoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssociatedAccessPoliciesPaginator) NextPage ¶ added in v1.36.0
func (p *ListAssociatedAccessPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssociatedAccessPoliciesOutput, error)
NextPage retrieves the next ListAssociatedAccessPolicies page.
type ListAssociatedAccessPoliciesPaginatorOptions ¶ added in v1.36.0
type ListAssociatedAccessPoliciesPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAssociatedAccessPoliciesPaginatorOptions is the paginator options for ListAssociatedAccessPolicies
type ListClustersAPIClient ¶ added in v0.30.0
type ListClustersAPIClient interface {
ListClusters(context.Context, *ListClustersInput, ...func(*Options)) (*ListClustersOutput, error)
}
ListClustersAPIClient is a client that implements the ListClusters operation.
type ListClustersInput ¶
type ListClustersInput struct { // Indicates whether external clusters are included in the returned list. Use ' all // ' to return [https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html]connected clusters, or blank to return only Amazon EKS clusters. ' // all ' must be in lowercase otherwise an error occurs. // // [https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html]: https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html Include []string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListClustersOutput ¶
type ListClustersOutput struct { // A list of all of the clusters for your account in the specified Amazon Web // Services Region. Clusters []string // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListClustersPaginator ¶ added in v0.30.0
type ListClustersPaginator struct {
// contains filtered or unexported fields
}
ListClustersPaginator is a paginator for ListClusters
func NewListClustersPaginator ¶ added in v0.30.0
func NewListClustersPaginator(client ListClustersAPIClient, params *ListClustersInput, optFns ...func(*ListClustersPaginatorOptions)) *ListClustersPaginator
NewListClustersPaginator returns a new ListClustersPaginator
func (*ListClustersPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListClustersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListClustersPaginator) NextPage ¶ added in v0.30.0
func (p *ListClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListClustersOutput, error)
NextPage retrieves the next ListClusters page.
type ListClustersPaginatorOptions ¶ added in v0.30.0
type ListClustersPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListClustersPaginatorOptions is the paginator options for ListClusters
type ListEksAnywhereSubscriptionsAPIClient ¶ added in v1.34.0
type ListEksAnywhereSubscriptionsAPIClient interface {
ListEksAnywhereSubscriptions(context.Context, *ListEksAnywhereSubscriptionsInput, ...func(*Options)) (*ListEksAnywhereSubscriptionsOutput, error)
}
ListEksAnywhereSubscriptionsAPIClient is a client that implements the ListEksAnywhereSubscriptions operation.
type ListEksAnywhereSubscriptionsInput ¶ added in v1.33.0
type ListEksAnywhereSubscriptionsInput struct { // An array of subscription statuses to filter on. IncludeStatus []types.EksAnywhereSubscriptionStatus // The maximum number of cluster results returned by ListEksAnywhereSubscriptions // in paginated output. When you use this parameter, ListEksAnywhereSubscriptions // 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 ListEksAnywhereSubscriptions request with the returned nextToken value. // This value can be between 1 and 100. If you don't use this parameter, // ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if // applicable. MaxResults *int32 // The nextToken value returned from a previous paginated // ListEksAnywhereSubscriptions 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 // contains filtered or unexported fields }
type ListEksAnywhereSubscriptionsOutput ¶ added in v1.33.0
type ListEksAnywhereSubscriptionsOutput struct { // The nextToken value to include in a future ListEksAnywhereSubscriptions // request. When the results of a ListEksAnywhereSubscriptions 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 // A list of all subscription objects in the region, filtered by includeStatus and // paginated by nextToken and maxResults. Subscriptions []types.EksAnywhereSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListEksAnywhereSubscriptionsPaginator ¶ added in v1.34.0
type ListEksAnywhereSubscriptionsPaginator struct {
// contains filtered or unexported fields
}
ListEksAnywhereSubscriptionsPaginator is a paginator for ListEksAnywhereSubscriptions
func NewListEksAnywhereSubscriptionsPaginator ¶ added in v1.34.0
func NewListEksAnywhereSubscriptionsPaginator(client ListEksAnywhereSubscriptionsAPIClient, params *ListEksAnywhereSubscriptionsInput, optFns ...func(*ListEksAnywhereSubscriptionsPaginatorOptions)) *ListEksAnywhereSubscriptionsPaginator
NewListEksAnywhereSubscriptionsPaginator returns a new ListEksAnywhereSubscriptionsPaginator
func (*ListEksAnywhereSubscriptionsPaginator) HasMorePages ¶ added in v1.34.0
func (p *ListEksAnywhereSubscriptionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEksAnywhereSubscriptionsPaginator) NextPage ¶ added in v1.34.0
func (p *ListEksAnywhereSubscriptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEksAnywhereSubscriptionsOutput, error)
NextPage retrieves the next ListEksAnywhereSubscriptions page.
type ListEksAnywhereSubscriptionsPaginatorOptions ¶ added in v1.34.0
type ListEksAnywhereSubscriptionsPaginatorOptions struct { // The maximum number of cluster results returned by ListEksAnywhereSubscriptions // in paginated output. When you use this parameter, ListEksAnywhereSubscriptions // 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 ListEksAnywhereSubscriptions request with the returned nextToken value. // This value can be between 1 and 100. If you don't use this parameter, // ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if // applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListEksAnywhereSubscriptionsPaginatorOptions is the paginator options for ListEksAnywhereSubscriptions
type ListFargateProfilesAPIClient ¶ added in v0.30.0
type ListFargateProfilesAPIClient interface {
ListFargateProfiles(context.Context, *ListFargateProfilesInput, ...func(*Options)) (*ListFargateProfilesOutput, error)
}
ListFargateProfilesAPIClient is a client that implements the ListFargateProfiles operation.
type ListFargateProfilesInput ¶
type ListFargateProfilesInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListFargateProfilesOutput ¶
type ListFargateProfilesOutput struct { // A list of all of the Fargate profiles associated with the specified cluster. FargateProfileNames []string // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListFargateProfilesPaginator ¶ added in v0.30.0
type ListFargateProfilesPaginator struct {
// contains filtered or unexported fields
}
ListFargateProfilesPaginator is a paginator for ListFargateProfiles
func NewListFargateProfilesPaginator ¶ added in v0.30.0
func NewListFargateProfilesPaginator(client ListFargateProfilesAPIClient, params *ListFargateProfilesInput, optFns ...func(*ListFargateProfilesPaginatorOptions)) *ListFargateProfilesPaginator
NewListFargateProfilesPaginator returns a new ListFargateProfilesPaginator
func (*ListFargateProfilesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListFargateProfilesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFargateProfilesPaginator) NextPage ¶ added in v0.30.0
func (p *ListFargateProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFargateProfilesOutput, error)
NextPage retrieves the next ListFargateProfiles page.
type ListFargateProfilesPaginatorOptions ¶ added in v0.30.0
type ListFargateProfilesPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListFargateProfilesPaginatorOptions is the paginator options for ListFargateProfiles
type ListIdentityProviderConfigsAPIClient ¶ added in v1.2.0
type ListIdentityProviderConfigsAPIClient interface {
ListIdentityProviderConfigs(context.Context, *ListIdentityProviderConfigsInput, ...func(*Options)) (*ListIdentityProviderConfigsOutput, error)
}
ListIdentityProviderConfigsAPIClient is a client that implements the ListIdentityProviderConfigs operation.
type ListIdentityProviderConfigsInput ¶ added in v1.2.0
type ListIdentityProviderConfigsInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListIdentityProviderConfigsOutput ¶ added in v1.2.0
type ListIdentityProviderConfigsOutput struct { // The identity provider configurations for the cluster. IdentityProviderConfigs []types.IdentityProviderConfig // The nextToken value to include in a future ListIdentityProviderConfigsResponse // request. When the results of a ListIdentityProviderConfigsResponse 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. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListIdentityProviderConfigsPaginator ¶ added in v1.2.0
type ListIdentityProviderConfigsPaginator struct {
// contains filtered or unexported fields
}
ListIdentityProviderConfigsPaginator is a paginator for ListIdentityProviderConfigs
func NewListIdentityProviderConfigsPaginator ¶ added in v1.2.0
func NewListIdentityProviderConfigsPaginator(client ListIdentityProviderConfigsAPIClient, params *ListIdentityProviderConfigsInput, optFns ...func(*ListIdentityProviderConfigsPaginatorOptions)) *ListIdentityProviderConfigsPaginator
NewListIdentityProviderConfigsPaginator returns a new ListIdentityProviderConfigsPaginator
func (*ListIdentityProviderConfigsPaginator) HasMorePages ¶ added in v1.2.0
func (p *ListIdentityProviderConfigsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListIdentityProviderConfigsPaginator) NextPage ¶ added in v1.2.0
func (p *ListIdentityProviderConfigsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIdentityProviderConfigsOutput, error)
NextPage retrieves the next ListIdentityProviderConfigs page.
type ListIdentityProviderConfigsPaginatorOptions ¶ added in v1.2.0
type ListIdentityProviderConfigsPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListIdentityProviderConfigsPaginatorOptions is the paginator options for ListIdentityProviderConfigs
type ListInsightsAPIClient ¶ added in v1.37.0
type ListInsightsAPIClient interface {
ListInsights(context.Context, *ListInsightsInput, ...func(*Options)) (*ListInsightsOutput, error)
}
ListInsightsAPIClient is a client that implements the ListInsights operation.
type ListInsightsInput ¶ added in v1.37.0
type ListInsightsInput struct { // The name of the Amazon EKS cluster associated with the insights. // // This member is required. ClusterName *string // The criteria to filter your list of insights for your cluster. You can filter // which insights are returned by category, associated Kubernetes version, and // status. Filter *types.InsightsFilter // The maximum number of identity provider configurations returned by ListInsights // in paginated output. When you use this parameter, ListInsights 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 // ListInsights request with the returned nextToken value. This value can be // between 1 and 100. If you don't use this parameter, ListInsights returns up to // 100 results and a nextToken value, if applicable. MaxResults *int32 // The nextToken value returned from a previous paginated ListInsights request. // When the results of a ListInsights 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 // contains filtered or unexported fields }
type ListInsightsOutput ¶ added in v1.37.0
type ListInsightsOutput struct { // The returned list of insights. Insights []types.InsightSummary // The nextToken value to include in a future ListInsights request. When the // results of a ListInsights 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListInsightsPaginator ¶ added in v1.37.0
type ListInsightsPaginator struct {
// contains filtered or unexported fields
}
ListInsightsPaginator is a paginator for ListInsights
func NewListInsightsPaginator ¶ added in v1.37.0
func NewListInsightsPaginator(client ListInsightsAPIClient, params *ListInsightsInput, optFns ...func(*ListInsightsPaginatorOptions)) *ListInsightsPaginator
NewListInsightsPaginator returns a new ListInsightsPaginator
func (*ListInsightsPaginator) HasMorePages ¶ added in v1.37.0
func (p *ListInsightsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListInsightsPaginator) NextPage ¶ added in v1.37.0
func (p *ListInsightsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInsightsOutput, error)
NextPage retrieves the next ListInsights page.
type ListInsightsPaginatorOptions ¶ added in v1.37.0
type ListInsightsPaginatorOptions struct { // The maximum number of identity provider configurations returned by ListInsights // in paginated output. When you use this parameter, ListInsights 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 // ListInsights request with the returned nextToken value. This value can be // between 1 and 100. If you don't use this parameter, ListInsights returns up to // 100 results and a nextToken value, if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListInsightsPaginatorOptions is the paginator options for ListInsights
type ListNodegroupsAPIClient ¶ added in v0.30.0
type ListNodegroupsAPIClient interface {
ListNodegroups(context.Context, *ListNodegroupsInput, ...func(*Options)) (*ListNodegroupsOutput, error)
}
ListNodegroupsAPIClient is a client that implements the ListNodegroups operation.
type ListNodegroupsInput ¶
type ListNodegroupsInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // contains filtered or unexported fields }
type ListNodegroupsOutput ¶
type ListNodegroupsOutput struct { // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // A list of all of the node groups associated with the specified cluster. Nodegroups []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListNodegroupsPaginator ¶ added in v0.30.0
type ListNodegroupsPaginator struct {
// contains filtered or unexported fields
}
ListNodegroupsPaginator is a paginator for ListNodegroups
func NewListNodegroupsPaginator ¶ added in v0.30.0
func NewListNodegroupsPaginator(client ListNodegroupsAPIClient, params *ListNodegroupsInput, optFns ...func(*ListNodegroupsPaginatorOptions)) *ListNodegroupsPaginator
NewListNodegroupsPaginator returns a new ListNodegroupsPaginator
func (*ListNodegroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListNodegroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListNodegroupsPaginator) NextPage ¶ added in v0.30.0
func (p *ListNodegroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNodegroupsOutput, error)
NextPage retrieves the next ListNodegroups page.
type ListNodegroupsPaginatorOptions ¶ added in v0.30.0
type ListNodegroupsPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListNodegroupsPaginatorOptions is the paginator options for ListNodegroups
type ListPodIdentityAssociationsAPIClient ¶ added in v1.34.0
type ListPodIdentityAssociationsAPIClient interface {
ListPodIdentityAssociations(context.Context, *ListPodIdentityAssociationsInput, ...func(*Options)) (*ListPodIdentityAssociationsOutput, error)
}
ListPodIdentityAssociationsAPIClient is a client that implements the ListPodIdentityAssociations operation.
type ListPodIdentityAssociationsInput ¶ added in v1.34.0
type ListPodIdentityAssociationsInput struct { // The name of the cluster that the associations are in. // // This member is required. ClusterName *string // The maximum number of EKS Pod Identity association results returned by // ListPodIdentityAssociations in paginated output. When you use this parameter, // ListPodIdentityAssociations 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 ListPodIdentityAssociations request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, ListPodIdentityAssociations returns up to 100 results and a // nextToken value if applicable. MaxResults *int32 // The name of the Kubernetes namespace inside the cluster that the associations // are in. Namespace *string // 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. // // 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 // The name of the Kubernetes service account that the associations use. ServiceAccount *string // contains filtered or unexported fields }
type ListPodIdentityAssociationsOutput ¶ added in v1.34.0
type ListPodIdentityAssociationsOutput struct { // The list of summarized descriptions of the associations that are in the cluster // and match any filters that you provided. // // Each summary is simplified by removing these fields compared to the full PodIdentityAssociation: // // - The IAM role: roleArn // // - The timestamp that the association was created at: createdAt // // - The most recent timestamp that the association was modified at:. modifiedAt // // - The tags on the association: tags Associations []types.PodIdentityAssociationSummary // The nextToken value to include in a future ListPodIdentityAssociations request. // When the results of a ListPodIdentityAssociations 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. // // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPodIdentityAssociationsPaginator ¶ added in v1.34.0
type ListPodIdentityAssociationsPaginator struct {
// contains filtered or unexported fields
}
ListPodIdentityAssociationsPaginator is a paginator for ListPodIdentityAssociations
func NewListPodIdentityAssociationsPaginator ¶ added in v1.34.0
func NewListPodIdentityAssociationsPaginator(client ListPodIdentityAssociationsAPIClient, params *ListPodIdentityAssociationsInput, optFns ...func(*ListPodIdentityAssociationsPaginatorOptions)) *ListPodIdentityAssociationsPaginator
NewListPodIdentityAssociationsPaginator returns a new ListPodIdentityAssociationsPaginator
func (*ListPodIdentityAssociationsPaginator) HasMorePages ¶ added in v1.34.0
func (p *ListPodIdentityAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPodIdentityAssociationsPaginator) NextPage ¶ added in v1.34.0
func (p *ListPodIdentityAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPodIdentityAssociationsOutput, error)
NextPage retrieves the next ListPodIdentityAssociations page.
type ListPodIdentityAssociationsPaginatorOptions ¶ added in v1.34.0
type ListPodIdentityAssociationsPaginatorOptions struct { // The maximum number of EKS Pod Identity association results returned by // ListPodIdentityAssociations in paginated output. When you use this parameter, // ListPodIdentityAssociations 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 ListPodIdentityAssociations request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, ListPodIdentityAssociations returns up to 100 results and a // nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPodIdentityAssociationsPaginatorOptions is the paginator options for ListPodIdentityAssociations
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) that identifies the resource to list tags for. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags for the resource. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListUpdatesAPIClient ¶ added in v0.30.0
type ListUpdatesAPIClient interface {
ListUpdates(context.Context, *ListUpdatesInput, ...func(*Options)) (*ListUpdatesOutput, error)
}
ListUpdatesAPIClient is a client that implements the ListUpdates operation.
type ListUpdatesInput ¶
type ListUpdatesInput struct { // The name of the Amazon EKS cluster to list updates for. // // This member is required. Name *string // The names of the installed add-ons that have available updates. AddonName *string // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. MaxResults *int32 // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // The name of the Amazon EKS managed node group to list updates for. NodegroupName *string // contains filtered or unexported fields }
type ListUpdatesOutput ¶
type ListUpdatesOutput struct { // The nextToken value returned from a previous paginated 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 value is null when there are no more results to return. // // 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 // A list of all the updates for the specified cluster and Region. UpdateIds []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListUpdatesPaginator ¶ added in v0.30.0
type ListUpdatesPaginator struct {
// contains filtered or unexported fields
}
ListUpdatesPaginator is a paginator for ListUpdates
func NewListUpdatesPaginator ¶ added in v0.30.0
func NewListUpdatesPaginator(client ListUpdatesAPIClient, params *ListUpdatesInput, optFns ...func(*ListUpdatesPaginatorOptions)) *ListUpdatesPaginator
NewListUpdatesPaginator returns a new ListUpdatesPaginator
func (*ListUpdatesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListUpdatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListUpdatesPaginator) NextPage ¶ added in v0.30.0
func (p *ListUpdatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUpdatesOutput, error)
NextPage retrieves the next ListUpdates page.
type ListUpdatesPaginatorOptions ¶ added in v0.30.0
type ListUpdatesPaginatorOptions struct { // The maximum number of results, returned in paginated output. You receive // maxResults in a single page, along with a nextToken response element. You can // see the remaining results of the initial request by sending another request with // the returned nextToken value. This value can be between 1 and 100. If you don't // use this parameter, 100 results and a nextToken value, if applicable, are // returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListUpdatesPaginatorOptions is the paginator options for ListUpdates
type NodegroupActiveWaiter ¶ added in v0.31.0
type NodegroupActiveWaiter struct {
// contains filtered or unexported fields
}
NodegroupActiveWaiter defines the waiters for NodegroupActive
func NewNodegroupActiveWaiter ¶ added in v0.31.0
func NewNodegroupActiveWaiter(client DescribeNodegroupAPIClient, optFns ...func(*NodegroupActiveWaiterOptions)) *NodegroupActiveWaiter
NewNodegroupActiveWaiter constructs a NodegroupActiveWaiter.
func (*NodegroupActiveWaiter) Wait ¶ added in v0.31.0
func (w *NodegroupActiveWaiter) Wait(ctx context.Context, params *DescribeNodegroupInput, maxWaitDur time.Duration, optFns ...func(*NodegroupActiveWaiterOptions)) error
Wait calls the waiter function for NodegroupActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*NodegroupActiveWaiter) WaitForOutput ¶ added in v1.13.0
func (w *NodegroupActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeNodegroupInput, maxWaitDur time.Duration, optFns ...func(*NodegroupActiveWaiterOptions)) (*DescribeNodegroupOutput, error)
WaitForOutput calls the waiter function for NodegroupActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type NodegroupActiveWaiterOptions ¶ added in v0.31.0
type NodegroupActiveWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // NodegroupActiveWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, NodegroupActiveWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNodegroupInput, *DescribeNodegroupOutput, error) (bool, error) }
NodegroupActiveWaiterOptions are waiter options for NodegroupActiveWaiter
type NodegroupDeletedWaiter ¶ added in v0.31.0
type NodegroupDeletedWaiter struct {
// contains filtered or unexported fields
}
NodegroupDeletedWaiter defines the waiters for NodegroupDeleted
func NewNodegroupDeletedWaiter ¶ added in v0.31.0
func NewNodegroupDeletedWaiter(client DescribeNodegroupAPIClient, optFns ...func(*NodegroupDeletedWaiterOptions)) *NodegroupDeletedWaiter
NewNodegroupDeletedWaiter constructs a NodegroupDeletedWaiter.
func (*NodegroupDeletedWaiter) Wait ¶ added in v0.31.0
func (w *NodegroupDeletedWaiter) Wait(ctx context.Context, params *DescribeNodegroupInput, maxWaitDur time.Duration, optFns ...func(*NodegroupDeletedWaiterOptions)) error
Wait calls the waiter function for NodegroupDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*NodegroupDeletedWaiter) WaitForOutput ¶ added in v1.13.0
func (w *NodegroupDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeNodegroupInput, maxWaitDur time.Duration, optFns ...func(*NodegroupDeletedWaiterOptions)) (*DescribeNodegroupOutput, error)
WaitForOutput calls the waiter function for NodegroupDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type NodegroupDeletedWaiterOptions ¶ added in v0.31.0
type NodegroupDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // NodegroupDeletedWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, NodegroupDeletedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNodegroupInput, *DescribeNodegroupOutput, error) (bool, error) }
NodegroupDeletedWaiterOptions are waiter options for NodegroupDeletedWaiter
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The client tracer provider. TracerProvider tracing.TracerProvider // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) GetIdentityResolver ¶ added in v1.33.1
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type RegisterClusterInput ¶ added in v1.10.0
type RegisterClusterInput struct { // The configuration settings required to connect the Kubernetes cluster to the // Amazon EKS control plane. // // This member is required. ConnectorConfig *types.ConnectorConfigRequest // A unique name for this cluster in your Amazon Web Services Region. // // This member is required. Name *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. Tags map[string]string // contains filtered or unexported fields }
type RegisterClusterOutput ¶ added in v1.10.0
type RegisterClusterOutput struct { // An object representing an Amazon EKS cluster. Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to add tags to. // // This member is required. ResourceArn *string // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any // other cluster or Amazon Web Services resources. // // This member is required. Tags map[string]string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAccessEntryInput ¶ added in v1.36.0
type UpdateAccessEntryInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The ARN of the IAM principal for the AccessEntry . // // This member is required. PrincipalArn *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The value for name that you've specified for kind: Group as a subject in a // Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't confirm // that the value for name exists in any bindings on your cluster. You can specify // one or more names. // // Kubernetes authorizes the principalArn of the access entry to access any // cluster objects that you've specified in a Kubernetes Role or ClusterRole // object that is also specified in a binding's roleRef . For more information // about creating Kubernetes RoleBinding , ClusterRoleBinding , Role , or // ClusterRole objects, see [Using RBAC Authorization in the Kubernetes documentation]. // // If you want Amazon EKS to authorize the principalArn (instead of, or in // addition to Kubernetes authorizing the principalArn ), you can associate one or // more access policies to the access entry using AssociateAccessPolicy . If you // associate any access policies, the principalARN has all permissions assigned in // the associated access policies and all permissions in any Kubernetes Role or // ClusterRole objects that the group names are bound to. // // [Using RBAC Authorization in the Kubernetes documentation]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ KubernetesGroups []string // The username to authenticate to Kubernetes with. We recommend not specifying a // username and letting Amazon EKS specify it for you. For more information about // the value Amazon EKS specifies for you, or constraints before specifying your // own username, see [Creating access entries]in the Amazon EKS User Guide. // // [Creating access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries Username *string // contains filtered or unexported fields }
type UpdateAccessEntryOutput ¶ added in v1.36.0
type UpdateAccessEntryOutput struct { // The ARN of the IAM principal for the AccessEntry . AccessEntry *types.AccessEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAddonInput ¶ added in v0.31.0
type UpdateAddonInput struct { // The name of the add-on. The name must match one of the names returned by [ListAddons] // ListAddons . // // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html // // This member is required. AddonName *string // The name of your cluster. // // This member is required. ClusterName *string // The version of the add-on. The version must match one of the versions returned // by [DescribeAddonVersions]DescribeAddonVersions . // // [DescribeAddonVersions]: https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html AddonVersion *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The set of configuration values for the add-on that's created. The values that // you provide are validated against the schema returned by // DescribeAddonConfiguration . ConfigurationValues *string // An array of Pod Identity Assocations to be updated. Each EKS Pod Identity // association maps a Kubernetes service account to an IAM Role. If this value is // left blank, no change. If an empty array is provided, existing Pod Identity // Assocations owned by the Addon are deleted. // // For more information, see [Attach an IAM Role to an Amazon EKS add-on using Pod Identity] in the EKS User Guide. // // [Attach an IAM Role to an Amazon EKS add-on using Pod Identity]: https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html PodIdentityAssociations []types.AddonPodIdentityAssociations // How to resolve field value conflicts for an Amazon EKS add-on if you've changed // a value from the Amazon EKS default value. Conflicts are handled based on the // option you choose: // // - None – Amazon EKS doesn't change the value. The update might fail. // // - Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS // default value. // // - Preserve – Amazon EKS preserves the value. If you choose this option, we // recommend that you test any field and value changes on a non-production cluster // before updating the add-on on your production cluster. ResolveConflicts types.ResolveConflicts // The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's // service account. The role must be assigned the IAM permissions required by the // add-on. If you don't specify an existing IAM role, then the add-on uses the // permissions assigned to the node IAM role. For more information, see [Amazon EKS node IAM role]in the // Amazon EKS User Guide. // // To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) // provider created for your cluster. For more information, see [Enabling IAM roles for service accounts on your cluster]in the Amazon EKS // User Guide. // // [Enabling IAM roles for service accounts on your cluster]: https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html // [Amazon EKS node IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html ServiceAccountRoleArn *string // contains filtered or unexported fields }
type UpdateAddonOutput ¶ added in v0.31.0
type UpdateAddonOutput struct { // An object representing an asynchronous update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateClusterConfigInput ¶
type UpdateClusterConfigInput struct { // The name of the Amazon EKS cluster to update. // // This member is required. Name *string // The access configuration for the cluster. AccessConfig *types.UpdateAccessConfigRequest // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // 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]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 [CloudWatch Pricing]. // // [CloudWatch Pricing]: http://aws.amazon.com/cloudwatch/pricing/ // [Amazon EKS cluster control plane logs]: https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html Logging *types.Logging // An object representing the VPC configuration to use for an Amazon EKS cluster. ResourcesVpcConfig *types.VpcConfigRequest // You can enable or disable extended support for clusters currently on standard // support. You cannot disable extended support once it starts. You must enable // extended support before your cluster exits standard support. UpgradePolicy *types.UpgradePolicyRequest // Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, // Amazon Web Services configures zonal autoshift for the cluster. // // Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC // zonal shift is designed to be a temporary measure that allows you to move // traffic for a resource away from an impaired AZ until the zonal shift expires or // you cancel it. You can extend the zonal shift if necessary. // // You can start a zonal shift for an EKS cluster, or you can allow Amazon Web // Services to do it for you by enabling zonal autoshift. This shift updates the // flow of east-to-west network traffic in your cluster to only consider network // endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB // or NLB handling ingress traffic for applications in your EKS cluster will // automatically route traffic to targets in the healthy AZs. For more information // about zonal shift in EKS, see [Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS]in the Amazon EKS User Guide . // // [Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS]: https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html ZonalShiftConfig *types.ZonalShiftConfigRequest // contains filtered or unexported fields }
type UpdateClusterConfigOutput ¶
type UpdateClusterConfigOutput struct { // An object representing an asynchronous update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateClusterVersionInput ¶
type UpdateClusterVersionInput struct { // The name of the Amazon EKS cluster to update. // // This member is required. Name *string // The desired Kubernetes version following a successful update. // // This member is required. Version *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // contains filtered or unexported fields }
type UpdateClusterVersionOutput ¶
type UpdateClusterVersionOutput struct { // The full description of the specified update Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateEksAnywhereSubscriptionInput ¶ added in v1.33.0
type UpdateEksAnywhereSubscriptionInput struct { // A boolean indicating whether or not to automatically renew the subscription. // // This member is required. AutoRenew bool // The ID of the subscription. // // This member is required. Id *string // Unique, case-sensitive identifier to ensure the idempotency of the request. ClientRequestToken *string // contains filtered or unexported fields }
type UpdateEksAnywhereSubscriptionOutput ¶ added in v1.33.0
type UpdateEksAnywhereSubscriptionOutput struct { // The full description of the updated subscription. Subscription *types.EksAnywhereSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateNodegroupConfigInput ¶
type UpdateNodegroupConfigInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The name of the managed node group to update. // // This member is required. NodegroupName *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The Kubernetes labels to apply to the nodes in the node group after the update. Labels *types.UpdateLabelsPayload // The scaling configuration details for the Auto Scaling group after the update. ScalingConfig *types.NodegroupScalingConfig // The Kubernetes taints to be applied to the nodes in the node group after the // update. For more information, see [Node taints on managed node groups]. // // [Node taints on managed node groups]: https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html Taints *types.UpdateTaintsPayload // The node group update configuration. UpdateConfig *types.NodegroupUpdateConfig // contains filtered or unexported fields }
type UpdateNodegroupConfigOutput ¶
type UpdateNodegroupConfigOutput struct { // An object representing an asynchronous update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateNodegroupVersionInput ¶
type UpdateNodegroupVersionInput struct { // The name of your cluster. // // This member is required. ClusterName *string // The name of the managed node group to update. // // This member is required. NodegroupName *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // Force the update if any Pod on the existing node group can't be drained due to // a Pod disruption budget issue. If an update fails because all Pods can't be // drained, you can force the update after it fails to terminate the old node // whether or not any Pod is running on the node. Force bool // An object representing a node group's launch template specification. You can // only update a node group using a launch template if the node group was // originally deployed with a launch template. LaunchTemplate *types.LaunchTemplateSpecification // 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 information about Linux versions, see [Amazon EKS optimized Amazon Linux AMI versions]in the Amazon EKS // User Guide. Amazon EKS managed node groups support the November 2022 and later // releases of the Windows AMIs. For information about Windows versions, see [Amazon EKS optimized Windows AMI versions]in // the Amazon EKS User Guide. // // If you specify launchTemplate , and your launch template uses a custom AMI, then // don't specify releaseVersion , or the node group update will fail. For more // information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates]in the Amazon EKS // User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html // [Amazon EKS optimized Amazon Linux AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html // [Amazon EKS optimized Windows AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html ReleaseVersion *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. If you specify launchTemplate , and // your launch template uses a custom AMI, then don't specify version , or the node // group update will fail. For more information about using launch templates with // Amazon EKS, see [Customizing managed nodes with launch templates]in the Amazon EKS User Guide. // // [Customizing managed nodes with launch templates]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html Version *string // contains filtered or unexported fields }
type UpdateNodegroupVersionOutput ¶
type UpdateNodegroupVersionOutput struct { // An object representing an asynchronous update. Update *types.Update // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdatePodIdentityAssociationInput ¶ added in v1.34.0
type UpdatePodIdentityAssociationInput struct { // The ID of the association to be updated. // // This member is required. AssociationId *string // The name of the cluster that you want to update the association in. // // This member is required. ClusterName *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string // The new IAM role to change the RoleArn *string // contains filtered or unexported fields }
type UpdatePodIdentityAssociationOutput ¶ added in v1.34.0
type UpdatePodIdentityAssociationOutput struct { // The full description of the EKS Pod Identity association that was updated. Association *types.PodIdentityAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_AssociateAccessPolicy.go
- api_op_AssociateEncryptionConfig.go
- api_op_AssociateIdentityProviderConfig.go
- api_op_CreateAccessEntry.go
- api_op_CreateAddon.go
- api_op_CreateCluster.go
- api_op_CreateEksAnywhereSubscription.go
- api_op_CreateFargateProfile.go
- api_op_CreateNodegroup.go
- api_op_CreatePodIdentityAssociation.go
- api_op_DeleteAccessEntry.go
- api_op_DeleteAddon.go
- api_op_DeleteCluster.go
- api_op_DeleteEksAnywhereSubscription.go
- api_op_DeleteFargateProfile.go
- api_op_DeleteNodegroup.go
- api_op_DeletePodIdentityAssociation.go
- api_op_DeregisterCluster.go
- api_op_DescribeAccessEntry.go
- api_op_DescribeAddon.go
- api_op_DescribeAddonConfiguration.go
- api_op_DescribeAddonVersions.go
- api_op_DescribeCluster.go
- api_op_DescribeEksAnywhereSubscription.go
- api_op_DescribeFargateProfile.go
- api_op_DescribeIdentityProviderConfig.go
- api_op_DescribeInsight.go
- api_op_DescribeNodegroup.go
- api_op_DescribePodIdentityAssociation.go
- api_op_DescribeUpdate.go
- api_op_DisassociateAccessPolicy.go
- api_op_DisassociateIdentityProviderConfig.go
- api_op_ListAccessEntries.go
- api_op_ListAccessPolicies.go
- api_op_ListAddons.go
- api_op_ListAssociatedAccessPolicies.go
- api_op_ListClusters.go
- api_op_ListEksAnywhereSubscriptions.go
- api_op_ListFargateProfiles.go
- api_op_ListIdentityProviderConfigs.go
- api_op_ListInsights.go
- api_op_ListNodegroups.go
- api_op_ListPodIdentityAssociations.go
- api_op_ListTagsForResource.go
- api_op_ListUpdates.go
- api_op_RegisterCluster.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAccessEntry.go
- api_op_UpdateAddon.go
- api_op_UpdateClusterConfig.go
- api_op_UpdateClusterVersion.go
- api_op_UpdateEksAnywhereSubscription.go
- api_op_UpdateNodegroupConfig.go
- api_op_UpdateNodegroupVersion.go
- api_op_UpdatePodIdentityAssociation.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go