Skip to content

Commit

Permalink
docs(client-cloud9): Update to imageId parameter behavior and dates u…
Browse files Browse the repository at this point in the history 
…pdated.
  • Loading branch information
awstools committed Oct 18, 2023
1 parent dbac71a commit 37282cb
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 49 deletions.
44 changes: 23 additions & 21 deletions clients/client-cloud9/src/endpoint/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,27 @@ import { RuleSetObject } from "@smithy/types";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/cloud9.json */

const q="required",
r="fn",
s="argv",
t="ref";
const a="isSet",
b="tree",
c="error",
d="endpoint",
e="PartitionResult",
f={[q]:false,"type":"String"},
g={[q]:true,"default":false,"type":"Boolean"},
h={[t]:"Endpoint"},
i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
k={},
l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]},
m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]},
n=[i],
o=[j],
p=[{[t]:"Region"}];
const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]},{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{endpoint:{url:"https://cloud9-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://cloud9-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{endpoint:{url:"https://cloud9.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://cloud9.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
const s="required",
t="fn",
u="argv",
v="ref";
const a=true,
b="isSet",
c="booleanEquals",
d="error",
e="endpoint",
f="tree",
g="PartitionResult",
h={[s]:false,"type":"String"},
i={[s]:true,"default":false,"type":"Boolean"},
j={[v]:"Endpoint"},
k={[t]:c,[u]:[{[v]:"UseFIPS"},true]},
l={[t]:c,[u]:[{[v]:"UseDualStack"},true]},
m={},
n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]},
o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]},
p=[k],
q=[l],
r=[{[v]:"Region"}];
const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f},{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{endpoint:{url:"https://cloud9-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{endpoint:{url:"https://cloud9-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{endpoint:{url:"https://cloud9.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://cloud9.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]};
export const ruleSet: RuleSetObject = _data;
13 changes: 6 additions & 7 deletions clients/client-cloud9/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,13 +132,12 @@ export interface CreateEnvironmentEC2Request {
* <p>The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
* To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)
* path.</p>
* <p>The default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned
* a value in the request. Because Amazon Linux AMI has ended standard support as of December 31,
* 2020, we recommend you choose Amazon Linux 2, which includes long term support through
* 2023.</p>
* <p>From December 31, 2023, the parameter for Amazon Linux will no longer be available when
* you specify an AMI for your instance. Amazon Linux 2 will then become the default AMI, which
* is used to launch your instance if no parameter is explicitly defined.</p>
* <p>From November 20, 2023, you will be required to include the <code>imageId</code> parameter for the <code>CreateEnvironmentEC2</code> action.
* This change will be reflected across all direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only
* affect direct API consumers, and not Cloud9 console users.</p>
* <p>From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of
* maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the AMI to create your environment as it is
* fully supported. This change will only affect direct API consumers, and not Cloud9 console users.</p>
* <p>Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.</p>
* <p>
* <b>AMI aliases </b>
Expand Down
42 changes: 21 additions & 21 deletions codegen/sdk-codegen/aws-models/cloud9.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand Down Expand Up @@ -172,7 +171,8 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [
Expand All @@ -185,7 +185,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand All @@ -199,7 +198,6 @@
"assign": "PartitionResult"
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand All @@ -222,7 +220,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand Down Expand Up @@ -257,7 +254,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [],
Expand All @@ -268,14 +264,16 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [],
"error": "FIPS and DualStack are enabled, but this partition does not support one or both",
"type": "error"
}
]
],
"type": "tree"
},
{
"conditions": [
Expand All @@ -289,14 +287,12 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
true,
{
"fn": "getAttr",
"argv": [
Expand All @@ -305,11 +301,11 @@
},
"supportsFIPS"
]
}
},
true
]
}
],
"type": "tree",
"rules": [
{
"conditions": [],
Expand All @@ -320,14 +316,16 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [],
"error": "FIPS is enabled but this partition does not support FIPS",
"type": "error"
}
]
],
"type": "tree"
},
{
"conditions": [
Expand All @@ -341,7 +339,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [
Expand All @@ -361,7 +358,6 @@
]
}
],
"type": "tree",
"rules": [
{
"conditions": [],
Expand All @@ -372,14 +368,16 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
},
{
"conditions": [],
"error": "DualStack is enabled but this partition does not support DualStack",
"type": "error"
}
]
],
"type": "tree"
},
{
"conditions": [],
Expand All @@ -390,9 +388,11 @@
},
"type": "endpoint"
}
]
],
"type": "tree"
}
]
],
"type": "tree"
},
{
"conditions": [],
Expand Down Expand Up @@ -1175,7 +1175,7 @@
"imageId": {
"target": "com.amazonaws.cloud9#ImageId",
"traits": {
"smithy.api#documentation": "<p>The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\n To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)\n path.</p>\n <p>The default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned\n a value in the request. Because Amazon Linux AMI has ended standard support as of December 31,\n 2020, we recommend you choose Amazon Linux 2, which includes long term support through\n 2023.</p>\n <p>From December 31, 2023, the parameter for Amazon Linux will no longer be available when\n you specify an AMI for your instance. Amazon Linux 2 will then become the default AMI, which\n is used to launch your instance if no parameter is explicitly defined.</p>\n <p>Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.</p>\n <p>\n <b>AMI aliases </b>\n </p>\n <ul>\n <li>\n <p>\n <b>Amazon Linux (default):\n <code>amazonlinux-1-x86_64</code>\n </b>\n </p>\n </li>\n <li>\n <p>Amazon Linux 2: <code>amazonlinux-2-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 18.04: <code>ubuntu-18.04-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 22.04: <code>ubuntu-22.04-x86_64</code>\n </p>\n </li>\n </ul>\n <p>\n <b>SSM paths</b>\n </p>\n <ul>\n <li>\n <p>\n <b>Amazon Linux (default):\n <code>resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64</code>\n </b>\n </p>\n </li>\n <li>\n <p>Amazon Linux 2:\n <code>resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 18.04:\n <code>resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 22.04:\n <code>resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64</code>\n </p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\n To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)\n path.</p>\n <p>From November 20, 2023, you will be required to include the <code>imageId</code> parameter for the <code>CreateEnvironmentEC2</code> action.\n This change will be reflected across all direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only \n affect direct API consumers, and not Cloud9 console users.</p>\n <p>From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of \n maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the AMI to create your environment as it is \n fully supported. This change will only affect direct API consumers, and not Cloud9 console users.</p>\n <p>Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.</p>\n <p>\n <b>AMI aliases </b>\n </p>\n <ul>\n <li>\n <p>\n <b>Amazon Linux (default):\n <code>amazonlinux-1-x86_64</code>\n </b>\n </p>\n </li>\n <li>\n <p>Amazon Linux 2: <code>amazonlinux-2-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 18.04: <code>ubuntu-18.04-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 22.04: <code>ubuntu-22.04-x86_64</code>\n </p>\n </li>\n </ul>\n <p>\n <b>SSM paths</b>\n </p>\n <ul>\n <li>\n <p>\n <b>Amazon Linux (default):\n <code>resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64</code>\n </b>\n </p>\n </li>\n <li>\n <p>Amazon Linux 2:\n <code>resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 18.04:\n <code>resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64</code>\n </p>\n </li>\n <li>\n <p>Ubuntu 22.04:\n <code>resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64</code>\n </p>\n </li>\n </ul>"
}
},
"automaticStopTimeMinutes": {
Expand Down

0 comments on commit 37282cb

Please sign in to comment.