Skip to content

Commit 64c467c

Browse files
author
awstools
committed
docs(client-opsworkscm): Removing content that refers to an S3 bucket that is no longer in use.
1 parent 202ec5f commit 64c467c

19 files changed

+184
-152
lines changed

clients/client-opsworkscm/README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@
66

77
AWS SDK for JavaScript OpsWorksCM Client for Node.js, Browser and React Native.
88

9-
<fullname>AWS OpsWorks CM</fullname>
10-
11-
<p>AWS OpsWorks for configuration management (CM) is a service that runs and manages
12-
configuration management servers. You can use AWS OpsWorks CM to create and manage AWS
13-
OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove
9+
<fullname>OpsWorks CM</fullname>
10+
<important>
11+
12+
<p>The OpsWorks services have reached end of life and have been disabled for both new and existing customers.
13+
We strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the Amazon Web ServicesSupport Team on <a href="https://repost.aws/">Amazon Web Services re:Post</a> or through <a href="https://aws.amazon.com/support">Amazon Web Services Premium Support</a>.</p>
14+
</important>
15+
<p>OpsWorks CM is a service that runs and manages
16+
configuration management servers. You can use OpsWorks CM to create and manage OpsWorks for Chef Automate and
17+
OpsWorks for Puppet Enterprise servers, and add or remove
1418
nodes for the servers to manage.</p>
1519
<p>
1620
<b>Glossary of terms</b>
@@ -20,9 +24,9 @@ nodes for the servers to manage.</p>
2024
<p>
2125
<b>Server</b>: A configuration management server that can be
2226
highly-available. The configuration management server runs on
23-
an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational
24-
Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration
25-
manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start
27+
an Amazon Elastic Compute Cloud (EC2) instance, and may use various other Amazon Web Services services, such as Amazon Relational Database Service
28+
(RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration
29+
manager that you want to use, much like Amazon RDS. In OpsWorks CM, you do not start
2630
or stop servers. After you create servers, they continue to run until they are deleted.</p>
2731
</li>
2832
<li>
@@ -34,7 +38,7 @@ that you want to use. Valid values in this release include <code>ChefAutomate</c
3438
<p>
3539
<b>Backup</b>: This
3640
is an application-level backup of the data that the configuration manager
37-
stores. AWS OpsWorks CM
41+
stores. OpsWorks CM
3842
creates an S3 bucket for backups when you launch the first
3943
server. A backup maintains a snapshot of a server's configuration-related
4044
attributes at the time the backup starts.</p>
@@ -50,7 +54,7 @@ also deleted.</p>
5054
<li>
5155
<p>
5256
<b>Account attributes</b>:
53-
Every account has attributes that are assigned in the AWS OpsWorks CM
57+
Every account has attributes that are assigned in the OpsWorks CM
5458
database. These attributes store information about configuration limits (servers,
5559
backups, etc.) and your customer account.
5660
</p>
@@ -59,7 +63,8 @@ backups, etc.) and your customer account.
5963
<p>
6064
<b>Endpoints</b>
6165
</p>
62-
<p>AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers
66+
<p>OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
67+
Your servers
6368
can only be accessed or managed within the endpoint in which they are created.</p>
6469
<ul>
6570
<li>
@@ -90,7 +95,7 @@ can only be accessed or managed within the endpoint in which they are created.</
9095
<p>opsworks-cm.eu-west-1.amazonaws.com</p>
9196
</li>
9297
</ul>
93-
<p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html">AWS OpsWorks endpoints and quotas</a> in the AWS General Reference.</p>
98+
<p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html">OpsWorks endpoints and quotas</a> in the Amazon Web Services General Reference.</p>
9499
<p>
95100
<b>Throttling limits</b>
96101
</p>

clients/client-opsworkscm/src/OpsWorksCM.ts

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -383,10 +383,14 @@ export interface OpsWorksCM {
383383
}
384384

385385
/**
386-
* <fullname>AWS OpsWorks CM</fullname>
387-
* <p>AWS OpsWorks for configuration management (CM) is a service that runs and manages
388-
* configuration management servers. You can use AWS OpsWorks CM to create and manage AWS
389-
* OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove
386+
* <fullname>OpsWorks CM</fullname>
387+
* <important>
388+
* <p>The OpsWorks services have reached end of life and have been disabled for both new and existing customers.
389+
* We strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the Amazon Web ServicesSupport Team on <a href="https://repost.aws/">Amazon Web Services re:Post</a> or through <a href="https://aws.amazon.com/support">Amazon Web Services Premium Support</a>.</p>
390+
* </important>
391+
* <p>OpsWorks CM is a service that runs and manages
392+
* configuration management servers. You can use OpsWorks CM to create and manage OpsWorks for Chef Automate and
393+
* OpsWorks for Puppet Enterprise servers, and add or remove
390394
* nodes for the servers to manage.</p>
391395
* <p>
392396
* <b>Glossary of terms</b>
@@ -396,9 +400,9 @@ export interface OpsWorksCM {
396400
* <p>
397401
* <b>Server</b>: A configuration management server that can be
398402
* highly-available. The configuration management server runs on
399-
* an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational
400-
* Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration
401-
* manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start
403+
* an Amazon Elastic Compute Cloud (EC2) instance, and may use various other Amazon Web Services services, such as Amazon Relational Database Service
404+
* (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration
405+
* manager that you want to use, much like Amazon RDS. In OpsWorks CM, you do not start
402406
* or stop servers. After you create servers, they continue to run until they are deleted.</p>
403407
* </li>
404408
* <li>
@@ -410,7 +414,7 @@ export interface OpsWorksCM {
410414
* <p>
411415
* <b>Backup</b>: This
412416
* is an application-level backup of the data that the configuration manager
413-
* stores. AWS OpsWorks CM
417+
* stores. OpsWorks CM
414418
* creates an S3 bucket for backups when you launch the first
415419
* server. A backup maintains a snapshot of a server's configuration-related
416420
* attributes at the time the backup starts.</p>
@@ -426,7 +430,7 @@ export interface OpsWorksCM {
426430
* <li>
427431
* <p>
428432
* <b>Account attributes</b>:
429-
* Every account has attributes that are assigned in the AWS OpsWorks CM
433+
* Every account has attributes that are assigned in the OpsWorks CM
430434
* database. These attributes store information about configuration limits (servers,
431435
* backups, etc.) and your customer account.
432436
* </p>
@@ -435,7 +439,8 @@ export interface OpsWorksCM {
435439
* <p>
436440
* <b>Endpoints</b>
437441
* </p>
438-
* <p>AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers
442+
* <p>OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
443+
* Your servers
439444
* can only be accessed or managed within the endpoint in which they are created.</p>
440445
* <ul>
441446
* <li>
@@ -466,7 +471,7 @@ export interface OpsWorksCM {
466471
* <p>opsworks-cm.eu-west-1.amazonaws.com</p>
467472
* </li>
468473
* </ul>
469-
* <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html">AWS OpsWorks endpoints and quotas</a> in the AWS General Reference.</p>
474+
* <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html">OpsWorks endpoints and quotas</a> in the Amazon Web Services General Reference.</p>
470475
* <p>
471476
* <b>Throttling limits</b>
472477
* </p>

clients/client-opsworkscm/src/OpsWorksCMClient.ts

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -337,10 +337,14 @@ export type OpsWorksCMClientResolvedConfigType = __SmithyResolvedConfiguration<_
337337
export interface OpsWorksCMClientResolvedConfig extends OpsWorksCMClientResolvedConfigType {}
338338

339339
/**
340-
* <fullname>AWS OpsWorks CM</fullname>
341-
* <p>AWS OpsWorks for configuration management (CM) is a service that runs and manages
342-
* configuration management servers. You can use AWS OpsWorks CM to create and manage AWS
343-
* OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove
340+
* <fullname>OpsWorks CM</fullname>
341+
* <important>
342+
* <p>The OpsWorks services have reached end of life and have been disabled for both new and existing customers.
343+
* We strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the Amazon Web ServicesSupport Team on <a href="https://repost.aws/">Amazon Web Services re:Post</a> or through <a href="https://aws.amazon.com/support">Amazon Web Services Premium Support</a>.</p>
344+
* </important>
345+
* <p>OpsWorks CM is a service that runs and manages
346+
* configuration management servers. You can use OpsWorks CM to create and manage OpsWorks for Chef Automate and
347+
* OpsWorks for Puppet Enterprise servers, and add or remove
344348
* nodes for the servers to manage.</p>
345349
* <p>
346350
* <b>Glossary of terms</b>
@@ -350,9 +354,9 @@ export interface OpsWorksCMClientResolvedConfig extends OpsWorksCMClientResolved
350354
* <p>
351355
* <b>Server</b>: A configuration management server that can be
352356
* highly-available. The configuration management server runs on
353-
* an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational
354-
* Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration
355-
* manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start
357+
* an Amazon Elastic Compute Cloud (EC2) instance, and may use various other Amazon Web Services services, such as Amazon Relational Database Service
358+
* (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration
359+
* manager that you want to use, much like Amazon RDS. In OpsWorks CM, you do not start
356360
* or stop servers. After you create servers, they continue to run until they are deleted.</p>
357361
* </li>
358362
* <li>
@@ -364,7 +368,7 @@ export interface OpsWorksCMClientResolvedConfig extends OpsWorksCMClientResolved
364368
* <p>
365369
* <b>Backup</b>: This
366370
* is an application-level backup of the data that the configuration manager
367-
* stores. AWS OpsWorks CM
371+
* stores. OpsWorks CM
368372
* creates an S3 bucket for backups when you launch the first
369373
* server. A backup maintains a snapshot of a server's configuration-related
370374
* attributes at the time the backup starts.</p>
@@ -380,7 +384,7 @@ export interface OpsWorksCMClientResolvedConfig extends OpsWorksCMClientResolved
380384
* <li>
381385
* <p>
382386
* <b>Account attributes</b>:
383-
* Every account has attributes that are assigned in the AWS OpsWorks CM
387+
* Every account has attributes that are assigned in the OpsWorks CM
384388
* database. These attributes store information about configuration limits (servers,
385389
* backups, etc.) and your customer account.
386390
* </p>
@@ -389,7 +393,8 @@ export interface OpsWorksCMClientResolvedConfig extends OpsWorksCMClientResolved
389393
* <p>
390394
* <b>Endpoints</b>
391395
* </p>
392-
* <p>AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers
396+
* <p>OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
397+
* Your servers
393398
* can only be accessed or managed within the endpoint in which they are created.</p>
394399
* <ul>
395400
* <li>
@@ -420,7 +425,7 @@ export interface OpsWorksCMClientResolvedConfig extends OpsWorksCMClientResolved
420425
* <p>opsworks-cm.eu-west-1.amazonaws.com</p>
421426
* </li>
422427
* </ul>
423-
* <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html">AWS OpsWorks endpoints and quotas</a> in the AWS General Reference.</p>
428+
* <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html">OpsWorks endpoints and quotas</a> in the Amazon Web Services General Reference.</p>
424429
* <p>
425430
* <b>Throttling limits</b>
426431
* </p>

clients/client-opsworkscm/src/commands/AssociateNodeCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface AssociateNodeCommandOutput extends AssociateNodeResponse, __Met
3636
* <p>
3737
* On a Chef server: This command is an alternative to <code>knife bootstrap</code>.</p>
3838
* <p>
39-
* Example (Chef): <code>aws opsworks-cm associate-node --server-name <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes "Name=<i>CHEF_ORGANIZATION</i>,Value=default" "Name=<i>CHEF_NODE_PUBLIC_KEY</i>,Value=<i>public-key-pem</i>"</code>
39+
* Example (Chef): <code>aws opsworks-cm associate-node --server-name <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes "Name=<i>CHEF_ORGANIZATION</i>,Value=default" "Name=<i>CHEF_AUTOMATE_NODE_PUBLIC_KEY</i>,Value=<i>public-key-pem</i>"</code>
4040
* </p>
4141
* <p>
4242
* On a Puppet server, this command is an alternative to the <code>puppet cert sign</code> command that signs a Puppet node CSR.
@@ -47,7 +47,8 @@ export interface AssociateNodeCommandOutput extends AssociateNodeResponse, __Met
4747
* <p>
4848
* A node can can only be associated with servers that are in a <code>HEALTHY</code> state. Otherwise, an <code>InvalidStateException</code> is thrown.
4949
* A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.
50-
* The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.
50+
* The AssociateNode API call can be integrated into Auto Scaling configurations, CloudFormation templates, or the user data
51+
* of a server's instance.
5152
* </p>
5253
* @example
5354
* Use a bare-bones client and the command you need to make an API call.

clients/client-opsworkscm/src/commands/CreateBackupCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
3434
* changed, and no additional backup can be created.
3535
* </p>
3636
* <p>
37-
* Backups can be created for servers in <code>RUNNING</code>, <code>HEALTHY</code>, and <code>UNHEALTHY</code> states. By default, you can create a maximum of 50
37+
* Backups can be created for servers in <code>RUNNING</code>, <code>HEALTHY</code>, and <code>UNHEALTHY</code> states.
38+
* By default, you can create a maximum of 50
3839
* manual backups.
3940
* </p>
4041
* <p>

clients/client-opsworkscm/src/commands/CreateServerCommand.ts

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,32 +34,39 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
3434

3535
/**
3636
* <p>
37-
* Creates and immedately starts a new server. The server is ready to use when it is in the <code>HEALTHY</code> state. By default, you can create a maximum of 10 servers.
37+
* Creates and immedately starts a new server. The server is ready to use when it is in the <code>HEALTHY</code> state. By
38+
* default, you can create a maximum of 10 servers.
3839
* </p>
3940
* <p>
4041
* This operation is asynchronous.
4142
* </p>
4243
* <p>
43-
* A <code>LimitExceededException</code> is thrown when you have created the maximum number of servers (10). A <code>ResourceAlreadyExistsException</code>
44-
* is thrown when a server with the same name already exists in the account. A <code>ResourceNotFoundException</code> is thrown when you
45-
* specify a backup ID that is not valid or is for a backup that does not exist. A <code>ValidationException</code> is thrown when parameters
44+
* A <code>LimitExceededException</code> is thrown when you have created the maximum number of servers (10). A
45+
* <code>ResourceAlreadyExistsException</code>
46+
* is thrown when a server with the same name already exists in the account. A <code>ResourceNotFoundException</code> is thrown when
47+
* you
48+
* specify a backup ID that is not valid or is for a backup that does not exist. A <code>ValidationException</code> is thrown when
49+
* parameters
4650
* of the request are not valid.
4751
* </p>
4852
* <p>
49-
* If you do not specify a security group by adding the <code>SecurityGroupIds</code> parameter, AWS OpsWorks creates a new security group.
53+
* If you do not specify a security group by adding the <code>SecurityGroupIds</code> parameter, OpsWorks creates a new
54+
* security group.
5055
* </p>
5156
* <p>
52-
* <i>Chef Automate:</i> The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
57+
* <i>Chef Automate:</i> The default security group opens the Chef server to the world on TCP port 443. If
58+
* a KeyName is present, OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
5359
* </p>
5460
* <p>
55-
* <i>Puppet Enterprise:</i> The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
61+
* <i>Puppet Enterprise:</i> The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
5662
* </p>
5763
* <p>By default, your server is accessible from any IP address. We
5864
* recommend that you update your security group rules to allow
5965
* access from known IP addresses and address ranges only. To edit security group rules, open Security Groups
6066
* in the navigation pane of the EC2 management console.
6167
* </p>
62-
* <p>To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for <code>CustomDomain</code>,
68+
* <p>To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key,
69+
* specify values for <code>CustomDomain</code>,
6370
* <code>CustomCertificate</code>, and <code>CustomPrivateKey</code>.</p>
6471
* @example
6572
* Use a bare-bones client and the command you need to make an API call.

clients/client-opsworkscm/src/commands/DeleteServerCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ export interface DeleteServerCommandOutput extends DeleteServerResponse, __Metad
2929

3030
/**
3131
* <p>
32-
* Deletes the server and the underlying AWS CloudFormation stacks
32+
* Deletes the server and the underlying CloudFormation stacks
3333
* (including the server's EC2 instance). When you run this command, the server state is updated
3434
* to <code>DELETING</code>. After the server is deleted, it is no longer returned by
35-
* <code>DescribeServer</code> requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.
35+
* <code>DescribeServer</code> requests. If the CloudFormation stack cannot be deleted, the server cannot be deleted.
3636
* </p>
3737
* <p>
3838
* This operation is asynchronous.

0 commit comments

Comments
 (0)