Amazon Elastic Kubernetes Service 2017-11-01

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Parameter Syntax

$result = $client->createCluster([
    'clientRequestToken' => '<string>',
    'encryptionConfig' => [
        [
            'provider' => [
                'keyArn' => '<string>',
            ],
            'resources' => ['<string>', ...],
        ],
        // ...
    ],
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [ // REQUIRED
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'publicAccessCidrs' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'version' => '<string>',
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Errors

• ResourceInUseException:

  The specified resource is in use.

• ResourceLimitExceededException:

  You have encountered a service limit on the specified resource.

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

• UnsupportedAvailabilityZoneException:

  At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

Examples

Example 1: To create a new cluster

The following example creates an Amazon EKS cluster called prod.

$result = $client->createCluster([
    'version' => '1.10',
    'name' => 'prod',
    'clientRequestToken' => '1d2129a1-3d38-460a-9756-e5b91fddb951',
    'resourcesVpcConfig' => [
        'securityGroupIds' => [
            'sg-6979fe18',
        ],
        'subnetIds' => [
            'subnet-6782e71e',
            'subnet-e7e761ac',
        ],
    ],
    'roleArn' => 'arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI',
]);

Result syntax:

[
]

CreateFargateProfile

$result = $client->createFargateProfile([/* ... */]);
$promise = $client->createFargateProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->createFargateProfile([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
    'podExecutionRoleArn' => '<string>', // REQUIRED
    'selectors' => [
        [
            'labels' => ['<string>', ...],
            'namespace' => '<string>',
        ],
        // ...
    ],
    'subnets' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• InvalidRequestException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceLimitExceededException:

  You have encountered a service limit on the specified resource.

• UnsupportedAvailabilityZoneException:

  At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

CreateNodegroup

$result = $client->createNodegroup([/* ... */]);
$promise = $client->createNodegroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createNodegroup([
    'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'diskSize' => <integer>,
    'instanceTypes' => ['<string>', ...],
    'labels' => ['<string>', ...],
    'launchTemplate' => [
        'id' => '<string>',
        'name' => '<string>',
        'version' => '<string>',
    ],
    'nodeRole' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
    'releaseVersion' => '<string>',
    'remoteAccess' => [
        'ec2SshKey' => '<string>',
        'sourceSecurityGroups' => ['<string>', ...],
    ],
    'scalingConfig' => [
        'desiredSize' => <integer>,
        'maxSize' => <integer>,
        'minSize' => <integer>,
    ],
    'subnets' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'version' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|AutoScalingGroupInvalidConfiguration|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|Ec2SubnetNotFound|Ec2SubnetInvalidConfiguration|IamInstanceProfileNotFound|IamLimitExceeded|IamNodeRoleNotFound|NodeCreationFailure|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Errors

• ResourceInUseException:

  The specified resource is in use.

• ResourceLimitExceededException:

  You have encountered a service limit on the specified resource.

• InvalidRequestException:

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

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteCluster([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Errors

• ResourceInUseException:

  The specified resource is in use.

• ResourceNotFoundException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

Examples

Example 1: To delete a cluster

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

$result = $client->deleteCluster([
    'name' => 'devel',
]);

Result syntax:

[
]

DeleteFargateProfile

$result = $client->deleteFargateProfile([/* ... */]);
$promise = $client->deleteFargateProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteFargateProfile([
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceNotFoundException:

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

DeleteNodegroup

$result = $client->deleteNodegroup([/* ... */]);
$promise = $client->deleteNodegroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteNodegroup([
    'clusterName' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|AutoScalingGroupInvalidConfiguration|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|Ec2SubnetNotFound|Ec2SubnetInvalidConfiguration|IamInstanceProfileNotFound|IamLimitExceeded|IamNodeRoleNotFound|NodeCreationFailure|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Errors

• ResourceInUseException:

  The specified resource is in use.

• ResourceNotFoundException:

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

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

DescribeCluster

$result = $client->describeCluster([/* ... */]);
$promise = $client->describeClusterAsync([/* ... */]);

Parameter Syntax

$result = $client->describeCluster([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Errors

• ResourceNotFoundException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

Examples

Example 1: To describe a cluster

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

$result = $client->describeCluster([
    'name' => 'devel',
]);

Result syntax:

[
    'cluster' => [
        'version' => '1.10',
        'name' => 'devel',
        'arn' => 'arn:aws:eks:us-west-2:012345678910:cluster/devel',
        'certificateAuthority' => [
            'data' => 'LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=',
        ],
        'createdAt' => ,
        'endpoint' => 'https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com',
        'resourcesVpcConfig' => [
            'securityGroupIds' => [
                'sg-6979fe18',
            ],
            'subnetIds' => [
                'subnet-6782e71e',
                'subnet-e7e761ac',
            ],
            'vpcId' => 'vpc-950809ec',
        ],
        'roleArn' => 'arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI',
        'status' => 'ACTIVE',
    ],
]

DescribeFargateProfile

$result = $client->describeFargateProfile([/* ... */]);
$promise = $client->describeFargateProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->describeFargateProfile([
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceNotFoundException:

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

DescribeNodegroup

$result = $client->describeNodegroup([/* ... */]);
$promise = $client->describeNodegroupAsync([/* ... */]);

Parameter Syntax

$result = $client->describeNodegroup([
    'clusterName' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|AutoScalingGroupInvalidConfiguration|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|Ec2SubnetNotFound|Ec2SubnetInvalidConfiguration|IamInstanceProfileNotFound|IamLimitExceeded|IamNodeRoleNotFound|NodeCreationFailure|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ResourceNotFoundException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

DescribeUpdate

$result = $client->describeUpdate([/* ... */]);
$promise = $client->describeUpdateAsync([/* ... */]);

Parameter Syntax

$result = $client->describeUpdate([
    'name' => '<string>', // REQUIRED
    'nodegroupName' => '<string>',
    'updateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceNotFoundException:

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

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Parameter Syntax

$result = $client->listClusters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'clusters' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

Examples

Example 1: To list your available clusters

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

$result = $client->listClusters([
]);

Result syntax:

[
    'clusters' => [
        'devel',
        'prod',
    ],
]

ListFargateProfiles

$result = $client->listFargateProfiles([/* ... */]);
$promise = $client->listFargateProfilesAsync([/* ... */]);

Parameter Syntax

$result = $client->listFargateProfiles([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'fargateProfileNames' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

• InvalidParameterException:

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

• ResourceNotFoundException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

ListNodegroups

$result = $client->listNodegroups([/* ... */]);
$promise = $client->listNodegroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->listNodegroups([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'nodegroups' => ['<string>', ...],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ServiceUnavailableException:

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

• ResourceNotFoundException:

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

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

• BadRequestException:

  This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

• NotFoundException:

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

Examples

Example 1: To list tags for a cluster

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

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:eks:us-west-2:012345678910:cluster/beta',
]);

Result syntax:

[
    'tags' => [
        'aws:tag:domain' => 'beta',
    ],
]

ListUpdates

$result = $client->listUpdates([/* ... */]);
$promise = $client->listUpdatesAsync([/* ... */]);

Parameter Syntax

$result = $client->listUpdates([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'nodegroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'updateIds' => ['<string>', ...],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceNotFoundException:

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

• NotFoundException:

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

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

• NotFoundException:

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

UpdateClusterConfig

$result = $client->updateClusterConfig([/* ... */]);
$promise = $client->updateClusterConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->updateClusterConfig([
    'clientRequestToken' => '<string>',
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'publicAccessCidrs' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceInUseException:

  The specified resource is in use.

• ResourceNotFoundException:

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

• InvalidRequestException:

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

UpdateClusterVersion

$result = $client->updateClusterVersion([/* ... */]);
$promise = $client->updateClusterVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateClusterVersion([
    'clientRequestToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceInUseException:

  The specified resource is in use.

• ResourceNotFoundException:

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

• InvalidRequestException:

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

UpdateNodegroupConfig

$result = $client->updateNodegroupConfig([/* ... */]);
$promise = $client->updateNodegroupConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->updateNodegroupConfig([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'labels' => [
        'addOrUpdateLabels' => ['<string>', ...],
        'removeLabels' => ['<string>', ...],
    ],
    'nodegroupName' => '<string>', // REQUIRED
    'scalingConfig' => [
        'desiredSize' => <integer>,
        'maxSize' => <integer>,
        'minSize' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceInUseException:

  The specified resource is in use.

• ResourceNotFoundException:

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

• InvalidRequestException:

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

UpdateNodegroupVersion

$result = $client->updateNodegroupVersion([/* ... */]);
$promise = $client->updateNodegroupVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateNodegroupVersion([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'force' => true || false,
    'launchTemplate' => [
        'id' => '<string>',
        'name' => '<string>',
        'version' => '<string>',
    ],
    'nodegroupName' => '<string>', // REQUIRED
    'releaseVersion' => '<string>',
    'version' => '<string>',
]);

Parameter Details

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Errors

• InvalidParameterException:

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

• ClientException:

  These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

• ServerException:

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

• ResourceInUseException:

  The specified resource is in use.

• ResourceNotFoundException:

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

• InvalidRequestException:

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