@aws-sdk/client-eks 3.288.0 → 3.289.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist-types/commands/CreateClusterCommand.d.ts +23 -0
  2. package/dist-types/commands/DeleteClusterCommand.d.ts +11 -0
  3. package/dist-types/commands/DescribeClusterCommand.d.ts +37 -0
  4. package/dist-types/commands/ListClustersCommand.d.ts +17 -0
  5. package/dist-types/commands/ListTagsForResourceCommand.d.ts +18 -0
  6. package/package.json +30 -30
package/dist-types/commands/CreateClusterCommand.d.ts CHANGED
@@ -49,6 +49,29 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
49
49
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
50
50
  * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
51
51
  *
52
+ * @example To create a new cluster
53
+ * ```javascript
54
+ * // The following example creates an Amazon EKS cluster called prod.
55
+ * const input = {
56
+ * "version": "1.10",
57
+ * "name": "prod",
58
+ * "clientRequestToken": "1d2129a1-3d38-460a-9756-e5b91fddb951",
59
+ * "resourcesVpcConfig": {
60
+ * "securityGroupIds": [
61
+ * "sg-6979fe18"
62
+ * ],
63
+ * "subnetIds": [
64
+ * "subnet-6782e71e",
65
+ * "subnet-e7e761ac"
66
+ * ]
67
+ * },
68
+ * "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI"
69
+ * };
70
+ * const command = new CreateClusterCommand(input);
71
+ * await client.send(command);
72
+ * // example id: to-create-a-new-cluster-1527868185648
73
+ * ```
74
+ *
52
75
  */
53
76
  export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, EKSClientResolvedConfig> {
54
77
  readonly input: CreateClusterCommandInput;
package/dist-types/commands/DeleteClusterCommand.d.ts CHANGED
@@ -36,6 +36,17 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
36
36
  * @see {@link DeleteClusterCommandOutput} for command's `response` shape.
37
37
  * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
38
38
  *
39
+ * @example To delete a cluster
40
+ * ```javascript
41
+ * // This example command deletes a cluster named `devel` in your default region.
42
+ * const input = {
43
+ * "name": "devel"
44
+ * };
45
+ * const command = new DeleteClusterCommand(input);
46
+ * await client.send(command);
47
+ * // example id: to-delete-a-cluster-1527868641252
48
+ * ```
49
+ *
39
50
  */
40
51
  export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, EKSClientResolvedConfig> {
41
52
  readonly input: DeleteClusterCommandInput;
package/dist-types/commands/DescribeClusterCommand.d.ts CHANGED
@@ -37,6 +37,43 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _
37
37
  * @see {@link DescribeClusterCommandOutput} for command's `response` shape.
38
38
  * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
39
39
  *
40
+ * @example To describe a cluster
41
+ * ```javascript
42
+ * // This example command provides a description of the specified cluster in your default region.
43
+ * const input = {
44
+ * "name": "devel"
45
+ * };
46
+ * const command = new DescribeClusterCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "cluster": {
51
+ * "version": "1.10",
52
+ * "name": "devel",
53
+ * "arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel",
54
+ * "certificateAuthority": {
55
+ * "data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo="
56
+ * },
57
+ * "createdAt": 1527807879.988,
58
+ * "endpoint": "https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com",
59
+ * "resourcesVpcConfig": {
60
+ * "securityGroupIds": [
61
+ * "sg-6979fe18"
62
+ * ],
63
+ * "subnetIds": [
64
+ * "subnet-6782e71e",
65
+ * "subnet-e7e761ac"
66
+ * ],
67
+ * "vpcId": "vpc-950809ec"
68
+ * },
69
+ * "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI",
70
+ * "status": "ACTIVE"
71
+ * }
72
+ * }
73
+ * *\/
74
+ * // example id: to-describe-a-cluster-1527868708512
75
+ * ```
76
+ *
40
77
  */
41
78
  export declare class DescribeClusterCommand extends $Command<DescribeClusterCommandInput, DescribeClusterCommandOutput, EKSClientResolvedConfig> {
42
79
  readonly input: DescribeClusterCommandInput;
package/dist-types/commands/ListClustersCommand.d.ts CHANGED
@@ -30,6 +30,23 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad
30
30
  * @see {@link ListClustersCommandOutput} for command's `response` shape.
31
31
  * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
32
32
  *
33
+ * @example To list your available clusters
34
+ * ```javascript
35
+ * // This example command lists all of your available clusters in your default region.
36
+ * const input = {};
37
+ * const command = new ListClustersCommand(input);
38
+ * const response = await client.send(command);
39
+ * /* response ==
40
+ * {
41
+ * "clusters": [
42
+ * "devel",
43
+ * "prod"
44
+ * ]
45
+ * }
46
+ * *\/
47
+ * // example id: to-list-your-available-clusters-1527868801040
48
+ * ```
49
+ *
33
50
  */
34
51
  export declare class ListClustersCommand extends $Command<ListClustersCommandInput, ListClustersCommandOutput, EKSClientResolvedConfig> {
35
52
  readonly input: ListClustersCommandInput;
package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED
@@ -29,6 +29,24 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
29
29
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
30
  * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
31
31
  *
32
+ * @example To list tags for a cluster
33
+ * ```javascript
34
+ * // This example lists all of the tags for the `beta` cluster.
35
+ * const input = {
36
+ * "resourceArn": "arn:aws:eks:us-west-2:012345678910:cluster/beta"
37
+ * };
38
+ * const command = new ListTagsForResourceCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "tags": {
43
+ * "aws:tag:domain": "beta"
44
+ * }
45
+ * }
46
+ * *\/
47
+ * // example id: to-list-tags-for-a-cluster-1568666903378
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, EKSClientResolvedConfig> {
34
52
  readonly input: ListTagsForResourceCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-eks",
3
3
  "description": "AWS SDK for JavaScript Eks Client for Node.js, Browser and React Native",
4
- "version": "3.288.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
- "@aws-sdk/util-waiter": "3.272.0",
55
+ "@aws-sdk/util-waiter": "3.289.0",
56
56
  "tslib": "^2.3.1",
57
57
  "uuid": "^8.3.2"
58
58
  },