Skip to content

Type definitions#

Index > EKS > Type definitions

Auto-generated documentation for EKS type annotations stubs module mypy-boto3-eks.

AddonIssueTypeDef#

# AddonIssueTypeDef definition

class AddonIssueTypeDef(TypedDict):
    code: NotRequired[AddonIssueCodeType],  # (1)
    message: NotRequired[str],
    resourceIds: NotRequired[List[str]],
  1. See AddonIssueCodeType

MarketplaceInformationTypeDef#

# MarketplaceInformationTypeDef definition

class MarketplaceInformationTypeDef(TypedDict):
    productId: NotRequired[str],
    productUrl: NotRequired[str],

CompatibilityTypeDef#

# CompatibilityTypeDef definition

class CompatibilityTypeDef(TypedDict):
    clusterVersion: NotRequired[str],
    platformVersions: NotRequired[List[str]],
    defaultVersion: NotRequired[bool],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

OidcIdentityProviderConfigRequestTypeDef#

# OidcIdentityProviderConfigRequestTypeDef definition

class OidcIdentityProviderConfigRequestTypeDef(TypedDict):
    identityProviderConfigName: str,
    issuerUrl: str,
    clientId: str,
    usernameClaim: NotRequired[str],
    usernamePrefix: NotRequired[str],
    groupsClaim: NotRequired[str],
    groupsPrefix: NotRequired[str],
    requiredClaims: NotRequired[Mapping[str, str]],

AutoScalingGroupTypeDef#

# AutoScalingGroupTypeDef definition

class AutoScalingGroupTypeDef(TypedDict):
    name: NotRequired[str],

CertificateTypeDef#

# CertificateTypeDef definition

class CertificateTypeDef(TypedDict):
    data: NotRequired[str],

ClusterIssueTypeDef#

# ClusterIssueTypeDef definition

class ClusterIssueTypeDef(TypedDict):
    code: NotRequired[ClusterIssueCodeType],  # (1)
    message: NotRequired[str],
    resourceIds: NotRequired[List[str]],
  1. See ClusterIssueCodeType

ConnectorConfigResponseTypeDef#

# ConnectorConfigResponseTypeDef definition

class ConnectorConfigResponseTypeDef(TypedDict):
    activationId: NotRequired[str],
    activationCode: NotRequired[str],
    activationExpiry: NotRequired[datetime],
    provider: NotRequired[str],
    roleArn: NotRequired[str],

KubernetesNetworkConfigResponseTypeDef#

# KubernetesNetworkConfigResponseTypeDef definition

class KubernetesNetworkConfigResponseTypeDef(TypedDict):
    serviceIpv4Cidr: NotRequired[str],
    serviceIpv6Cidr: NotRequired[str],
    ipFamily: NotRequired[IpFamilyType],  # (1)
  1. See IpFamilyType

VpcConfigResponseTypeDef#

# VpcConfigResponseTypeDef definition

class VpcConfigResponseTypeDef(TypedDict):
    subnetIds: NotRequired[List[str]],
    securityGroupIds: NotRequired[List[str]],
    clusterSecurityGroupId: NotRequired[str],
    vpcId: NotRequired[str],
    endpointPublicAccess: NotRequired[bool],
    endpointPrivateAccess: NotRequired[bool],
    publicAccessCidrs: NotRequired[List[str]],

ConnectorConfigRequestTypeDef#

# ConnectorConfigRequestTypeDef definition

class ConnectorConfigRequestTypeDef(TypedDict):
    roleArn: str,
    provider: ConnectorConfigProviderType,  # (1)
  1. See ConnectorConfigProviderType

ControlPlanePlacementRequestTypeDef#

# ControlPlanePlacementRequestTypeDef definition

class ControlPlanePlacementRequestTypeDef(TypedDict):
    groupName: NotRequired[str],

ControlPlanePlacementResponseTypeDef#

# ControlPlanePlacementResponseTypeDef definition

class ControlPlanePlacementResponseTypeDef(TypedDict):
    groupName: NotRequired[str],

CreateAddonRequestRequestTypeDef#

# CreateAddonRequestRequestTypeDef definition

class CreateAddonRequestRequestTypeDef(TypedDict):
    clusterName: str,
    addonName: str,
    addonVersion: NotRequired[str],
    serviceAccountRoleArn: NotRequired[str],
    resolveConflicts: NotRequired[ResolveConflictsType],  # (1)
    clientRequestToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    configurationValues: NotRequired[str],
  1. See ResolveConflictsType

KubernetesNetworkConfigRequestTypeDef#

# KubernetesNetworkConfigRequestTypeDef definition

class KubernetesNetworkConfigRequestTypeDef(TypedDict):
    serviceIpv4Cidr: NotRequired[str],
    ipFamily: NotRequired[IpFamilyType],  # (1)
  1. See IpFamilyType

VpcConfigRequestTypeDef#

# VpcConfigRequestTypeDef definition

class VpcConfigRequestTypeDef(TypedDict):
    subnetIds: NotRequired[Sequence[str]],
    securityGroupIds: NotRequired[Sequence[str]],
    endpointPublicAccess: NotRequired[bool],
    endpointPrivateAccess: NotRequired[bool],
    publicAccessCidrs: NotRequired[Sequence[str]],

EksAnywhereSubscriptionTermTypeDef#

# EksAnywhereSubscriptionTermTypeDef definition

class EksAnywhereSubscriptionTermTypeDef(TypedDict):
    duration: NotRequired[int],
    unit: NotRequired[EksAnywhereSubscriptionTermUnitType],  # (1)
  1. See EksAnywhereSubscriptionTermUnitType

FargateProfileSelectorTypeDef#

# FargateProfileSelectorTypeDef definition

class FargateProfileSelectorTypeDef(TypedDict):
    namespace: NotRequired[str],
    labels: NotRequired[Mapping[str, str]],

LaunchTemplateSpecificationTypeDef#

# LaunchTemplateSpecificationTypeDef definition

class LaunchTemplateSpecificationTypeDef(TypedDict):
    name: NotRequired[str],
    version: NotRequired[str],
    id: NotRequired[str],

NodegroupScalingConfigTypeDef#

# NodegroupScalingConfigTypeDef definition

class NodegroupScalingConfigTypeDef(TypedDict):
    minSize: NotRequired[int],
    maxSize: NotRequired[int],
    desiredSize: NotRequired[int],

NodegroupUpdateConfigTypeDef#

# NodegroupUpdateConfigTypeDef definition

class NodegroupUpdateConfigTypeDef(TypedDict):
    maxUnavailable: NotRequired[int],
    maxUnavailablePercentage: NotRequired[int],

RemoteAccessConfigTypeDef#

# RemoteAccessConfigTypeDef definition

class RemoteAccessConfigTypeDef(TypedDict):
    ec2SshKey: NotRequired[str],
    sourceSecurityGroups: NotRequired[Sequence[str]],

TaintTypeDef#

# TaintTypeDef definition

class TaintTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[str],
    effect: NotRequired[TaintEffectType],  # (1)
  1. See TaintEffectType

CreatePodIdentityAssociationRequestRequestTypeDef#

# CreatePodIdentityAssociationRequestRequestTypeDef definition

class CreatePodIdentityAssociationRequestRequestTypeDef(TypedDict):
    clusterName: str,
    namespace: str,
    serviceAccount: str,
    roleArn: str,
    clientRequestToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

PodIdentityAssociationTypeDef#

# PodIdentityAssociationTypeDef definition

class PodIdentityAssociationTypeDef(TypedDict):
    clusterName: NotRequired[str],
    namespace: NotRequired[str],
    serviceAccount: NotRequired[str],
    roleArn: NotRequired[str],
    associationArn: NotRequired[str],
    associationId: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    createdAt: NotRequired[datetime],
    modifiedAt: NotRequired[datetime],

DeleteAddonRequestRequestTypeDef#

# DeleteAddonRequestRequestTypeDef definition

class DeleteAddonRequestRequestTypeDef(TypedDict):
    clusterName: str,
    addonName: str,
    preserve: NotRequired[bool],

DeleteClusterRequestRequestTypeDef#

# DeleteClusterRequestRequestTypeDef definition

class DeleteClusterRequestRequestTypeDef(TypedDict):
    name: str,

DeleteEksAnywhereSubscriptionRequestRequestTypeDef#

# DeleteEksAnywhereSubscriptionRequestRequestTypeDef definition

class DeleteEksAnywhereSubscriptionRequestRequestTypeDef(TypedDict):
    id: str,

DeleteFargateProfileRequestRequestTypeDef#

# DeleteFargateProfileRequestRequestTypeDef definition

class DeleteFargateProfileRequestRequestTypeDef(TypedDict):
    clusterName: str,
    fargateProfileName: str,

DeleteNodegroupRequestRequestTypeDef#

# DeleteNodegroupRequestRequestTypeDef definition

class DeleteNodegroupRequestRequestTypeDef(TypedDict):
    clusterName: str,
    nodegroupName: str,

DeletePodIdentityAssociationRequestRequestTypeDef#

# DeletePodIdentityAssociationRequestRequestTypeDef definition

class DeletePodIdentityAssociationRequestRequestTypeDef(TypedDict):
    clusterName: str,
    associationId: str,

DeregisterClusterRequestRequestTypeDef#

# DeregisterClusterRequestRequestTypeDef definition

class DeregisterClusterRequestRequestTypeDef(TypedDict):
    name: str,

DescribeAddonConfigurationRequestRequestTypeDef#

# DescribeAddonConfigurationRequestRequestTypeDef definition

class DescribeAddonConfigurationRequestRequestTypeDef(TypedDict):
    addonName: str,
    addonVersion: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeAddonRequestRequestTypeDef#

# DescribeAddonRequestRequestTypeDef definition

class DescribeAddonRequestRequestTypeDef(TypedDict):
    clusterName: str,
    addonName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeAddonVersionsRequestRequestTypeDef#

# DescribeAddonVersionsRequestRequestTypeDef definition

class DescribeAddonVersionsRequestRequestTypeDef(TypedDict):
    kubernetesVersion: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    addonName: NotRequired[str],
    types: NotRequired[Sequence[str]],
    publishers: NotRequired[Sequence[str]],
    owners: NotRequired[Sequence[str]],

DescribeClusterRequestRequestTypeDef#

# DescribeClusterRequestRequestTypeDef definition

class DescribeClusterRequestRequestTypeDef(TypedDict):
    name: str,

DescribeEksAnywhereSubscriptionRequestRequestTypeDef#

# DescribeEksAnywhereSubscriptionRequestRequestTypeDef definition

class DescribeEksAnywhereSubscriptionRequestRequestTypeDef(TypedDict):
    id: str,

DescribeFargateProfileRequestRequestTypeDef#

# DescribeFargateProfileRequestRequestTypeDef definition

class DescribeFargateProfileRequestRequestTypeDef(TypedDict):
    clusterName: str,
    fargateProfileName: str,

IdentityProviderConfigTypeDef#

# IdentityProviderConfigTypeDef definition

class IdentityProviderConfigTypeDef(TypedDict):
    type: str,
    name: str,

DescribeNodegroupRequestRequestTypeDef#

# DescribeNodegroupRequestRequestTypeDef definition

class DescribeNodegroupRequestRequestTypeDef(TypedDict):
    clusterName: str,
    nodegroupName: str,

DescribePodIdentityAssociationRequestRequestTypeDef#

# DescribePodIdentityAssociationRequestRequestTypeDef definition

class DescribePodIdentityAssociationRequestRequestTypeDef(TypedDict):
    clusterName: str,
    associationId: str,

DescribeUpdateRequestRequestTypeDef#

# DescribeUpdateRequestRequestTypeDef definition

class DescribeUpdateRequestRequestTypeDef(TypedDict):
    name: str,
    updateId: str,
    nodegroupName: NotRequired[str],
    addonName: NotRequired[str],

ProviderTypeDef#

# ProviderTypeDef definition

class ProviderTypeDef(TypedDict):
    keyArn: NotRequired[str],

ErrorDetailTypeDef#

# ErrorDetailTypeDef definition

class ErrorDetailTypeDef(TypedDict):
    errorCode: NotRequired[ErrorCodeType],  # (1)
    errorMessage: NotRequired[str],
    resourceIds: NotRequired[List[str]],
  1. See ErrorCodeType

OidcIdentityProviderConfigTypeDef#

# OidcIdentityProviderConfigTypeDef definition

class OidcIdentityProviderConfigTypeDef(TypedDict):
    identityProviderConfigName: NotRequired[str],
    identityProviderConfigArn: NotRequired[str],
    clusterName: NotRequired[str],
    issuerUrl: NotRequired[str],
    clientId: NotRequired[str],
    usernameClaim: NotRequired[str],
    usernamePrefix: NotRequired[str],
    groupsClaim: NotRequired[str],
    groupsPrefix: NotRequired[str],
    requiredClaims: NotRequired[Dict[str, str]],
    tags: NotRequired[Dict[str, str]],
    status: NotRequired[configStatusType],  # (1)
  1. See configStatusType

OIDCTypeDef#

# OIDCTypeDef definition

class OIDCTypeDef(TypedDict):
    issuer: NotRequired[str],

IssueTypeDef#

# IssueTypeDef definition

class IssueTypeDef(TypedDict):
    code: NotRequired[NodegroupIssueCodeType],  # (1)
    message: NotRequired[str],
    resourceIds: NotRequired[List[str]],
  1. See NodegroupIssueCodeType

ListAddonsRequestRequestTypeDef#

# ListAddonsRequestR