From 211cb53d88e8ce60de94b1938a229d10b545c081 Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 23 May 2024 18:14:38 +0000 Subject: [PATCH] docs(client-opsworks): Documentation-only update for OpsWorks Stacks. --- clients/client-opsworks/README.md | 44 +- clients/client-opsworks/src/OpsWorks.ts | 44 +- clients/client-opsworks/src/OpsWorksClient.ts | 44 +- .../src/commands/AssignInstanceCommand.ts | 6 +- .../src/commands/AssignVolumeCommand.ts | 3 +- .../src/commands/AssociateElasticIpCommand.ts | 3 +- .../AttachElasticLoadBalancerCommand.ts | 7 +- .../src/commands/CreateLayerCommand.ts | 6 +- .../src/commands/DeleteAppCommand.ts | 3 +- .../src/commands/DeleteInstanceCommand.ts | 6 +- .../src/commands/DeleteLayerCommand.ts | 3 +- .../src/commands/DeleteUserProfileCommand.ts | 3 +- .../commands/DeregisterElasticIpCommand.ts | 4 +- .../src/commands/DeregisterInstanceCommand.ts | 5 +- .../commands/DescribeAgentVersionsCommand.ts | 2 +- .../src/commands/DescribeAppsCommand.ts | 3 +- .../commands/DescribeEcsClustersCommand.ts | 2 +- .../DescribeOperatingSystemsCommand.ts | 2 +- .../commands/DescribeServiceErrorsCommand.ts | 2 +- .../DetachElasticLoadBalancerCommand.ts | 3 +- .../src/commands/RegisterInstanceCommand.ts | 11 +- .../SetLoadBasedAutoScalingCommand.ts | 4 +- .../src/commands/SetPermissionCommand.ts | 3 +- .../src/commands/StopInstanceCommand.ts | 2 +- .../src/commands/TagResourceCommand.ts | 3 +- .../src/commands/UnassignInstanceCommand.ts | 2 +- .../src/commands/UpdateVolumeCommand.ts | 3 +- clients/client-opsworks/src/index.ts | 44 +- .../client-opsworks/src/models/models_0.ts | 661 +++++++++++------- 29 files changed, 542 insertions(+), 386 deletions(-) diff --git a/clients/client-opsworks/README.md b/clients/client-opsworks/README.md index 1cdb33d36374..9820477053d4 100644 --- a/clients/client-opsworks/README.md +++ b/clients/client-opsworks/README.md @@ -6,65 +6,62 @@ AWS SDK for JavaScript OpsWorks Client for Node.js, Browser and React Native. -AWS OpsWorks +OpsWorks -

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and -usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error +

Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, +and +usage examples for OpsWorks Stacks actions and data types, including common parameters and error codes.

-

AWS OpsWorks Stacks is an application management service that provides an integrated experience for -overseeing the complete application lifecycle. For information about this product, go to the -AWS OpsWorks details page.

- +

OpsWorks Stacks is an application management service that provides an integrated experience for +managing the complete application lifecycle. For information about OpsWorks, see the +OpsWorks information page.

SDKs and CLI

-

The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

+

Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the +Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:

-

Endpoints

-

AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks -can only be accessed or managed within the endpoint in which they are created.

+

OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. +Stacks can only be accessed or managed within the endpoint in which they are created.

- *

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a + *

For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a * VPC. For more information about default VPC and EC2 Classic, see Supported * Platforms.

* @public @@ -723,22 +735,25 @@ export interface CloneStackRequest { Attributes?: Partial>; /** - *

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS + *

The stack Identity and Access Management (IAM) role, which allows OpsWorks Stacks to work with Amazon Web Services * resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an - * existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for - * you. You can obtain an existing stack's IAM ARN programmatically by calling - * DescribePermissions. For more information about IAM ARNs, see Using + * existing IAM role. If you create a stack by using the OpsWorkss Stacks console, it creates the role for + * you. You can obtain an existing stack's IAM ARN programmatically by calling + * DescribePermissions. For more information about IAM ARNs, see + * Using * Identifiers.

* - *

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

+ *

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. + * You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

* * @public */ ServiceRoleArn: string | undefined; /** - *

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. - * For more information about IAM ARNs, see Using + *

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's + * EC2 instances. + * For more information about IAM ARNs, see Using * Identifiers.

* @public */ @@ -748,11 +763,11 @@ export interface CloneStackRequest { *

The stack's operating system, which must be set to one of the following.

* *

The default option is the parent stack's operating system. - * For more information about supported operating systems, - * see AWS OpsWorks Stacks Operating Systems.

+ * Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, + * see OpsWorks Stacks Operating Systems.

* - *

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

+ *

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to + * Windows or Windows to Linux.

* * @public */ @@ -875,7 +891,8 @@ export interface CloneStackRequest { DefaultSubnetId?: string; /** - *

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

+ *

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration + * JSON values. The string should be in the following format:

*

* "\{\"key1\": \"value1\", \"key2\": \"value2\",...\}" *

@@ -887,7 +904,8 @@ export interface CloneStackRequest { CustomJson?: string; /** - *

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

+ *

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the + * Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

* @public */ ConfigurationManager?: StackConfigurationManager; @@ -906,17 +924,22 @@ export interface CloneStackRequest { UseCustomCookbooks?: boolean; /** - *

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

- *

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are + *

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

+ *

OpsWorks Stacks provides a standard set of security groups, one for each layer, which are * associated with layers by default. With UseOpsworksSecurityGroups you can instead * provide your own custom security groups. UseOpsworksSecurityGroups has the * following settings:

*
    *
  • - *

    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.

    + *

    True - OpsWorks Stacks automatically associates the appropriate built-in security group with + * each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot + * delete the built-in security group.

    *
    • *
  • - *

    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

    + *

    False - OpsWorks Stacks does not associate built-in security groups with layers. + * You must create appropriate Amazon EC2 security groups and associate a security group with each + * layer that you create. However, you can still manually associate a built-in security group with a layer on creation; + * custom security groups are required only for those layers that need custom settings.

    *
    • *
*

For more information, see Create a New @@ -927,14 +950,15 @@ export interface CloneStackRequest { /** *

Contains the information required to retrieve an app or cookbook from a repository. For more information, - * see Adding Apps or Cookbooks and Recipes.

+ * see Adding Apps or + * Cookbooks and Recipes.

* @public */ CustomCookbooksSource?: Source; /** - *

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS - * OpsWorks installs the public key on the instance and you can use the private key with an SSH + *

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, + * OpsWorks installs the public key on the instance and you can use the private key with an SSH * client to log in to the instance. For more information, see Using SSH to * Communicate with an Instance and Managing SSH * Access. You can override this setting by specifying a different key pair, or no key @@ -964,24 +988,25 @@ export interface CloneStackRequest { DefaultRootDeviceType?: RootDeviceType; /** - *

The default AWS OpsWorks Stacks agent version. You have the following options:

+ *

The default OpsWorks Stacks agent version. You have the following options:

*
    *
  • - *

    Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks + *

    Auto-update - Set this parameter to LATEST. OpsWorks Stacks * automatically installs new agent versions on the stack's instances as soon as * they are available.

    *
    • *
  • *

    Fixed version - Set this parameter to your preferred agent version. To update * the agent version, you must edit the stack configuration and specify a new version. - * AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

    + * OpsWorks Stacks automatically installs that version on the stack's instances.

    *
    • *
*

The default setting is LATEST. To specify an agent version, * you must use the complete version number, not the abbreviated number shown on the console. * For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

* - *

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

+ *

You can also specify an agent version when you create or update an instance, which overrides the stack's + * default setting.

* * @public */ @@ -1134,7 +1159,8 @@ export const CloudWatchLogsTimeZone = { export type CloudWatchLogsTimeZone = (typeof CloudWatchLogsTimeZone)[keyof typeof CloudWatchLogsTimeZone]; /** - *

Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.

+ *

Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, + * see the CloudWatch Logs Agent Reference.

* @public */ export interface CloudWatchLogsLogStream { @@ -1161,21 +1187,24 @@ export interface CloudWatchLogsLogStream { /** *

Specifies log files that you want to push to CloudWatch Logs.

- *

- * File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). - * Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series + *

+ * File can point to a specific file or multiple files (by using wild card characters such + * as /var/log/system.log*). + * Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use + * wild card characters to specify a series * of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on * by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, * such as access_log_80 and access_log_443. To specify multiple, different file types, add another * log stream entry to the configuration file, so that each log file type is stored in a different log group.

- *

Zipped files are not supported.

+ *

Zipped files are not supported.

* @public */ File?: string; /** *

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, - * such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are + * such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. + * Fingerprint lines are * not sent to CloudWatch Logs unless all specified lines are available.

* @public */ @@ -1223,7 +1252,7 @@ export interface CloudWatchLogsLogStream { } /** - *

Describes the Amazon CloudWatch logs configuration for a layer.

+ *

Describes the Amazon CloudWatch Logs configuration for a layer.

* @public */ export interface CloudWatchLogsConfiguration { @@ -1418,7 +1447,7 @@ export interface CreateAppRequest { /** *

The app type. Each supported type is associated with a particular layer. For example, PHP - * applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances + * applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances * that are members of the corresponding layer. If your app isn't one of the standard types, or * you prefer to implement your own Deploy recipes, specify other.

* @public @@ -1549,7 +1578,7 @@ export interface DeploymentCommand { *
  • *

    * rollback Roll the app back to the previous version. When you update an app, - * AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this + * OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this * command to roll an app back as many as four versions.

    *
    • *
  • @@ -1583,21 +1612,21 @@ export interface DeploymentCommand { *
      *
    • *

      - * upgrade_os_to - Specifies the desired Amazon Linux version for instances - * whose OS you want to upgrade, such as Amazon Linux 2016.09. You must also set + * upgrade_os_to - Specifies the Amazon Linux version that you want instances + * to run, such as Amazon Linux 2. You must also set * the allow_reboot argument to true.

      *
      • *
    • *

      - * allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if + * allow_reboot - Specifies whether to allow OpsWorks Stacks to reboot the instances if * necessary, after installing the updates. This argument can be set to either * true or false. The default value is false.

      *
      • *
    - *

    For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the + *

    For example, to upgrade an instance to Amazon Linux 2018.03, set Args to the * following.

    *

    - * \{ "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] \} + * \{ "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] \} *

    * @public */ @@ -1646,13 +1675,15 @@ export interface CreateDeploymentRequest { Comment?: string; /** - *

    A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

    + *

    A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default + * stack configuration JSON values. The string should be in the following format:

    *

    * "\{\"key1\": \"value1\", \"key2\": \"value2\",...\}" *

    *

    For more information about custom JSON, see Use Custom JSON to * Modify the Stack Configuration Attributes and - * Overriding Attributes With Custom JSON.

    + * Overriding Attributes With Custom + * JSON.

    * @public */ CustomJson?: string; @@ -1689,7 +1720,8 @@ export interface CreateInstanceRequest { /** *

    The instance type, such as t2.micro. For a list of supported instance types, * open the stack in the console, choose Instances, and choose + Instance. - * The Size list contains the currently supported types. For more information, see Instance + * The Size list contains the currently supported types. + * For more information, see Instance * Families and Types. The parameter values that you use to specify the various types are * in the API Name column of the Available Instance Types table.

    * @public @@ -1703,7 +1735,15 @@ export interface CreateInstanceRequest { AutoScalingType?: AutoScalingType; /** - *

    The instance host name.

    + *

    The instance host name. The following are character limits for instance host names.

    + *
      + *
    • + *

      Linux-based instances: 63 characters

      + *
      • + *
    • + *

      Windows-based instances: 15 characters

      + *
      • + *
    * @public */ Hostname?: string; @@ -1712,11 +1752,11 @@ export interface CreateInstanceRequest { *

    The instance's operating system, which must be set to one of the following.

    *
      *
    • - *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, + *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, * Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

      *
      • *
    • - *

      A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      + *

      A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      *
      • *
    • *

      @@ -1736,12 +1776,12 @@ export interface CreateInstanceRequest { *

      A custom AMI: Custom.

      *
      • *
    - *

    For more information about the supported operating systems, - * see AWS OpsWorks Stacks Operating Systems.

    + *

    Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, + * see OpsWorks Stacks Operating Systems.

    *

    The default option is the current Amazon Linux version. If you set this parameter to * Custom, you must use the CreateInstance action's AmiId parameter to - * specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating - * systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using + * specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. + * For more information about how to use custom AMIs with OpsWorks Stacks, see Using * Custom AMIs.

    * @public */ @@ -1778,7 +1818,8 @@ export interface CreateInstanceRequest { VirtualizationType?: string; /** - *

    The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

    + *

    The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's + * default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.

    * @public */ SubnetId?: string; @@ -1828,7 +1869,7 @@ export interface CreateInstanceRequest { EbsOptimized?: boolean; /** - *

    The default AWS OpsWorks Stacks agent version. You have the following options:

    + *

    The default OpsWorks Stacks agent version. You have the following options:

    *
      *
    • *

      @@ -1840,18 +1881,28 @@ export interface CreateInstanceRequest { * This value overrides the stack's default setting. * To update the agent version, edit the instance configuration and specify a * new version. - * AWS OpsWorks Stacks then automatically installs that version on the instance.

      + * OpsWorks Stacks installs that version on the instance.

      *
      • *
    *

    The default setting is INHERIT. To specify an agent version, * you must use the complete version number, not the abbreviated number shown on the console. - * For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

    + * For a list of available agent version numbers, call DescribeAgentVersions. + * AgentVersion cannot be set to Chef 12.2.

    * @public */ AgentVersion?: string; /** - *

    The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

    + *

    The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, + * inherit tenancy settings from the VPC. The following are valid values for this parameter: + * dedicated, default, or host. Because there are costs associated with changes + * in tenancy options, we recommend that you research tenancy options before choosing them for your instances. + * For more information about dedicated hosts, see + * Dedicated Hosts Overview and + * Amazon EC2 Dedicated Hosts. + * For more information about dedicated instances, see + * Dedicated Instances and + * Amazon EC2 Dedicated Instances.

    * @public */ Tenancy?: string; @@ -1907,15 +1958,16 @@ export const LayerAttributesKeys = { export type LayerAttributesKeys = (typeof LayerAttributesKeys)[keyof typeof LayerAttributesKeys]; /** - *

    AWS OpsWorks Stacks supports five + *

    OpsWorks Stacks supports five * lifecycle events: * setup, configuration, deploy, undeploy, and shutdown. For - * each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide - * custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the + * each layer, OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide + * custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the * standard recipes. LayerCustomRecipes specifies the custom recipes for a * particular layer to be run in response to each of the five events.

    - * - *

    To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

    + *

    To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, + * which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in + * the repository's phpapp2 folder.

    * @public */ export interface Recipes { @@ -1956,7 +2008,8 @@ export interface Recipes { */ export interface ShutdownEventConfiguration { /** - *

    The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.

    + *

    The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before + * shutting down an instance.

    * @public */ ExecutionTimeout?: number; @@ -2049,15 +2102,17 @@ export interface VolumeConfiguration { *
    • *
  • *

    - * gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

    + * gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size + * of 16384 GiB.

    *
    • *
  • - *

    - * st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    + *

    + * st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a + * minimum size of 125 GiB and a maximum size of 16384 GiB.

    *
    • *
  • - *

    - * sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    + *

    + * sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.

    *
    • * * @public @@ -2089,20 +2144,25 @@ export interface CreateLayerRequest { StackId: string | undefined; /** - *

    The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.

    + *

    The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. + * Built-in layers are not available in Chef 12 stacks.

    * @public */ Type: LayerType | undefined; /** - *

    The layer name, which is used by the console.

    + *

    The layer name, which is used by the console. Layer names can be a maximum of 32 characters.

    * @public */ Name: string | undefined; /** - *

    For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

    - *

    The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.

    + *

    For custom layers only, use this parameter to specify the layer's short name, which is used internally by + * OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your + * app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric + * characters, '-', '_', and '.'.

    + *

    Built-in layer short names are defined by OpsWorks Stacks. For more information, see the + * Layer Reference.

    * @public */ Shortname: string | undefined; @@ -2115,14 +2175,15 @@ export interface CreateLayerRequest { Attributes?: Partial>; /** - *

    Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

    + *

    Specifies CloudWatch Logs configuration options for the layer. For more information, + * see CloudWatchLogsLogStream.

    * @public */ CloudWatchLogsConfiguration?: CloudWatchLogsConfiguration; /** *

    The ARN of an IAM profile to be used for the layer's EC2 instances. For more information - * about IAM ARNs, see Using Identifiers.

    + * about IAM ARNs, see Using Identifiers.

    * @public */ CustomInstanceProfileArn?: string; @@ -2131,7 +2192,7 @@ export interface CreateLayerRequest { *

    A JSON-formatted string containing custom stack configuration and deployment attributes * to be installed on the layer's instances. For more information, see * - * Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI. + * Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI. *

    * @public */ @@ -2230,20 +2291,20 @@ export interface CreateLayerResult { */ export interface CreateStackRequest { /** - *

    The stack name.

    + *

    The stack name. Stack names can be a maximum of 64 characters.

    * @public */ Name: string | undefined; /** - *

    The stack's AWS region, such as ap-south-1. For more information about - * Amazon regions, see Regions and Endpoints.

    + *

    The stack's Amazon Web Services Region, such as ap-south-1. For more information about + * Amazon Web Services Regions, see Regions and Endpoints.

    * - *

    In the AWS CLI, this API maps to the --stack-region parameter. If the - * --stack-region parameter and the AWS CLI common parameter + *

    In the CLI, this API maps to the --stack-region parameter. If the + * --stack-region parameter and the CLI common parameter * --region are set to the same value, the stack uses a * regional endpoint. If the --stack-region - * parameter is not set, but the AWS CLI --region parameter is, this also + * parameter is not set, but the CLI --region parameter is, this also * results in a stack with a regional endpoint. However, if the * --region parameter is set to us-east-1, and the * --stack-region parameter is set to one of the following, then the @@ -2252,17 +2313,18 @@ export interface CreateStackRequest { * ap-southeast-2. In this case, the actual API endpoint of the stack is in * us-east-1. Only the preceding regions are supported as classic * regions in the us-east-1 API endpoint. Because it is a best practice to - * choose the regional endpoint that is closest to where you manage AWS, we recommend - * that you use regional endpoints for new stacks. The AWS CLI common + * choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend + * that you use regional endpoints for new stacks. The CLI common * --region parameter always specifies a regional API endpoint; it - * cannot be used to specify a classic AWS OpsWorks Stacks region.

    + * cannot be used to specify a classic OpsWorks Stacks region.

    * * @public */ Region: string | undefined; /** - *

    The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

    + *

    The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched + * into this VPC. You cannot change the ID later.

    * *

    If the VPC ID corresponds to a default VPC and you have specified either the * DefaultAvailabilityZone or the DefaultSubnetId parameter only, - * AWS OpsWorks Stacks infers the value of the - * other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets + * OpsWorks Stacks infers the value of the + * other parameter. If you specify neither parameter, OpsWorks Stacks sets * these parameters to the first valid Availability Zone for the specified region and the * corresponding default VPC subnet ID, respectively.

    *

    If you specify a nondefault VPC ID, note the following:

    @@ -2286,7 +2348,7 @@ export interface CreateStackRequest { *

    You must specify a value for DefaultSubnetId.

    * * - *

    For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a + *

    For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a * VPC. For more information about default VPC and EC2-Classic, see Supported * Platforms.

    * @public @@ -2300,9 +2362,10 @@ export interface CreateStackRequest { Attributes?: Partial>; /** - *

    The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS + *

    The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services * resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an - * existing IAM role. For more information about IAM ARNs, see Using + * existing IAM role. For more information about IAM ARNs, see + * Using * Identifiers.

    * @public */ @@ -2310,21 +2373,22 @@ export interface CreateStackRequest { /** *

    The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. - * For more information about IAM ARNs, see Using + * For more information about IAM ARNs, see Using * Identifiers.

    * @public */ DefaultInstanceProfileArn: string | undefined; /** - *

    The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

    + *

    The stack's default operating system, which is installed on every instance unless you specify a different operating + * system when you create the instance. You can specify one of the following.

    *
      *
    • - *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, + *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, * Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

      *
      • *
    • - *

      A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      + *

      A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      *
      • *
    • *

      @@ -2350,8 +2414,8 @@ export interface CreateStackRequest { *

      • *
    *

    The default option is the current Amazon Linux version. - * For more information about supported operating systems, - * see AWS OpsWorks Stacks Operating Systems.

    + * Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, + * see OpsWorks Stacks Operating Systems.

    * @public */ DefaultOs?: string; @@ -2446,7 +2510,8 @@ export interface CreateStackRequest { DefaultSubnetId?: string; /** - *

    A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

    + *

    A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration + * attribute values or to pass data to recipes. The string should be in the following format:

    *

    * "\{\"key1\": \"value1\", \"key2\": \"value2\",...\}" *

    @@ -2457,7 +2522,9 @@ export interface CreateStackRequest { CustomJson?: string; /** - *

    The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

    + *

    The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the + * Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is + * currently 12.

    * @public */ ConfigurationManager?: StackConfigurationManager; @@ -2476,17 +2543,22 @@ export interface CreateStackRequest { UseCustomCookbooks?: boolean; /** - *

    Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

    - *

    AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are + *

    Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

    + *

    OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are * associated with layers by default. With UseOpsworksSecurityGroups you can instead * provide your own custom security groups. UseOpsworksSecurityGroups has the * following settings:

    *
      *
    • - *

      True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

      + *

      True - OpsWorks Stacks automatically associates the appropriate built-in security group with each + * layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot + * delete the built-in security group.

      *
      • *
    • - *

      False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

      + *

      False - OpsWorks Stacks does not associate built-in security groups with layers. You must create + * appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still + * manually associate a built-in security group with a layer on creation; custom security groups are required only for those + * layers that need custom settings.

      *
      • *
    *

    For more information, see Create a New @@ -2504,8 +2576,8 @@ export interface CreateStackRequest { CustomCookbooksSource?: Source; /** - *

    A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS - * OpsWorks installs the public key on the instance and you can use the private key with an SSH + *

    A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, + * OpsWorks installs the public key on the instance and you can use the private key with an SSH * client to log in to the instance. For more information, see Using SSH to * Communicate with an Instance and Managing SSH * Access. You can override this setting by specifying a different key pair, or no key @@ -2524,22 +2596,25 @@ export interface CreateStackRequest { DefaultRootDeviceType?: RootDeviceType; /** - *

    The default AWS OpsWorks Stacks agent version. You have the following options:

    + *

    The default OpsWorks Stacks agent version. You have the following options:

    *
      *
    • - *

      Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks + *

      Auto-update - Set this parameter to LATEST. OpsWorks Stacks * automatically installs new agent versions on the stack's instances as soon as * they are available.

      *
      • *
    • - *

      Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

      + *

      Fixed version - Set this parameter to your preferred agent version. To update the agent version, + * you must edit the stack configuration and specify a new version. OpsWorks Stacks installs + * that version on the stack's instances.

      *
      • *
    *

    The default setting is the most recent release of the agent. To specify an agent version, * you must use the complete version number, not the abbreviated number shown on the console. * For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

    * - *

    You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

    + *

    You can also specify an agent version when you create or update an instance, + * which overrides the stack's default setting.

    *     * @public */ @@ -2571,9 +2646,9 @@ export interface CreateUserProfileRequest { /** *

    The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If - * the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, - * my.name will be changed to myname. If you do not specify an SSH - * user name, AWS OpsWorks Stacks generates one from the IAM user name.

    + * the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example, + * my.name is changed to myname. If you do not specify an SSH + * user name, OpsWorks Stacks generates one from the IAM user name.

    * @public */ SshUsername?: string; @@ -2749,7 +2824,8 @@ export interface Deployment { Status?: string; /** - *

    A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

    + *

    A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration + * attribute values for stack or to pass data to recipes. The string should be in the following format:

    *

    * "\{\"key1\": \"value1\", \"key2\": \"value2\",...\}" *

    @@ -2815,7 +2891,8 @@ export interface DeregisterRdsDbInstanceRequest { */ export interface DeregisterVolumeRequest { /** - *

    The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.

    + *

    The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks assigned to the instance + * when you registered the volume with the stack, not the Amazon EC2 volume ID.

    * @public */ VolumeId: string | undefined; @@ -2844,7 +2921,8 @@ export interface DescribeAgentVersionsRequest { */ export interface DescribeAgentVersionsResult { /** - *

    The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.

    + *

    The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, + * not the abbreviated number used by the console.

    * @public */ AgentVersions?: AgentVersion[]; @@ -3088,7 +3166,7 @@ export interface ElasticIp { Ip?: string; /** - *

    The name.

    + *

    The name, which can be a maximum of 32 characters.

    * @public */ Name?: string; @@ -3100,7 +3178,7 @@ export interface ElasticIp { Domain?: string; /** - *

    The AWS region. For more information, see Regions and Endpoints.

    + *

    The Amazon Web Services Region. For more information, see Regions and Endpoints.

    * @public */ Region?: string; @@ -3147,13 +3225,13 @@ export interface DescribeElasticLoadBalancersRequest { */ export interface ElasticLoadBalancer { /** - *

    The Elastic Load Balancing instance's name.

    + *

    The Elastic Load Balancing instance name.

    * @public */ ElasticLoadBalancerName?: string; /** - *

    The instance's AWS region.

    + *

    The instance's Amazon Web Services Region.

    * @public */ Region?: string; @@ -3165,13 +3243,13 @@ export interface ElasticLoadBalancer { DnsName?: string; /** - *

    The ID of the stack that the instance is associated with.

    + *

    The ID of the stack with which the instance is associated.

    * @public */ StackId?: string; /** - *

    The ID of the layer that the instance is attached to.

    + *

    The ID of the layer to which the instance is attached.

    * @public */ LayerId?: string; @@ -3195,7 +3273,7 @@ export interface ElasticLoadBalancer { SubnetIds?: string[]; /** - *

    A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

    + *

    A list of the EC2 instances for which the Elastic Load Balancing instance is managing traffic.

    * @public */ Ec2InstanceIds?: string[]; @@ -3227,7 +3305,7 @@ export interface DescribeInstancesRequest { /** *

    A layer ID. If you use this parameter, DescribeInstances returns descriptions of - * the instances associated with the specified layer.

    + * the instances associated with the specified layer.

    * @public */ LayerId?: string; @@ -3362,13 +3440,21 @@ export interface Instance { EcsContainerInstanceArn?: string; /** - *

    The instance Elastic IP address .

    + *

    The instance Elastic IP address.

    * @public */ ElasticIp?: string; /** - *

    The instance host name.

    + *

    The instance host name. The following are character limits for instance host names.

    + *
      + *
    • + *

      Linux-based instances: 63 characters

      + *
      • + *
    • + *

      Windows-based instances: 15 characters

      + *
      • + *
    * @public */ Hostname?: string; @@ -3382,13 +3468,13 @@ export interface Instance { /** *

    Whether to install operating system and package updates when the instance boots. The default - * value is true. If this value is set to false, you must then update - * your instances manually by using CreateDeployment to run the + * value is true. If this value is set to false, you must update + * instances manually by using CreateDeployment to run the * update_dependencies stack command or * by manually running yum (Amazon * Linux) or apt-get (Ubuntu) on the instances.

    * - *

    We strongly recommend using the default value of true, to ensure that your + *

    We strongly recommend using the default value of true to ensure that your * instances have the latest security updates.

    *     * @public @@ -3402,7 +3488,8 @@ export interface Instance { InstanceId?: string; /** - *

    The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using + *

    The ARN of the instance's IAM profile. For more information about IAM ARNs, + * see Using * Identifiers.

    * @public */ @@ -3470,7 +3557,7 @@ export interface Instance { RegisteredBy?: string; /** - *

    The instance's reported AWS OpsWorks Stacks agent version.

    + *

    The instance's reported OpsWorks Stacks agent version.

    * @public */ ReportedAgentVersion?: string; @@ -3685,7 +3772,7 @@ export interface Layer { Type?: LayerType; /** - *

    The layer name.

    + *

    The layer name. Layer names can be a maximum of 32 characters.

    * @public */ Name?: string; @@ -3699,9 +3786,9 @@ export interface Layer { /** *

    The layer attributes.

    *

    For the HaproxyStatsPassword, MysqlRootPassword, and - * GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** + * GangliaPassword attributes, OpsWorks Stacks returns *****FILTERED***** * instead of the actual value

    - *

    For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

    + *

    For an ECS Cluster layer, OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

    * @public */ Attributes?: Partial>; @@ -3714,7 +3801,7 @@ export interface Layer { /** *

    The ARN of the default IAM profile to be used for the layer's EC2 instances. For more - * information about IAM ARNs, see Using + * information about IAM ARNs, see Using * Identifiers.

    * @public */ @@ -3773,13 +3860,13 @@ export interface Layer { AutoAssignPublicIps?: boolean; /** - *

    AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, + *

    OpsWorks Stacks supports five lifecycle events: setup, configuration, * deploy, undeploy, and shutdown. - * For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide - * custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard + * For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide + * custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard * recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of * the five events.

    - *

    To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe + *

    To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe * name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the * dbsetup.rb recipe in the repository's phpapp2 folder.

    * @public @@ -3868,14 +3955,14 @@ export interface LoadBasedAutoScalingConfiguration { /** *

    An AutoScalingThresholds object that describes the upscaling configuration, - * which defines how and when AWS OpsWorks Stacks increases the number of instances.

    + * which defines how and when OpsWorks Stacks increases the number of instances.

    * @public */ UpScaling?: AutoScalingThresholds; /** *

    An AutoScalingThresholds object that describes the downscaling configuration, - * which defines how and when AWS OpsWorks Stacks reduces the number of instances.

    + * which defines how and when OpsWorks Stacks reduces the number of instances.

    * @public */ DownScaling?: AutoScalingThresholds; @@ -3937,7 +4024,8 @@ export interface DescribeMyUserProfileResult { } /** - *

    A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.

    + *

    A block that contains information about the configuration manager (Chef) and the versions of the + * configuration manager that are supported for an operating system.

    * @public */ export interface OperatingSystemConfigurationManager { @@ -3955,18 +4043,18 @@ export interface OperatingSystemConfigurationManager { } /** - *

    Describes supported operating systems in AWS OpsWorks Stacks.

    + *

    Describes supported operating systems in OpsWorks Stacks.

    * @public */ export interface OperatingSystem { /** - *

    The name of the operating system, such as Amazon Linux 2018.03.

    + *

    The name of the operating system, such as Amazon Linux 2.

    * @public */ Name?: string; /** - *

    The ID of a supported operating system, such as Amazon Linux 2018.03.

    + *

    The ID of a supported operating system, such as Amazon Linux 2.

    * @public */ Id?: string; @@ -3978,7 +4066,7 @@ export interface OperatingSystem { Type?: string; /** - *

    Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.

    + *

    Supported configuration manager name and versions for an OpsWorks Stacks operating system.

    * @public */ ConfigurationManagers?: OperatingSystemConfigurationManager[]; @@ -4019,7 +4107,8 @@ export interface DescribeOperatingSystemsResponse { */ export interface DescribePermissionsRequest { /** - *

    The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using + *

    The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM + * ARNs, see Using * Identifiers.

    * @public */ @@ -4044,8 +4133,8 @@ export interface Permission { StackId?: string; /** - *

    The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more - * information about IAM ARNs, see Using + *

    The Amazon Resource Name (ARN) for an Identity and Access Management (IAM) role. For more + * information about IAM ARNs, see Using * Identifiers.

    * @public */ @@ -4109,7 +4198,7 @@ export interface DescribePermissionsResult { *
      *
    • *

      If the request object contains only a stack ID, the array contains a - * Permission object with permissions for each of the stack IAM ARNs.

      + * Permission object with permissions for each of the stack IAM ARNs.

      *
      • *
    • *

      If the request object contains only an IAM ARN, the array contains a @@ -4117,7 +4206,7 @@ export interface DescribePermissionsResult { *

      • *
    • *

      If the request contains a stack ID and an IAM ARN, the array contains a single - * Permission object with permissions for the specified stack and IAM ARN.

      + * Permission object with permissions for the specified stack and IAM ARN.

      *
      • *
    * @public @@ -4252,7 +4341,8 @@ export interface DescribeRaidArraysResult { */ export interface DescribeRdsDbInstancesRequest { /** - *

    The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

    + *

    The ID of the stack with which the instances are registered. The operation returns descriptions of all registered + * Amazon RDS instances.

    * @public */ StackId: string | undefined; @@ -4276,7 +4366,7 @@ export interface RdsDbInstance { RdsDbInstanceArn?: string; /** - *

    The DB instance identifier.

    + *

    The database instance identifier.

    * @public */ DbInstanceIdentifier?: string; @@ -4288,13 +4378,13 @@ export interface RdsDbInstance { DbUser?: string; /** - *

    AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

    + *

    OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

    * @public */ DbPassword?: string; /** - *

    The instance's AWS region.

    + *

    The instance's Amazon Web Services Region.

    * @public */ Region?: string; @@ -4318,7 +4408,8 @@ export interface RdsDbInstance { StackId?: string; /** - *

    Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts + *

    Set to true if OpsWorks Stacks is unable to discover the Amazon RDS instance. + * OpsWorks Stacks attempts * to discover the instance only once. If this value is set to true, you must * deregister the instance, and then register it again.

    * @public @@ -4366,7 +4457,7 @@ export interface DescribeServiceErrorsRequest { } /** - *

    Describes an AWS OpsWorks Stacks service error.

    + *

    Describes an OpsWorks Stacks service error.

    * @public */ export interface ServiceError { @@ -4436,7 +4527,7 @@ export interface DescribeStackProvisioningParametersRequest { */ export interface DescribeStackProvisioningParametersResult { /** - *

    The AWS OpsWorks Stacks agent installer's URL.

    + *

    The OpsWorks Stacks agent installer's URL.

    * @public */ AgentInstallerUrl?: string; @@ -4453,8 +4544,10 @@ export interface DescribeStackProvisioningParametersResult { */ export interface DescribeStacksRequest { /** - *

    An array of stack IDs that specify the stacks to be described. If you omit this parameter, - * DescribeStacks returns a description of every stack.

    + *

    An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information + * about all stacks, DescribeStacks returns a description of every stack. If the IAM policy that is attached to an IAM + * user limits the DescribeStacks action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. + * Otherwise, DescribeStacks returns an AccessDenied error.

    * @public */ StackIds?: string[]; @@ -4472,7 +4565,7 @@ export interface Stack { StackId?: string; /** - *

    The stack name.

    + *

    The stack name. Stack names can be a maximum of 64 characters.

    * @public */ Name?: string; @@ -4484,7 +4577,8 @@ export interface Stack { Arn?: string; /** - *

    The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.

    + *

    The stack Amazon Web Services Region, such as ap-northeast-2. For more information about + * Amazon Web Services Regions, see Regions and Endpoints.

    * @public */ Region?: string; @@ -4502,14 +4596,14 @@ export interface Stack { Attributes?: Partial>; /** - *

    The stack AWS Identity and Access Management (IAM) role.

    + *

    The stack Identity and Access Management (IAM) role.

    * @public */ ServiceRoleArn?: string; /** *

    The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. - * For more information about IAM ARNs, see Using + * For more information about IAM ARNs, see Using * Identifiers.

    * @public */ @@ -4540,7 +4634,9 @@ export interface Stack { DefaultSubnetId?: string; /** - *

    A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

    + *

    A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. + * You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. + * The string should be in the following format:

    *

    * "\{\"key1\": \"value1\", \"key2\": \"value2\",...\}" *

    @@ -4570,7 +4666,7 @@ export interface Stack { UseCustomCookbooks?: boolean; /** - *

    Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.

    + *

    Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers.

    * @public */ UseOpsworksSecurityGroups?: boolean; @@ -4584,7 +4680,8 @@ export interface Stack { CustomCookbooksSource?: Source; /** - *

    A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

    + *

    A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or + * update an instance.

    * @public */ DefaultSshKeyName?: string; @@ -4597,7 +4694,8 @@ export interface Stack { /** *

    The default root device type. This value is used by default for all instances in the stack, - * but you can override it when you create an instance. For more information, see Storage for the Root Device.

    + * but you can override it when you create an instance. For more information, see Storage for the Root Device. + *

    * @public */ DefaultRootDeviceType?: RootDeviceType; @@ -4831,11 +4929,13 @@ export interface DescribeTimeBasedAutoScalingRequest { *

    The key is the time period (a UTC hour) and must be an integer from 0 - 23.

    * *
  • - *

    The value indicates whether the instance should be online or offline for the specified period, and must be set to "on" or "off"

    + *

    The value indicates whether the instance should be online or offline for the specified period, and must be + * set to "on" or "off"

    *
    • * *

    The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

    - *

    The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.

    + *

    The following example specifies that the instance should be online for four hours, + * from UTC 1200 - 1600. It will be off for the remainder of the day.

    *

    * \{ "12":"on", "13":"on", "14":"on", "15":"on" \} *

    @@ -5028,7 +5128,7 @@ export interface Volume { Ec2VolumeId?: string; /** - *

    The volume name.

    + *

    The volume name. Volume names are a maximum of 128 characters.

    * @public */ Name?: string; @@ -5070,7 +5170,8 @@ export interface Volume { MountPoint?: string; /** - *

    The AWS region. For more information about AWS regions, see Regions and Endpoints.

    + *

    The Amazon Web Services Region. For more information about Amazon Web Services Regions, see + * Regions and Endpoints.

    * @public */ Region?: string; @@ -5095,15 +5196,17 @@ export interface Volume { * *
  • *

    - * gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

    + * gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size + * of 16384 GiB.

    *
    • *
  • - *

    - * st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    + *

    + * st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a + * minimum size of 125 GiB and a maximum size of 16384 GiB.

    *
    • *
  • - *

    - * sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    + *

    + * sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.

    *
    • * * @public @@ -5198,13 +5301,15 @@ export interface GetHostnameSuggestionResult { */ export interface GrantAccessRequest { /** - *

    The instance's AWS OpsWorks Stacks ID.

    + *

    The instance's OpsWorks Stacks ID.

    * @public */ InstanceId: string | undefined; /** - *

    The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

    + *

    The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, + * the user will no longer be able to use the credentials to log in. If the user is logged in at the time, they are + * logged out.

    * @public */ ValidForInMinutes?: number; @@ -5228,13 +5333,15 @@ export interface TemporaryCredential { Password?: string; /** - *

    The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.

    + *

    The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, + * the user will no longer be able to use the credentials to log in. If they are logged in at the time, they are + * automatically logged out.

    * @public */ ValidForInMinutes?: number; /** - *

    The instance's AWS OpsWorks Stacks ID.

    + *

    The instance's OpsWorks Stacks ID.

    * @public */ InstanceId?: string; @@ -5283,14 +5390,16 @@ export interface ListTagsRequest { ResourceArn: string | undefined; /** - *

    Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call. + *

    Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest + * call. *

    * @public */ MaxResults?: number; /** - *

    Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call. + *

    Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest + * call. *

    * @public */ @@ -5399,7 +5508,15 @@ export interface RegisterInstanceRequest { StackId: string | undefined; /** - *

    The instance's hostname.

    + *

    The instance's host name. The following are character limits for instance host names.

    + *
      + *
    • + *

      Linux-based instances: 63 characters

      + *
      • + *
    • + *

      Windows-based instances: 15 characters

      + *
      • + *
    * @public */ Hostname?: string; @@ -5441,7 +5558,7 @@ export interface RegisterInstanceRequest { */ export interface RegisterInstanceResult { /** - *

    The registered instance's AWS OpsWorks Stacks ID.

    + *

    The registered instance's OpsWorks Stacks ID.

    * @public */ InstanceId?: string; @@ -5523,7 +5640,7 @@ export interface SetLoadBasedAutoScalingRequest { /** *

    An AutoScalingThresholds object with the upscaling threshold configuration. If - * the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified + * the load exceeds these thresholds for a specified amount of time, OpsWorks Stacks starts a specified * number of instances.

    * @public */ @@ -5531,7 +5648,7 @@ export interface SetLoadBasedAutoScalingRequest { /** *

    An AutoScalingThresholds object with the downscaling threshold configuration. If - * the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified + * the load falls below these thresholds for a specified amount of time, OpsWorks Stacks stops a specified * number of instances.

    * @public */ @@ -5652,8 +5769,10 @@ export interface StopInstanceRequest { /** *

    Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, - * adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. - * You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.

    + * adding the Force parameter to the StopInstances API call disassociates the OpsWorks Stacks + * instance from EC2, and forces deletion of only the OpsWorks Stacks instance. + * You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the OpsWorks Stacks + * instance with a new one.

    * @public */ Force?: boolean; @@ -5687,11 +5806,13 @@ export interface TagResourceRequest { *

    The key cannot be empty.

    * *
  • - *

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / + *

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, + * or the following special characters: + - = . _ : / *

    *
    • *
  • - *

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / + *

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, + * or the following special characters: + - = . _ : / *

    *
    • *
  • @@ -5815,7 +5936,9 @@ export interface UpdateAppRequest { *

    An array of EnvironmentVariable objects that specify environment variables to be * associated with the app. After you deploy the app, these variables are defined on the * associated app server instances.For more information, see Environment Variables.

    - *

    There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."

    + *

    There is no specific limit on the number of environment variables. However, the size of the associated data structure - + * which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most + * if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."

    * *

    If you have specified one or more environment variables, you cannot modify the stack's Chef version.

    *     @@ -5835,7 +5958,7 @@ export interface UpdateElasticIpRequest { ElasticIp: string | undefined; /** - *

    The new name.

    + *

    The new name, which can be a maximum of 32 characters.

    * @public */ Name?: string; @@ -5874,20 +5997,29 @@ export interface UpdateInstanceRequest { AutoScalingType?: AutoScalingType; /** - *

    The instance host name.

    + *

    The instance host name. The following are character limits for instance host names.

    + *
      + *
    • + *

      Linux-based instances: 63 characters

      + *
      • + *
    • + *

      Windows-based instances: 15 characters

      + *
      • + *
    * @public */ Hostname?: string; /** - *

    The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

    + *

    The instance's operating system, which must be set to one of the following. You cannot update an instance that is using + * a custom AMI.

    *
      *
    • - *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux + *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux * 2015.03.

      *
      • *
    • - *

      A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      + *

      A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      *
      • *
    • *

      @@ -5904,12 +6036,11 @@ export interface UpdateInstanceRequest { * Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

      *
      • *
    - *

    For more information about supported operating systems, - * see AWS OpsWorks Stacks Operating Systems.

    + *

    Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, + * see OpsWorks Stacks Operating Systems.

    *

    The default option is the current Amazon Linux version. If you set this parameter to * Custom, you must use the AmiId parameter to - * specify the custom AMI that you want to use. For more information about supported operating - * systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using + * specify the custom AMI that you want to use. For more information about how to use custom AMIs with OpsWorks, see Using * Custom AMIs.

    * *

    You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

    @@ -5919,8 +6050,10 @@ export interface UpdateInstanceRequest { Os?: string; /** - *

    The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. - * You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. + *

    The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the + * instance is already using. + * You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using + * custom AMIs. *

    * @public */ @@ -5962,7 +6095,7 @@ export interface UpdateInstanceRequest { EbsOptimized?: boolean; /** - *

    The default AWS OpsWorks Stacks agent version. You have the following options:

    + *

    The default OpsWorks Stacks agent version. You have the following options:

    *
      *
    • *

      @@ -5974,7 +6107,7 @@ export interface UpdateInstanceRequest { * This value overrides the stack's default setting. * To update the agent version, you must edit the instance configuration and specify a * new version. - * AWS OpsWorks Stacks then automatically installs that version on the instance.

      + * OpsWorks Stacks installs that version on the instance.

      *
      • *
    *

    The default setting is INHERIT. To specify an agent version, @@ -5997,15 +6130,18 @@ export interface UpdateLayerRequest { LayerId: string | undefined; /** - *

    The layer name, which is used by the console.

    + *

    The layer name, which is used by the console. Layer names can be a maximum of 32 characters.

    * @public */ Name?: string; /** - *

    For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

    - *

    The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference - *

    + *

    For custom layers only, use this parameter to specify the layer's short name, which is used internally by + * OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files + * are installed. It can have a maximum of 32 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

    + *

    Built-in layer short names are defined by OpsWorks Stacks. For more information, see the + * Layer reference in the OpsWorks User Guide. + *

    * @public */ Shortname?: string; @@ -6017,14 +6153,15 @@ export interface UpdateLayerRequest { Attributes?: Partial>; /** - *

    Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

    + *

    Specifies CloudWatch Logs configuration options for the layer. For more information, + * see CloudWatchLogsLogStream.

    * @public */ CloudWatchLogsConfiguration?: CloudWatchLogsConfiguration; /** *

    The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more - * information about IAM ARNs, see Using + * information about IAM ARNs, see Using * Identifiers.

    * @public */ @@ -6159,7 +6296,7 @@ export interface UpdateStackRequest { StackId: string | undefined; /** - *

    The stack's new name.

    + *

    The stack's new name. Stack names can be a maximum of 64 characters.

    * @public */ Name?: string; @@ -6178,7 +6315,7 @@ export interface UpdateStackRequest { /** *

    The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. - * For more information about IAM ARNs, see Using + * For more information about IAM ARNs, see Using * Identifiers.

    * @public */ @@ -6188,11 +6325,11 @@ export interface UpdateStackRequest { *

    The stack's operating system, which must be set to one of the following:

    *
      *
    • - *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, + *

      A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, * Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

      *
      • *
    • - *

      A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      + *

      A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      *
      • *
    • *

      @@ -6210,13 +6347,13 @@ export interface UpdateStackRequest { *

      • *
    • *

      A custom AMI: Custom. You specify the custom AMI you want to use when - * you create instances. For more information about how to use custom AMIs with OpsWorks, see Using + * you create instances. For more information about how to use custom AMIs with OpsWorks, see Using * Custom AMIs.

      *
      • *
    *

    The default option is the stack's current operating system. - * For more information about supported operating systems, - * see AWS OpsWorks Stacks Operating Systems.

    + * Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, + * see OpsWorks Stacks Operating Systems.

    * @public */ DefaultOs?: string; @@ -6224,7 +6361,8 @@ export interface UpdateStackRequest { /** *

    The stack's new host name theme, with spaces replaced by underscores. * The theme is used to generate host names for the stack's instances. - * By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the + * By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to + * the * layer's short name. The other themes are:

    *