Skip to content

Commit 5b42130

Browse files
author
awstools
committed
feat(client-eks): Introduce versionStatus field to take place of status field in EKS DescribeClusterVersions API
1 parent 5f0e21d commit 5b42130

File tree

8 files changed

+117
-25
lines changed

8 files changed

+117
-25
lines changed

Diff for: clients/client-eks/src/commands/DescribeClusterVersionsCommand.ts

+2
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ export interface DescribeClusterVersionsCommandOutput extends DescribeClusterVer
4545
* "STRING_VALUE",
4646
* ],
4747
* status: "unsupported" || "standard-support" || "extended-support",
48+
* versionStatus: "UNSUPPORTED" || "STANDARD_SUPPORT" || "EXTENDED_SUPPORT",
4849
* };
4950
* const command = new DescribeClusterVersionsCommand(input);
5051
* const response = await client.send(command);
@@ -60,6 +61,7 @@ export interface DescribeClusterVersionsCommandOutput extends DescribeClusterVer
6061
* // endOfStandardSupportDate: new Date("TIMESTAMP"),
6162
* // endOfExtendedSupportDate: new Date("TIMESTAMP"),
6263
* // status: "unsupported" || "standard-support" || "extended-support",
64+
* // versionStatus: "UNSUPPORTED" || "STANDARD_SUPPORT" || "EXTENDED_SUPPORT",
6365
* // kubernetesPatchVersion: "STRING_VALUE",
6466
* // },
6567
* // ],

Diff for: clients/client-eks/src/commands/DescribeUpdateCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface DescribeUpdateCommandOutput extends DescribeUpdateResponse, __M
2929

3030
/**
3131
* <p>Describes an update to an Amazon EKS resource.</p>
32-
* <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an
32+
* <p>When the status of the update is <code>Successful</code>, the update is complete. If an
3333
* update fails, the status is <code>Failed</code>, and an error detail explains the reason
3434
* for the failure.</p>
3535
* @example

Diff for: clients/client-eks/src/commands/RegisterClusterCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export interface RegisterClusterCommandOutput extends RegisterClusterResponse, _
3131
* <p>Connects a Kubernetes cluster to the Amazon EKS control plane. </p>
3232
* <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to view
3333
* current information about the cluster and its nodes. </p>
34-
* <p>Cluster connection requires two steps. First, send a <code>
35-
* <a>RegisterClusterRequest</a>
36-
* </code> to add it to the Amazon EKS
34+
* <p>Cluster connection requires two steps. First, send a <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_RegisterClusterRequest.html">
35+
* <code>RegisterClusterRequest</code>
36+
* </a> to add it to the Amazon EKS
3737
* control plane.</p>
3838
* <p>Second, a <a href="https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml">Manifest</a> containing the <code>activationID</code> and
3939
* <code>activationCode</code> must be applied to the Kubernetes cluster through it's native

Diff for: clients/client-eks/src/commands/UpdateClusterVersionCommand.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ export interface UpdateClusterVersionCommandOutput extends UpdateClusterVersionR
3030
/**
3131
* <p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster
3232
* continues to function during the update. The response output includes an update ID that
33-
* you can use to track the status of your cluster update with the <a>DescribeUpdate</a> API operation.</p>
33+
* you can use to track the status of your cluster update with the
34+
* <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html">
35+
* <code>DescribeUpdate</code>
36+
* </a> API operation.</p>
3437
* <p>Cluster updates are asynchronous, and they should finish within a few minutes. During
3538
* an update, the cluster status moves to <code>UPDATING</code> (this status transition is
3639
* eventually consistent). When the update is complete (either <code>Failed</code> or

Diff for: clients/client-eks/src/commands/UpdateNodegroupConfigCommand.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ export interface UpdateNodegroupConfigCommandOutput extends UpdateNodegroupConfi
3030
/**
3131
* <p>Updates an Amazon EKS managed node group configuration. Your node group
3232
* continues to function during the update. The response output includes an update ID that
33-
* you can use to track the status of your node group update with the <a>DescribeUpdate</a> API operation. You can update the Kubernetes labels and taints
33+
* you can use to track the status of your node group update with the
34+
* <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html">
35+
* <code>DescribeUpdate</code>
36+
* </a> API operation. You can update the Kubernetes labels and taints
3437
* for a node group and the scaling and version update configuration.</p>
3538
* @example
3639
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-eks/src/models/models_0.ts

+51-10
Original file line numberDiff line numberDiff line change
@@ -1671,7 +1671,9 @@ export interface CreateAddonRequest {
16711671
* option. If the self-managed version of the add-on is installed on your cluster
16721672
* Amazon EKS doesn't change the add-on resource properties. Creation
16731673
* of the add-on might fail if conflicts are detected. This option works
1674-
* differently during the update operation. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html">UpdateAddon</a>.</p>
1674+
* differently during the update operation. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html">
1675+
* <code>UpdateAddon</code>
1676+
* </a>.</p>
16751677
* </li>
16761678
* </ul>
16771679
* <p>If you don't currently have the self-managed version of the add-on installed on your
@@ -3794,7 +3796,9 @@ export interface NodegroupUpdateConfig {
37943796
/**
37953797
* <p>The configuration for the behavior to follow during a node group version update of this managed
37963798
* node group. You choose between two possible strategies for replacing nodes during an
3797-
* <a href="https://docs.aws.amazon.com/latest/APIReference/API_UpdateNodegroupVersion.html">UpdateNodegroupVersion</a> action.</p>
3799+
* <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateNodegroupVersion.html">
3800+
* <code>UpdateNodegroupVersion</code>
3801+
* </a> action.</p>
37983802
* <p>An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI
37993803
* versions in parallel. The <i>update strategy</i> changes the managed node
38003804
* update behavior of the managed node group for each quantity. The
@@ -5058,6 +5062,21 @@ export const ClusterVersionStatus = {
50585062
*/
50595063
export type ClusterVersionStatus = (typeof ClusterVersionStatus)[keyof typeof ClusterVersionStatus];
50605064

5065+
/**
5066+
* @public
5067+
* @enum
5068+
*/
5069+
export const VersionStatus = {
5070+
EXTENDED_SUPPORT: "EXTENDED_SUPPORT",
5071+
STANDARD_SUPPORT: "STANDARD_SUPPORT",
5072+
UNSUPPORTED: "UNSUPPORTED",
5073+
} as const;
5074+
5075+
/**
5076+
* @public
5077+
*/
5078+
export type VersionStatus = (typeof VersionStatus)[keyof typeof VersionStatus];
5079+
50615080
/**
50625081
* @public
50635082
*/
@@ -5099,10 +5118,22 @@ export interface DescribeClusterVersionsRequest {
50995118
clusterVersions?: string[] | undefined;
51005119

51015120
/**
5102-
* <p>Filter versions by their current status.</p>
5121+
* <important>
5122+
* <p>This field is deprecated. Use <code>versionStatus</code> instead, as that field
5123+
* matches for input and output of this action.</p>
5124+
* </important>
5125+
* <p>Filter versions by their current status.</p>
5126+
*
5127+
* @deprecated
51035128
* @public
51045129
*/
51055130
status?: ClusterVersionStatus | undefined;
5131+
5132+
/**
5133+
* <p>Filter versions by their current status.</p>
5134+
* @public
5135+
*/
5136+
versionStatus?: VersionStatus | undefined;
51065137
}
51075138

51085139
/**
@@ -5153,11 +5184,21 @@ export interface ClusterVersionInformation {
51535184
endOfExtendedSupportDate?: Date | undefined;
51545185

51555186
/**
5156-
* <p>Current status of this cluster version.</p>
5187+
* <important>
5188+
* <p>This field is deprecated. Use <code>versionStatus</code> instead, as that field
5189+
* matches for input and output of this action.</p>
5190+
* </important>
5191+
* <p>Current status of this cluster version.</p>
51575192
* @public
51585193
*/
51595194
status?: ClusterVersionStatus | undefined;
51605195

5196+
/**
5197+
* <p>Current status of this cluster version.</p>
5198+
* @public
5199+
*/
5200+
versionStatus?: VersionStatus | undefined;
5201+
51615202
/**
51625203
* <p>The patch version of Kubernetes for this cluster version.</p>
51635204
* @public
@@ -6589,9 +6630,9 @@ export interface ListPodIdentityAssociationsRequest {
65896630

65906631
/**
65916632
* <p>The summarized description of the association.</p>
6592-
* <p>Each summary is simplified by removing these fields compared to the full <code>
6593-
* <a>PodIdentityAssociation</a>
6594-
* </code>:</p>
6633+
* <p>Each summary is simplified by removing these fields compared to the full <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html">
6634+
* <code>PodIdentityAssociation</code>
6635+
* </a>:</p>
65956636
* <ul>
65966637
* <li>
65976638
* <p>The IAM role: <code>roleArn</code>
@@ -6660,9 +6701,9 @@ export interface ListPodIdentityAssociationsResponse {
66606701
/**
66616702
* <p>The list of summarized descriptions of the associations that are in the cluster and match
66626703
* any filters that you provided.</p>
6663-
* <p>Each summary is simplified by removing these fields compared to the full <code>
6664-
* <a>PodIdentityAssociation</a>
6665-
* </code>:</p>
6704+
* <p>Each summary is simplified by removing these fields compared to the full <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html">
6705+
* <code>PodIdentityAssociation</code>
6706+
* </a>:</p>
66666707
* <ul>
66676708
* <li>
66686709
* <p>The IAM role: <code>roleArn</code>

Diff for: clients/client-eks/src/protocols/Aws_restJson1.ts

+3
Original file line numberDiff line numberDiff line change
@@ -787,6 +787,7 @@ export const se_DescribeClusterVersionsCommand = async (
787787
[_iA]: [() => input.includeAll !== void 0, () => input[_iA]!.toString()],
788788
[_cV]: [() => input.clusterVersions !== void 0, () => input[_cV]! || []],
789789
[_s]: [, input[_s]!],
790+
[_vS]: [, input[_vS]!],
790791
});
791792
let body: any;
792793
b.m("GET").h(headers).q(query).b(body);
@@ -3337,6 +3338,7 @@ const de_ClusterVersionInformation = (output: any, context: __SerdeContext): Clu
33373338
kubernetesPatchVersion: __expectString,
33383339
releaseDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
33393340
status: __expectString,
3341+
versionStatus: __expectString,
33403342
}) as any;
33413343
};
33423344

@@ -3717,3 +3719,4 @@ const _s = "status";
37173719
const _sA = "serviceAccount";
37183720
const _t = "types";
37193721
const _tK = "tagKeys";
3722+
const _vS = "versionStatus";

0 commit comments

Comments
 (0)