Skip to content

Commit d9159ec

Browse files
author
awstools
committed
docs(client-ecs): This release adds support for Container Insights with Enhanced Observability for Amazon ECS.
1 parent b2a4c95 commit d9159ec

File tree

4 files changed

+82
-46
lines changed

4 files changed

+82
-46
lines changed

‎clients/client-ecs/src/commands/DeleteCapacityProviderCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi
3131
* <p>Deletes the specified capacity provider.</p>
3232
* <note>
3333
* <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are reserved and can't
34-
* be deleted. You can disassociate them from a cluster using either <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html">PutCapacityProviderProviders</a> or by deleting the cluster.</p>
34+
* be deleted. You can disassociate them from a cluster using either <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or by deleting the cluster.</p>
3535
* </note>
3636
* <p>Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity
3737
* provider strategy from all services. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> API can be used to

‎clients/client-ecs/src/commands/DescribeClustersCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
2929

3030
/**
3131
* <p>Describes one or more of your clusters.</p>
32+
* <p> For CLI examples, see <a href="https://github.com/aws/aws-cli/blob/develop/awscli/examples/ecs/describe-clusters.rst">describe-clusters.rst</a> on GitHub.</p>
3233
* @example
3334
* Use a bare-bones client and the command you need to make an API call.
3435
* ```javascript

‎clients/client-ecs/src/models/models_0.ts

Lines changed: 68 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -803,7 +803,18 @@ export type ClusterSettingName = (typeof ClusterSettingName)[keyof typeof Cluste
803803

804804
/**
805805
* <p>The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container
806+
* Insights with enhanced observability or CloudWatch Container
806807
* Insights for a cluster.</p>
808+
* <p>Container Insights with enhanced observability provides all the Container Insights metrics,
809+
* plus additional task and container metrics. This version supports enhanced observability
810+
* for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure
811+
* Container Insights with enhanced observability on Amazon ECS, Container Insights
812+
* auto-collects detailed infrastructure telemetry from the cluster level down to the container
813+
* level in your environment and displays these critical performance data in curated
814+
* dashboards removing the heavy lifting in observability set-up. </p>
815+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html">Monitor
816+
* Amazon ECS containers using Container Insights with enhanced observability</a> in the
817+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
807818
* @public
808819
*/
809820
export interface ClusterSetting {
@@ -814,12 +825,14 @@ export interface ClusterSetting {
814825
name?: ClusterSettingName | undefined;
815826

816827
/**
817-
* <p>The value to set for the cluster setting. The supported values are <code>enabled</code> and
818-
* <code>disabled</code>. </p>
819-
* <p>If you set <code>name</code> to <code>containerInsights</code> and <code>value</code> to
820-
* <code>enabled</code>, CloudWatch Container Insights will be on for the cluster, otherwise it will be off
821-
* unless the <code>containerInsights</code> account setting is turned on. If a cluster value is
822-
* specified, it will override the <code>containerInsights</code> value set with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html">PutAccountSetting</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html">PutAccountSettingDefault</a>.</p>
828+
* <p>The value to set for the cluster setting. The supported values are <code>enhanced</code>,
829+
* <code>enabled</code>, and <code>disabled</code>. </p>
830+
* <p>To use Container Insights with enhanced observability, set the
831+
* <code>containerInsights</code> account setting to <code>enhanced</code>.</p>
832+
* <p>To use Container Insights, set the <code>containerInsights</code> account setting to
833+
* <code>enabled</code>.</p>
834+
* <p>If a cluster value is specified, it will override the <code>containerInsights</code> value
835+
* set with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html">PutAccountSetting</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html">PutAccountSettingDefault</a>.</p>
823836
* @public
824837
*/
825838
value?: string | undefined;
@@ -1660,7 +1673,7 @@ export interface AwsVpcConfiguration {
16601673

16611674
/**
16621675
* <p>Whether the task's elastic network interface receives a public IP address. The default value is
1663-
* <code>DISABLED</code>.</p>
1676+
* <code>ENABLED</code>.</p>
16641677
* @public
16651678
*/
16661679
assignPublicIp?: AssignPublicIp | undefined;
@@ -6307,8 +6320,9 @@ export interface ContainerDefinition {
63076320
*/
63086321
export interface EphemeralStorage {
63096322
/**
6310-
* <p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
6311-
* <code>20</code> GiB and the maximum supported value is <code>200</code> GiB.</p>
6323+
* <p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported
6324+
* value is <code>21</code> GiB and the maximum supported value is <code>200</code>
6325+
* GiB.</p>
63126326
* @public
63136327
*/
63146328
sizeInGiB: number | undefined;
@@ -8569,8 +8583,8 @@ export type TaskField = (typeof TaskField)[keyof typeof TaskField];
85698583
export interface DescribeTasksRequest {
85708584
/**
85718585
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe.
8572-
* If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were
8573-
* launched in any cluster other than the default cluster.</p>
8586+
* If you do not specify a cluster, the default cluster is assumed. This parameter is required. If you do not specify a value, the
8587+
* <code>default</code> cluster is used.</p>
85748588
* @public
85758589
*/
85768590
cluster?: string | undefined;
@@ -10152,8 +10166,11 @@ export interface ListServiceDeploymentsRequest {
1015210166
service: string | undefined;
1015310167

1015410168
/**
10155-
* <p>The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performanceIf you don't
10156-
* specify a cluster, <code>deault</code> is used.</p>
10169+
* <p>The cluster that hosts the service. This can either be the cluster name or ARN. Starting
10170+
* April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic
10171+
* Inference (EI), and will help current customers migrate their workloads to options that
10172+
* offer better price and performanceIf you don't specify a cluster, <code>default</code>
10173+
* is used.</p>
1015710174
* @public
1015810175
*/
1015910176
cluster?: string | undefined;
@@ -10806,12 +10823,20 @@ export interface PutAccountSettingRequest {
1080610823
* </li>
1080710824
* <li>
1080810825
* <p>
10809-
* <code>containerInsights</code> - When modified, the default setting indicating whether Amazon Web Services
10810-
* CloudWatch Container Insights is turned on for your clusters is changed. If
10811-
* <code>containerInsights</code> is turned on, any new clusters that are created will have
10812-
* Container Insights turned on unless you disable it during cluster creation. For more
10813-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html">CloudWatch Container
10814-
* Insights</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
10826+
* <code>containerInsights</code> - Container Insights with enhanced observability provides
10827+
* all the Container Insights metrics, plus additional task and container metrics.
10828+
* This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2
10829+
* and Fargate launch types. After you configure Container Insights with enhanced
10830+
* observability on Amazon ECS, Container Insights auto-collects detailed infrastructure
10831+
* telemetry from the cluster level down to the container level in your environment and
10832+
* displays these critical performance data in curated dashboards removing the
10833+
* heavy lifting in observability set-up. </p>
10834+
* <p>To use Container Insights with enhanced observability, set the
10835+
* <code>containerInsights</code> account setting to
10836+
* <code>enhanced</code>.</p>
10837+
* <p>To use Container Insights, set the <code>containerInsights</code> account setting to
10838+
* <code>enabled</code>.</p>
10839+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html">Monitor Amazon ECS containers using Container Insights with enhanced observability</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1081510840
* </li>
1081610841
* <li>
1081710842
* <p>
@@ -10853,10 +10878,11 @@ export interface PutAccountSettingRequest {
1085310878
name: SettingName | undefined;
1085410879

1085510880
/**
10856-
* <p>The account setting value for the specified principal ARN. Accepted values are <code>enabled</code>,
10857-
* <code>disabled</code>, <code>on</code>, and <code>off</code>.</p>
10858-
* <p>When you specify <code>fargateTaskRetirementWaitPeriod</code> for the <code>name</code>, the
10859-
* following are the valid values:</p>
10881+
* <p>The account setting value for the specified principal ARN. Accepted values are
10882+
* <code>enabled</code>, <code>disabled</code>, <code>enhanced</code>,
10883+
* <code>on</code>, and <code>off</code>.</p>
10884+
* <p>When you specify <code>fargateTaskRetirementWaitPeriod</code> for the
10885+
* <code>name</code>, the following are the valid values:</p>
1086010886
* <ul>
1086110887
* <li>
1086210888
* <p>
@@ -10950,12 +10976,20 @@ export interface PutAccountSettingDefaultRequest {
1095010976
* </li>
1095110977
* <li>
1095210978
* <p>
10953-
* <code>containerInsights</code> - When modified, the default setting indicating whether Amazon Web Services
10954-
* CloudWatch Container Insights is turned on for your clusters is changed. If
10955-
* <code>containerInsights</code> is turned on, any new clusters that are created will have
10956-
* Container Insights turned on unless you disable it during cluster creation. For more
10957-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html">CloudWatch Container
10958-
* Insights</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
10979+
* <code>containerInsights</code> - Container Insights with enhanced observability provides
10980+
* all the Container Insights metrics, plus additional task and container metrics.
10981+
* This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2
10982+
* and Fargate launch types. After you configure Container Insights with enhanced
10983+
* observability on Amazon ECS, Container Insights auto-collects detailed infrastructure
10984+
* telemetry from the cluster level down to the container level in your environment and
10985+
* displays these critical performance data in curated dashboards removing the
10986+
* heavy lifting in observability set-up. </p>
10987+
* <p>To use Container Insights with enhanced observability, set the
10988+
* <code>containerInsights</code> account setting to
10989+
* <code>enhanced</code>.</p>
10990+
* <p>To use Container Insights, set the <code>containerInsights</code> account
10991+
* setting to <code>enabled</code>.</p>
10992+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html">Monitor Amazon ECS containers using Container Insights with enhanced observability</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1095910993
* </li>
1096010994
* <li>
1096110995
* <p>
@@ -11002,10 +11036,11 @@ export interface PutAccountSettingDefaultRequest {
1100211036
name: SettingName | undefined;
1100311037

1100411038
/**
11005-
* <p>The account setting value for the specified principal ARN. Accepted values are <code>enabled</code>,
11006-
* <code>disabled</code>, <code>on</code>, and <code>off</code>.</p>
11007-
* <p>When you specify <code>fargateTaskRetirementWaitPeriod</code> for the <code>name</code>, the
11008-
* following are the valid values:</p>
11039+
* <p>The account setting value for the specified principal ARN. Accepted values are
11040+
* <code>enabled</code>, <code>disabled</code>, <code>on</code>, <code>enhanced</code>,
11041+
* and <code>off</code>.</p>
11042+
* <p>When you specify <code>fargateTaskRetirementWaitPeriod</code> for the
11043+
* <code>name</code>, the following are the valid values:</p>
1100911044
* <ul>
1101011045
* <li>
1101111046
* <p>

0 commit comments

Comments
 (0)