The interactive configuration object that enables the interactive use cases for an application.
" + } } }, "traits": { @@ -1474,6 +1480,12 @@ "traits": { "smithy.api#documentation": "The configuration setting for monitoring.
" } + }, + "interactiveConfiguration": { + "target": "com.amazonaws.emrserverless#InteractiveConfiguration", + "traits": { + "smithy.api#documentation": "The interactive configuration object that enables the interactive use cases \n to use when running an application.
" + } } } }, @@ -1955,6 +1967,26 @@ } } }, + "com.amazonaws.emrserverless#InteractiveConfiguration": { + "type": "structure", + "members": { + "studioEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.
" + } + }, + "livyEndpointEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enables an Apache Livy endpoint that you can connect to and run interactive jobs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration to use to enable the different types of interactive use cases in an application.
" + } + }, "com.amazonaws.emrserverless#InternalServerException": { "type": "structure", "members": { @@ -3482,6 +3514,12 @@ "smithy.api#documentation": "The key-value pairs that specify worker type to\n WorkerTypeSpecificationInput. This parameter must contain all valid worker\n types for a Spark or Hive application. Valid worker types include Driver and\n Executor for Spark applications and HiveDriver and\n TezTask for Hive applications. You can either set image details in this\n parameter for each worker type, or in imageConfiguration for all worker\n types.
The interactive configuration object that contains new interactive use cases \n when the application is updated.
" + } + }, "releaseLabel": { "target": "com.amazonaws.emrserverless#ReleaseLabel", "traits": { diff --git a/codegen/sdk-codegen/aws-models/opsworks.json b/codegen/sdk-codegen/aws-models/opsworks.json index 4398a58ebf0..042be462c60 100644 --- a/codegen/sdk-codegen/aws-models/opsworks.json +++ b/codegen/sdk-codegen/aws-models/opsworks.json @@ -139,7 +139,7 @@ "Environment": { "target": "com.amazonaws.opsworks#EnvironmentVariables", "traits": { - "smithy.api#documentation": "An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n 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 variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an \"Environment: is too large (maximum is 20 KB)\" message.
\nAn array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances. For more information, see Environment Variables.
There is no specific limit on the number of environment variables. \n However, the size of the associated data structure - which includes the variable names, values, and protected flag \n values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you \n will cause an exception (API) with an \"Environment: is too large (maximum is 20 KB)\" message.
\nAssign a registered instance to a layer.
\nYou can assign registered on-premises instances to any layer type.
\nYou can assign registered Amazon EC2 instances only to custom layers.
\nYou cannot use this action with instances that were created with AWS OpsWorks Stacks.
\n\n Required Permissions: To use this action, an AWS Identity and Access Management\n (IAM) user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Assign a registered instance to a layer.
\nYou can assign registered on-premises instances to any layer type.
\nYou can assign registered Amazon EC2 instances only to custom layers.
\nYou cannot use this action with instances that were created with OpsWorks Stacks.
\n\n Required Permissions: To use this action, an Identity and Access Management\n (IAM) user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#AssignInstanceRequest": { @@ -314,7 +314,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must\n first be registered with the stack by calling RegisterVolume. After you register the\n volume, you must call UpdateVolume to specify a mount point before calling\n AssignVolume. For more information, see Resource Management.
\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must\n first be registered with the stack by calling RegisterVolume. After you register the\n volume, you must call UpdateVolume to specify a mount point before calling\n AssignVolume. For more information, see Resource Management.
\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#AssignVolumeRequest": { @@ -355,7 +355,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates one of the stack's registered Elastic IP addresses with a specified instance. The\n address must first be registered with the stack by calling RegisterElasticIp. For more\n information, see Resource\n Management.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Associates one of the stack's registered Elastic IP addresses with a specified instance. The\n address must first be registered with the stack by calling RegisterElasticIp. For more\n information, see Resource\n Management.
\n\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#AssociateElasticIpRequest": { @@ -396,7 +396,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support \n Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. \n For more information, see Elastic Load\n Balancing.
\nYou must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For\n more information, see Elastic\n Load Balancing Developer Guide.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support \n Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. \n For more information, see Elastic Load\n Balancing.
\nYou must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For\n more information, see the Elastic Load Balancing Developer Guide.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#AttachElasticLoadBalancerRequest": { @@ -439,7 +439,7 @@ "IgnoreMetricsTime": { "target": "com.amazonaws.opsworks#Minute", "traits": { - "smithy.api#documentation": "The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics\n and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following\n an upscaling event but the instances won't start reducing the load until they have been booted\n and configured. There is no point in raising additional scaling events during that operation,\n which typically takes several minutes. IgnoreMetricsTime allows you to direct\n AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.
The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics\n and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following\n an upscaling event but the instances won't start reducing the load until they have been booted\n and configured. There is no point in raising additional scaling events during that operation,\n which typically takes several minutes. IgnoreMetricsTime allows you to direct\n OpsWorks Stacks to suppress scaling events long enough to get the new instances online.
The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
" + "smithy.api#documentation": "The load threshold. A value of -1 disables the threshold. For more information about how load is computed, \n see Load (computing).
" } }, "Alarms": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names,\n which are case sensitive and must be in the same region as the stack.
\nTo use custom alarms, you must update your service role to allow\n cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for\n you when you first use this feature or you can edit the role manually. For more information,\n see Allowing AWS OpsWorks Stacks to Act on Your Behalf.
Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names,\n which are case sensitive and must be in the same region as the stack.
\nTo use custom alarms, you must update your service role to allow\n cloudwatch:DescribeAlarms. You can either have OpsWorks Stacks update the role for\n you when you first use this feature or you can edit the role manually. For more information,\n see Allowing OpsWorks Stacks to Act on Your Behalf.
Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.
" + "smithy.api#documentation": "Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when OpsWorks Stacks starts or \n stops load-based instances.
" } }, "com.amazonaws.opsworks#AutoScalingType": { @@ -494,7 +494,7 @@ "DeviceName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The device name that is exposed to the instance, such as /dev/sdh. For the root\n device, you can use the explicit device name or you can set this parameter to\n ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.
The device name that is exposed to the instance, such as /dev/sdh. For the root\n device, you can use the explicit device name or you can set this parameter to\n ROOT_DEVICE and OpsWorks Stacks will provide the correct device name.
The cloned stack name.
" + "smithy.api#documentation": "The cloned stack name. Stack names can be a maximum of 64 characters.
" } }, "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The cloned stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see\n Regions and Endpoints.
" + "smithy.api#documentation": "The cloned stack Amazon Web Services Region, such as ap-northeast-2. For more information \n about Amazon Web Services Regions, see\n Regions and Endpoints.
The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All\n instances are launched into this VPC, and you cannot change the ID later.
\nIf your account supports EC2 Classic, the default value is no VPC.
\nIf your account does not support EC2 Classic, the default value is the default VPC for the specified region.
\nIf the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
\nIt must belong to a VPC in your account that is in the specified region.
\nYou 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\n VPC. For more information about default VPC and EC2 Classic, see Supported\n Platforms.
" + "smithy.api#documentation": "The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All\n instances are launched into this VPC, and you cannot change the ID later.
\nIf your account supports EC2 Classic, the default value is no VPC.
\nIf your account does not support EC2 Classic, the default value is the default VPC for the specified region.
\nIf the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
\nIt must belong to a VPC in your account that is in the specified region.
\nYou must specify a value for DefaultSubnetId.
For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2 Classic, see Supported\n Platforms.
" } }, "Attributes": { @@ -606,20 +606,20 @@ "ServiceRoleArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for\n you. You can obtain an existing stack's IAM ARN programmatically by calling\n DescribePermissions. For more information about IAM ARNs, see Using\n Identifiers.
\nYou 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.
\nThe stack Identity and Access Management (IAM) role, which allows OpsWorks Stacks to work with Amazon Web Services\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. If you create a stack by using the OpsWorkss Stacks console, it creates the role for\n you. You can obtain an existing stack's IAM ARN programmatically by calling\n DescribePermissions. For more information about IAM ARNs, see \n Using\n Identifiers.
\nYou must set this parameter to a valid service role ARN or the action will fail; there is no default value. \n You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
\nThe Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's \n EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
" } }, "DefaultOs": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack's operating system, which must be set to one of the following.
\nA supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux\n 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.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
\n Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.
The default option is the parent stack's operating system.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.
\nYou can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.
\nThe stack's operating system, which must be set to one of the following.
\nA 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\n 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
\n Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.
The default option is the parent stack's operating system.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.
\nYou can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to \n Windows or Windows to Linux.
\nA 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:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes\n
" + "smithy.api#documentation": "A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration \n JSON values. The string should be in the following format:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes\n
" } }, "ConfigurationManager": { "target": "com.amazonaws.opsworks#StackConfigurationManager", "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the \n 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.
" } }, "ChefConfiguration": { @@ -667,19 +667,19 @@ "UseOpsworksSecurityGroups": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
\nAWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n 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.
\nFalse - 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.
\nFor more information, see Create a New\n Stack.
" + "smithy.api#documentation": "Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
\nOpsWorks Stacks provides a standard set of security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:
True - OpsWorks Stacks automatically associates the appropriate built-in security group with \n each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot \n delete the built-in security group.
\nFalse - OpsWorks Stacks does not associate built-in security groups with layers. \n You must create appropriate Amazon EC2 security groups and associate a security group with each \n layer that you create. However, you can still manually associate a built-in security group with a layer on creation; \n custom security groups are required only for those layers that need custom settings.
\nFor more information, see Create a New\n Stack.
" } }, "CustomCookbooksSource": { "target": "com.amazonaws.opsworks#Source", "traits": { - "smithy.api#documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or Cookbooks and Recipes.
" + "smithy.api#documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.
" } }, "DefaultSshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS\n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.
" + "smithy.api#documentation": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, \n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.
" } }, "ClonePermissions": { @@ -703,7 +703,7 @@ "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The default AWS OpsWorks Stacks agent version. You have the following options:
\nAuto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.
Fixed version - Set this parameter to your preferred agent version. To update \n the agent version, you must edit the stack configuration and specify a new version. \n AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
\nThe default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n 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.
\nThe default OpsWorks Stacks agent version. You have the following options:
\nAuto-update - Set this parameter to LATEST. OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.
Fixed version - Set this parameter to your preferred agent version. To update \n the agent version, you must edit the stack configuration and specify a new version. \n OpsWorks Stacks automatically installs that version on the stack's instances.
\nThe default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n 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 \n default setting.
\nDescribes the Amazon CloudWatch logs configuration for a layer.
" + "smithy.api#documentation": "Describes the Amazon CloudWatch Logs configuration for a layer.
" } }, "com.amazonaws.opsworks#CloudWatchLogsEncoding": { @@ -1303,7 +1303,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.
Specifies the encoding of the log file so that the file can be read correctly. \n The default is utf_8. Encodings supported by Python codecs.decode() can be used here.
Specifies log files that you want to push to CloudWatch Logs.
\n\n File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*).\n 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\n of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on\n by using a pattern like access_log.*. Don't use a wildcard to match multiple file types,\n such as access_log_80 and access_log_443. To specify multiple, different file types, add another\n 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.
" + "smithy.api#documentation": "Specifies log files that you want to push to CloudWatch Logs.
\n\n File can point to a specific file or multiple files (by using wild card characters such \n as /var/log/system.log*).\n Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use \n wild card characters to specify a series\n of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on\n by using a pattern like access_log.*. Don't use a wildcard to match multiple file types,\n such as access_log_80 and access_log_443. To specify multiple, different file types, add another\n 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.
" } }, "FileFingerprintLines": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, \n such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are \n not sent to CloudWatch Logs unless all specified lines are available.
" + "smithy.api#documentation": "Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, \n such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. \n Fingerprint lines are \n not sent to CloudWatch Logs unless all specified lines are available.
" } }, "MultiLineStartPattern": { @@ -1397,7 +1397,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
" + "smithy.api#documentation": "Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, \n see the CloudWatch Logs Agent Reference.
" } }, "com.amazonaws.opsworks#CloudWatchLogsLogStreams": { @@ -1406,7 +1406,7 @@ "target": "com.amazonaws.opsworks#CloudWatchLogsLogStream" }, "traits": { - "smithy.api#documentation": "Describes the Amazon CloudWatch logs configuration for a layer.
" + "smithy.api#documentation": "Describes the Amazon CloudWatch Logs configuration for a layer.
" } }, "com.amazonaws.opsworks#CloudWatchLogsTimeZone": { @@ -1426,7 +1426,7 @@ } }, "traits": { - "smithy.api#documentation": "The preferred time zone for logs streamed to CloudWatch Logs. Valid values are LOCAL and UTC, for Coordinated Universal Time.
The preferred time zone for logs streamed to CloudWatch Logs. \n Valid values are LOCAL and UTC, for Coordinated Universal Time.
The app type. Each supported type is associated with a particular layer. For example, PHP\n applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances\n that are members of the corresponding layer. If your app isn't one of the standard types, or\n you prefer to implement your own Deploy recipes, specify other.
The app type. Each supported type is associated with a particular layer. For example, PHP\n applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances\n that are members of the corresponding layer. If your app isn't one of the standard types, or\n you prefer to implement your own Deploy recipes, specify other.
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:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes and \n Overriding Attributes With Custom JSON.
" + "smithy.api#documentation": "A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default \n stack configuration JSON values. The string should be in the following format:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes and \n Overriding Attributes With Custom \n JSON.
" } } }, @@ -1748,7 +1748,7 @@ "InstanceType": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.
The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. \n For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.
The instance host name.
" + "smithy.api#documentation": "The instance host name. The following are character limits for instance host names.
\nLinux-based instances: 63 characters
\nWindows-based instances: 15 characters
\nThe instance's operating system, which must be set to one of the following.
\nA 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, \n 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.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n\t\t\t Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom.
For more information about the supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.
\nThe default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the CreateInstance action's AmiId parameter to\n 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\n systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using\n Custom AMIs.
The instance's operating system, which must be set to one of the following.
\nA 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, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n\t\t\t Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom.
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems,\n see OpsWorks Stacks Operating Systems.
\nThe default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the CreateInstance action's AmiId parameter to\n specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. \n For more information about how to use custom AMIs with OpsWorks Stacks, see Using\n Custom AMIs.
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.
" + "smithy.api#documentation": "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 \n default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
" } }, "Architecture": { @@ -1833,13 +1833,13 @@ "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The default AWS OpsWorks Stacks agent version. You have the following options:
\n\n INHERIT - Use the stack's default agent version setting.
\n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, edit the instance configuration and specify a\n new version.\n AWS OpsWorks Stacks then automatically installs that version on the instance.
\nThe default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
The default OpsWorks Stacks agent version. You have the following options:
\n\n INHERIT - Use the stack's default agent version setting.
\n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, edit the instance configuration and specify a\n new version.\n OpsWorks Stacks installs that version on the instance.
\nThe default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n AgentVersion cannot be set to Chef 12.2.
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, \n inherit tenancy settings from the VPC. The following are valid values for this parameter: \n dedicated, default, or host. Because there are costs associated with changes \n in tenancy options, we recommend that you research tenancy options before choosing them for your instances. \n For more information about dedicated hosts, see \n Dedicated Hosts Overview and \n Amazon EC2 Dedicated Hosts. \n For more information about dedicated instances, see \n Dedicated Instances and \n Amazon EC2 Dedicated Instances.
Creates a layer. For more information, see How to\n Create a Layer.
\nYou should use CreateLayer for noncustom layer types such as PHP App Server only if the stack\n does not have an existing layer of that type. A stack can have at most one instance of each\n noncustom layer; if you attempt to create a second instance, CreateLayer fails. A\n stack can have an arbitrary number of custom layers, so you can call CreateLayer as\n many times as you like for that layer type.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Creates a layer. For more information, see How to\n Create a Layer.
\nYou should use CreateLayer for noncustom layer types such as \n PHP App Server only if the stack\n does not have an existing layer of that type. A stack can have at most one instance of each\n noncustom layer; if you attempt to create a second instance, CreateLayer fails. A\n stack can have an arbitrary number of custom layers, so you can call CreateLayer as\n many times as you like for that layer type.
\n\n Required Permissions: To use this action, an IAM user must \n have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#CreateLayerRequest": { @@ -1895,21 +1895,21 @@ "Type": { "target": "com.amazonaws.opsworks#LayerType", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "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. \n Built-in layers are not available in Chef 12 stacks.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The layer name, which is used by the console.
", + "smithy.api#documentation": "The layer name, which is used by the console. Layer names can be a maximum of 32 characters.
", "smithy.api#required": {} } }, "Shortname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "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 '.'.
\nThe built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.
", + "smithy.api#documentation": "For custom layers only, use this parameter to specify the layer's short name, which is used internally by \n OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your \n app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric \n characters, '-', '_', and '.'.
\nBuilt-in layer short names are defined by OpsWorks Stacks. For more information, see the \n Layer Reference.
", "smithy.api#required": {} } }, @@ -1922,19 +1922,19 @@ "CloudWatchLogsConfiguration": { "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", "traits": { - "smithy.api#documentation": "Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
" + "smithy.api#documentation": "Specifies CloudWatch Logs configuration options for the layer. For more information, \n see CloudWatchLogsLogStream.
" } }, "CustomInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The ARN of an IAM profile to be used for the layer's EC2 instances. For more information\n about IAM ARNs, see Using Identifiers.
" + "smithy.api#documentation": "The ARN of an IAM profile to be used for the layer's EC2 instances. For more information\n about IAM ARNs, see Using Identifiers.
" } }, "CustomJson": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI. \n
" + "smithy.api#documentation": "A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI. \n
" } }, "CustomSecurityGroupIds": { @@ -2040,21 +2040,21 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack name.
", + "smithy.api#documentation": "The stack name. Stack names can be a maximum of 64 characters.
", "smithy.api#required": {} } }, "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack's AWS region, such as ap-south-1. For more information about\n Amazon regions, see Regions and Endpoints.
In the AWS CLI, this API maps to the --stack-region parameter. If the\n --stack-region parameter and the AWS CLI common parameter\n --region are set to the same value, the stack uses a\n regional endpoint. If the --stack-region\n parameter is not set, but the AWS CLI --region parameter is, this also\n results in a stack with a regional endpoint. However, if the\n --region parameter is set to us-east-1, and the\n --stack-region parameter is set to one of the following, then the\n stack uses a legacy or classic region: us-west-1,\n us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1,\n ap-southeast-2. In this case, the actual API endpoint of the stack is in\n us-east-1. Only the preceding regions are supported as classic\n regions in the us-east-1 API endpoint. Because it is a best practice to\n choose the regional endpoint that is closest to where you manage AWS, we recommend\n that you use regional endpoints for new stacks. The AWS CLI common\n --region parameter always specifies a regional API endpoint; it\n cannot be used to specify a classic AWS OpsWorks Stacks region.
The stack's Amazon Web Services Region, such as ap-south-1. For more information about\n Amazon Web Services Regions, see Regions and Endpoints.
In the CLI, this API maps to the --stack-region parameter. If the\n --stack-region parameter and the CLI common parameter\n --region are set to the same value, the stack uses a\n regional endpoint. If the --stack-region\n parameter is not set, but the CLI --region parameter is, this also\n results in a stack with a regional endpoint. However, if the\n --region parameter is set to us-east-1, and the\n --stack-region parameter is set to one of the following, then the\n stack uses a legacy or classic region: us-west-1,\n us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1,\n ap-southeast-2. In this case, the actual API endpoint of the stack is in\n us-east-1. Only the preceding regions are supported as classic\n regions in the us-east-1 API endpoint. Because it is a best practice to\n choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend\n that you use regional endpoints for new stacks. The CLI common\n --region parameter always specifies a regional API endpoint; it\n cannot be used to specify a classic OpsWorks Stacks region.
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.
\nIf your account supports EC2-Classic, the default value is no VPC.
If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
\nIf the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n AWS OpsWorks Stacks infers the value of the \n other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
\nIt must belong to a VPC in your account that is in the specified region.
\nYou 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\n VPC. For more information about default VPC and EC2-Classic, see Supported\n Platforms.
" + "smithy.api#documentation": "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 \n into this VPC. You cannot change the ID later.
\nIf your account supports EC2-Classic, the default value is no VPC.
If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
\nIf the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n OpsWorks Stacks infers the value of the \n other parameter. If you specify neither parameter, OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
\nIt must belong to a VPC in your account that is in the specified region.
\nYou must specify a value for DefaultSubnetId.
For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2-Classic, see Supported\n Platforms.
" } }, "Attributes": { @@ -2066,21 +2066,21 @@ "ServiceRoleArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. For more information about IAM ARNs, see Using\n Identifiers.
", + "smithy.api#documentation": "The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. For more information about IAM ARNs, see \n Using\n Identifiers.
", "smithy.api#required": {} } }, "DefaultInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
", "smithy.api#required": {} } }, "DefaultOs": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "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.
\nA 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, \n 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.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, \n Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or \n Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more\n information, see \n Using Custom AMIs.
The default option is the current Amazon Linux version.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.
" + "smithy.api#documentation": "The stack's default operating system, which is installed on every instance unless you specify a different operating \n system when you create the instance. You can specify one of the following.
\nA 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, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, \n Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or \n Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more\n information, see \n Using Custom AMIs.
The default option is the current Amazon Linux version.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.
" } }, "HostnameTheme": { @@ -2104,13 +2104,13 @@ "CustomJson": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "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:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" + "smithy.api#documentation": "A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration \n attribute values or to pass data to recipes. The string should be in the following format:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" } }, "ConfigurationManager": { "target": "com.amazonaws.opsworks#StackConfigurationManager", "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the \n Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is \n currently 12.
" } }, "ChefConfiguration": { @@ -2128,7 +2128,7 @@ "UseOpsworksSecurityGroups": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
\nAWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n 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.
\nFalse - 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.
\nFor more information, see Create a New\n Stack.
" + "smithy.api#documentation": "Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
\nOpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:
True - OpsWorks Stacks automatically associates the appropriate built-in security group with each \n layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot \n delete the built-in security group.
\nFalse - OpsWorks Stacks does not associate built-in security groups with layers. You must create \n appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still \n manually associate a built-in security group with a layer on creation; custom security groups are required only for those \n layers that need custom settings.
\nFor more information, see Create a New\n Stack.
" } }, "CustomCookbooksSource": { @@ -2140,7 +2140,7 @@ "DefaultSshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS\n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.
" + "smithy.api#documentation": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, \n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.
" } }, "DefaultRootDeviceType": { @@ -2152,7 +2152,7 @@ "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The default AWS OpsWorks Stacks agent version. You have the following options:
\nAuto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n 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.
\nThe default setting is the most recent release of the agent. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
\nYou can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
\nThe default OpsWorks Stacks agent version. You have the following options:
\nAuto-update - Set this parameter to LATEST. OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, \n you must edit the stack configuration and specify a new version. OpsWorks Stacks installs \n that version on the stack's instances.
\nThe default setting is the most recent release of the agent. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
\nYou can also specify an agent version when you create or update an instance, \n which overrides the stack's default setting.
\nThe user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS OpsWorks Stacks generates one from the IAM user name.
The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example,\n my.name is changed to myname. If you do not specify an SSH\n user name, OpsWorks Stacks generates one from the IAM user name.
Deletes a specified app.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Deletes a specified app.
\n\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#DeleteAppRequest": { @@ -2336,7 +2336,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
\nFor more information, see Deleting\n Instances.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before \n you can delete it.
\nFor more information, see Deleting\n Instances.
\n\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#DeleteInstanceRequest": { @@ -2383,7 +2383,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified layer. You must first stop and then delete all associated instances or\n unassign registered instances. For more information, see How to\n Delete a Layer.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Deletes a specified layer. You must first stop and then delete all associated instances or\n unassign registered instances. For more information, see How to\n Delete a Layer.
\n\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#DeleteLayerRequest": { @@ -2453,7 +2453,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a user profile.
\n\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Deletes a user profile.
\n\n Required Permissions: To use this action, an IAM user must have an attached \n policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#DeleteUserProfileRequest": { @@ -2537,7 +2537,7 @@ "CustomJson": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "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:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" + "smithy.api#documentation": "A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration \n attribute values for stack or to pass data to recipes. The string should be in the following format:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" } }, "InstanceIds": { @@ -2557,14 +2557,14 @@ "Name": { "target": "com.amazonaws.opsworks#DeploymentCommandName", "traits": { - "smithy.api#documentation": "Specifies the operation. You can specify only one command.
\nFor stacks, the following commands are available:
\n\n execute_recipes: Execute one or more recipes. To specify the recipes, set an\n Args parameter named recipes to the list of recipes to be\n executed. For example, to execute phpapp::appsetup, set Args to\n {\"recipes\":[\"phpapp::appsetup\"]}.
\n install_dependencies: Install the stack's dependencies.
\n update_custom_cookbooks: Update the stack's custom cookbooks.
\n update_dependencies: Update the stack's dependencies.
The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.
\nFor apps, the following commands are available:
\n\n deploy: Deploy an app. Ruby on Rails apps have an optional Args\n parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to\n migrate the database. The default setting is {\"migrate\":[\"false\"]}.
\n rollback Roll the app back to the previous version. When you update an app,\n AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this\n command to roll an app back as many as four versions.
\n start: Start the app's web or application server.
\n stop: Stop the app's web or application server.
\n restart: Restart the app's web or application server.
\n undeploy: Undeploy the app.
Specifies the operation. You can specify only one command.
\nFor stacks, the following commands are available:
\n\n execute_recipes: Execute one or more recipes. To specify the recipes, set an\n Args parameter named recipes to the list of recipes to be\n executed. For example, to execute phpapp::appsetup, set Args to\n {\"recipes\":[\"phpapp::appsetup\"]}.
\n install_dependencies: Install the stack's dependencies.
\n update_custom_cookbooks: Update the stack's custom cookbooks.
\n update_dependencies: Update the stack's dependencies.
The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.
\nFor apps, the following commands are available:
\n\n deploy: Deploy an app. Ruby on Rails apps have an optional Args\n parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to\n migrate the database. The default setting is {\"migrate\":[\"false\"]}.
\n rollback Roll the app back to the previous version. When you update an app,\n OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this\n command to roll an app back as many as four versions.
\n start: Start the app's web or application server.
\n stop: Stop the app's web or application server.
\n restart: Restart the app's web or application server.
\n undeploy: Undeploy the app.
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
\n\n {\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...],\n ...}\n
The update_dependencies command takes two arguments:
\n upgrade_os_to - Specifies the desired Amazon Linux version for instances\n whose OS you want to upgrade, such as Amazon Linux 2016.09. You must also set\n the allow_reboot argument to true.
\n allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if\n necessary, after installing the updates. This argument can be set to either\n true or false. The default value is false.
For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the\n following.
\n { \"upgrade_os_to\":[\"Amazon Linux 2016.09\"], \"allow_reboot\":[\"true\"] } \n
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
\n\n {\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...],\n ...}\n
The update_dependencies command takes two arguments:
\n upgrade_os_to - Specifies the Amazon Linux version that you want instances\n to run, such as Amazon Linux 2. You must also set\n the allow_reboot argument to true.
\n allow_reboot - Specifies whether to allow OpsWorks Stacks to reboot the instances if\n necessary, after installing the updates. This argument can be set to either\n true or false. The default value is false.
For example, to upgrade an instance to Amazon Linux 2018.03, set Args to the\n following.
\n { \"upgrade_os_to\":[\"Amazon Linux 2018.03\"], \"allow_reboot\":[\"true\"] } \n
Deregisters a specified Amazon ECS cluster from a stack.\n For more information, see\n \n Resource Management.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see\n https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
" + "smithy.api#documentation": "Deregisters a specified Amazon ECS cluster from a stack.\n For more information, see\n \n Resource Management.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see\n https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
" } }, "com.amazonaws.opsworks#DeregisterEcsClusterRequest": { @@ -2716,7 +2716,7 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters a specified Elastic IP address. The address can then be registered by another\n stack. For more information, see Resource Management.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Deregisters a specified Elastic IP address. The address can be registered by another\n stack after it is deregistered. For more information, see Resource Management.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#DeregisterElasticIpRequest": { @@ -2751,7 +2751,7 @@ } ], "traits": { - "smithy.api#documentation": "Deregister a registered Amazon EC2 or on-premises instance. This action removes the \n instance from the stack and returns it to your control. This action cannot be used with \n instances that were created with AWS OpsWorks Stacks.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. \n This action removes the instance from the stack and returns it to your control.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#DeregisterInstanceRequest": { @@ -2830,7 +2830,7 @@ "VolumeId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks assigned to the instance \n when you registered the volume with the stack, not the Amazon EC2 volume ID.
", "smithy.api#required": {} } } @@ -2856,7 +2856,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a\n configuration manager. DescribeAgentVersions returns a list of available\n agent versions for the specified stack or configuration manager.
Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a\n configuration manager. DescribeAgentVersions returns a list of available\n agent versions for the specified stack or configuration manager.
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.
" + "smithy.api#documentation": "The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, \n not the abbreviated number used by the console.
" } } }, @@ -2911,7 +2911,7 @@ } ], "traits": { - "smithy.api#documentation": "Requests a description of a specified set of apps.
\nThis call accepts only one resource-identifying parameter.
\n\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.
", + "smithy.api#documentation": "Requests a description of a specified set of apps.
\nThis call accepts only one resource-identifying parameter.
\n\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, \n or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.
", "smithy.waiters#waitable": { "AppExists": { "acceptors": [ @@ -3135,7 +3135,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID,\n you can use the MaxResults and NextToken parameters to paginate the\n response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result\n set has a maximum of one element.
\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack or an attached policy that explicitly grants\n permission. For more information about user permissions, see Managing User\n Permissions.
\nThis call accepts only one resource-identifying parameter.
", + "smithy.api#documentation": "Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID,\n you can use the MaxResults and NextToken parameters to paginate the\n response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result\n set has a maximum of one element.
\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack or an attached policy that explicitly grants\n permission. For more information about user permissions, see Managing User\n Permissions.
\nThis call accepts only one resource-identifying parameter.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3727,7 +3727,7 @@ "LayerId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "A layer ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified layer.
A layer ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified layer.
Describes the operating systems that are supported by AWS OpsWorks Stacks.
" + "smithy.api#documentation": "Describes the operating systems that are supported by OpsWorks Stacks.
" } }, "com.amazonaws.opsworks#DescribeOperatingSystemsResponse": { @@ -3941,7 +3941,7 @@ "IamUserArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM \n ARNs, see Using\n Identifiers.
" } }, "StackId": { @@ -3961,7 +3961,7 @@ "Permissions": { "target": "com.amazonaws.opsworks#Permissions", "traits": { - "smithy.api#documentation": "An array of Permission objects that describe the stack permissions.
If the request object contains only a stack ID, the array contains a\n Permission object with permissions for each of the stack IAM ARNs.
If the request object contains only an IAM ARN, the array contains a\n Permission object with permissions for each of the user's stack IDs.
If the request contains a stack ID and an IAM ARN, the array contains a single\n Permission object with permissions for the specified stack and IAM ARN.
An array of Permission objects that describe the stack permissions.
If the request object contains only a stack ID, the array contains a\n Permission object with permissions for each of the stack IAM ARNs.
If the request object contains only an IAM ARN, the array contains a\n Permission object with permissions for each of the user's stack IDs.
If the request contains a stack ID and an IAM ARN, the array contains a single\n Permission object with permissions for the specified stack and IAM ARN.
The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.
", + "smithy.api#documentation": "The ID of the stack with which the instances are registered. The operation returns descriptions of all registered \n Amazon RDS instances.
", "smithy.api#required": {} } }, @@ -4104,7 +4104,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes AWS OpsWorks Stacks service errors.
\n\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.
\nThis call accepts only one resource-identifying parameter.
" + "smithy.api#documentation": "Describes OpsWorks Stacks service errors.
\n\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.
\nThis call accepts only one resource-identifying parameter.
" } }, "com.amazonaws.opsworks#DescribeServiceErrorsRequest": { @@ -4189,7 +4189,7 @@ "AgentInstallerUrl": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The AWS OpsWorks Stacks agent installer's URL.
" + "smithy.api#documentation": "The OpsWorks Stacks agent installer's URL.
" } }, "Parameters": { @@ -4280,7 +4280,7 @@ "StackIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "An array of stack IDs that specify the stacks to be described. If you omit this parameter,\n 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 \n about all stacks, DescribeStacks returns a description of every stack. If the IAM policy that is attached to an IAM \n 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. \n Otherwise, DescribeStacks returns an AccessDenied error.
Detaches a specified Elastic Load Balancing instance from its layer.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Detaches a specified Elastic Load Balancing instance from its layer.
\n\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#DetachElasticLoadBalancerRequest": { @@ -4570,7 +4570,7 @@ "VolumeType": { "target": "com.amazonaws.opsworks#VolumeType", "traits": { - "smithy.api#documentation": "The volume type. gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.
If you specify the io1 volume type, you must also specify a value for the Iops attribute. \n The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) \n specified in the AMI attributes to set IOPS to 50 x (volume size).
The volume type. gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.
If you specify the io1 volume type, you must also specify a value for the Iops attribute. \n The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. Amazon Web Services uses the default volume size (in GiB) \n specified in the AMI attributes to set IOPS to 50 x (volume size).
The name.
" + "smithy.api#documentation": "The name, which can be a maximum of 32 characters.
" } }, "Domain": { @@ -4646,7 +4646,7 @@ "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The AWS region. For more information, see Regions and Endpoints.
" + "smithy.api#documentation": "The Amazon Web Services Region. For more information, see Regions and Endpoints.
" } }, "InstanceId": { @@ -4672,13 +4672,13 @@ "ElasticLoadBalancerName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The Elastic Load Balancing instance's name.
" + "smithy.api#documentation": "The Elastic Load Balancing instance name.
" } }, "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance's AWS region.
" + "smithy.api#documentation": "The instance's Amazon Web Services Region.
" } }, "DnsName": { @@ -4690,13 +4690,13 @@ "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The ID of the stack that the instance is associated with.
" + "smithy.api#documentation": "The ID of the stack with which the instance is associated.
" } }, "LayerId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The ID of the layer that the instance is attached to.
" + "smithy.api#documentation": "The ID of the layer to which the instance is attached.
" } }, "VpcId": { @@ -4720,7 +4720,7 @@ "Ec2InstanceIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
" + "smithy.api#documentation": "A list of the EC2 instances for which the Elastic Load Balancing instance is managing traffic.
" } } }, @@ -4740,21 +4740,21 @@ "Key": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
", + "smithy.api#documentation": "(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. \n The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.
", + "smithy.api#documentation": "(Optional) The environment variable's value, which can be left empty. If you specify a value, \n it can contain up to 256 characters, which must all be printable.
", "smithy.api#required": {} } }, "Secure": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "(Optional) Whether the variable's value will be returned by the DescribeApps action.\n To conceal an environment variable's value, set Secure to true.\n DescribeApps then returns *****FILTERED***** instead of the actual\n value. The default value for Secure is false.
(Optional) Whether the variable's value is returned by the DescribeApps action.\n To hide an environment variable's value, set Secure to true.\n DescribeApps returns *****FILTERED***** instead of the actual\n value. The default value for Secure is false.
The instance's AWS OpsWorks Stacks ID.
", + "smithy.api#documentation": "The instance's OpsWorks Stacks ID.
", "smithy.api#required": {} } }, "ValidForInMinutes": { "target": "com.amazonaws.opsworks#ValidForInMinutes", "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, \n 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 \n logged out.
" } } }, @@ -4961,13 +4961,13 @@ "ElasticIp": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance Elastic IP address .
" + "smithy.api#documentation": "The instance Elastic IP address.
" } }, "Hostname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance host name.
" + "smithy.api#documentation": "The instance host name. The following are character limits for instance host names.
\nLinux-based instances: 63 characters
\nWindows-based instances: 15 characters
\nWhether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must then update\n your instances manually by using CreateDeployment to run the\n update_dependencies stack command or\n by manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.
Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must update\n instances manually by using CreateDeployment to run the\n update_dependencies stack command or\n by manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true to ensure that your\n instances have the latest security updates.
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The ARN of the instance's IAM profile. For more information about IAM ARNs, \n see Using\n Identifiers.
" } }, "InstanceType": { @@ -5057,7 +5057,7 @@ "ReportedAgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance's reported AWS OpsWorks Stacks agent version.
" + "smithy.api#documentation": "The instance's reported OpsWorks Stacks agent version.
" } }, "ReportedOs": { @@ -5324,7 +5324,7 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The layer name.
" + "smithy.api#documentation": "The layer name. Layer names can be a maximum of 32 characters.
" } }, "Shortname": { @@ -5336,7 +5336,7 @@ "Attributes": { "target": "com.amazonaws.opsworks#LayerAttributes", "traits": { - "smithy.api#documentation": "The layer attributes.
\nFor the HaproxyStatsPassword, MysqlRootPassword, and\n GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED*****\n instead of the actual value
For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.
The layer attributes.
\nFor the HaproxyStatsPassword, MysqlRootPassword, and\n GangliaPassword attributes, OpsWorks Stacks returns *****FILTERED*****\n instead of the actual value
For an ECS Cluster layer, OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.
The ARN of the default IAM profile to be used for the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The ARN of the default IAM profile to be used for the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.
" } }, "CustomJson": { @@ -5402,7 +5402,7 @@ "DefaultRecipes": { "target": "com.amazonaws.opsworks#Recipes", "traits": { - "smithy.api#documentation": "AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, \n deploy, undeploy, and shutdown.\n For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide \n custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard \n recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of \n the five events.
To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe \n name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the \n dbsetup.rb recipe in the repository's phpapp2 folder.
OpsWorks Stacks supports five lifecycle events: setup, configuration, \n deploy, undeploy, and shutdown.\n For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide \n custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard \n recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of \n the five events.
To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe \n name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the \n dbsetup.rb recipe in the repository's phpapp2 folder.
Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call.\n
Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest \n call.\n
Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call.\n
Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest \n call.\n
An AutoScalingThresholds object that describes the upscaling configuration,\n which defines how and when AWS OpsWorks Stacks increases the number of instances.
An AutoScalingThresholds object that describes the upscaling configuration,\n which defines how and when OpsWorks Stacks increases the number of instances.
An AutoScalingThresholds object that describes the downscaling configuration,\n which defines how and when AWS OpsWorks Stacks reduces the number of instances.
An AutoScalingThresholds object that describes the downscaling configuration,\n which defines how and when OpsWorks Stacks reduces the number of instances.
The name of the operating system, such as Amazon Linux 2018.03.
The name of the operating system, such as Amazon Linux 2.
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.
Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.
" + "smithy.api#documentation": "Supported configuration manager name and versions for an OpsWorks Stacks operating system.
" } }, "ReportedName": { @@ -5873,7 +5873,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes supported operating systems in AWS OpsWorks Stacks.
" + "smithy.api#documentation": "Describes supported operating systems in OpsWorks Stacks.
" } }, "com.amazonaws.opsworks#OperatingSystemConfigurationManager": { @@ -5893,7 +5893,7 @@ } }, "traits": { - "smithy.api#documentation": "A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.
" + "smithy.api#documentation": "A block that contains information about the configuration manager (Chef) and the versions of the \n configuration manager that are supported for an operating system.
" } }, "com.amazonaws.opsworks#OperatingSystemConfigurationManagers": { @@ -6147,7 +6147,7 @@ "name": "opsworks" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and\n usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error\n codes.
\nAWS OpsWorks Stacks is an application management service that provides an integrated experience for\n overseeing the complete application lifecycle. For information about this product, go to the\n AWS OpsWorks details page.
\n\n\n SDKs and CLI\n
\nThe 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:
\n\n AWS CLI\n
\n\n AWS SDK for Java\n
\n\n AWS SDK for\n .NET\n
\n\n AWS\n SDK for PHP 2\n
\n\n AWS SDK for Ruby\n
\n\n AWS SDK for Node.js\n
\n\n Endpoints\n
\nAWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks \n can only be accessed or managed within the endpoint in which they are created.
\nopsworks.us-east-1.amazonaws.com
\nopsworks.us-east-2.amazonaws.com
\nopsworks.us-west-1.amazonaws.com
\nopsworks.us-west-2.amazonaws.com
\nopsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)
\nopsworks.eu-west-1.amazonaws.com
\nopsworks.eu-west-2.amazonaws.com
\nopsworks.eu-west-3.amazonaws.com
\nopsworks.eu-central-1.amazonaws.com
\nopsworks.ap-northeast-1.amazonaws.com
\nopsworks.ap-northeast-2.amazonaws.com
\nopsworks.ap-south-1.amazonaws.com
\nopsworks.ap-southeast-1.amazonaws.com
\nopsworks.ap-southeast-2.amazonaws.com
\nopsworks.sa-east-1.amazonaws.com
\n\n Chef Versions\n
\nWhen you call CreateStack, CloneStack, or UpdateStack we recommend you\n use the ConfigurationManager parameter to specify the Chef version.\n The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,\n see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
\nWelcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, \n and\n usage examples for OpsWorks Stacks actions and data types, including common parameters and error\n codes.
\nOpsWorks Stacks is an application management service that provides an integrated experience for\n managing the complete application lifecycle. For information about OpsWorks, see the\n OpsWorks information page.
\n\n SDKs and CLI\n
\nUse the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the \n Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:
\n\n CLI\n
\n\n SDK for Java\n
\n\n SDK for .NET\n
\n\n SDK for PHP\n
\n\n SDK for Ruby\n
\n\n Endpoints\n
\nOpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. \n Stacks can only be accessed or managed within the endpoint in which they are created.
\nopsworks.us-east-1.amazonaws.com
\nopsworks.us-east-2.amazonaws.com
\nopsworks.us-west-1.amazonaws.com
\nopsworks.us-west-2.amazonaws.com
\nopsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)
\nopsworks.eu-west-1.amazonaws.com
\nopsworks.eu-west-2.amazonaws.com
\nopsworks.eu-west-3.amazonaws.com
\nopsworks.eu-central-1.amazonaws.com
\nopsworks.ap-northeast-1.amazonaws.com
\nopsworks.ap-northeast-2.amazonaws.com
\nopsworks.ap-south-1.amazonaws.com
\nopsworks.ap-southeast-1.amazonaws.com
\nopsworks.ap-southeast-2.amazonaws.com
\nopsworks.sa-east-1.amazonaws.com
\n\n Chef Versions\n
\nWhen you call CreateStack, CloneStack, or UpdateStack we recommend you\n use the ConfigurationManager parameter to specify the Chef version.\n The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,\n see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks \n to Chef 12 as soon as possible.
\nThe Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more\n information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an Identity and Access Management (IAM) role. For more\n information about IAM ARNs, see Using\n Identifiers.
" } }, "AllowSsh": { @@ -7121,7 +7121,7 @@ "DbInstanceIdentifier": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The DB instance identifier.
" + "smithy.api#documentation": "The database instance identifier.
" } }, "DbUser": { @@ -7133,13 +7133,13 @@ "DbPassword": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
The instance's AWS region.
" + "smithy.api#documentation": "The instance's Amazon Web Services Region.
" } }, "Address": { @@ -7163,7 +7163,7 @@ "MissingOnRds": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts\n to discover the instance only once. If this value is set to true, you must\n deregister the instance, and then register it again.
Set to true if OpsWorks Stacks is unable to discover the Amazon RDS instance. \n OpsWorks Stacks attempts\n to discover the instance only once. If this value is set to true, you must\n deregister the instance, and then register it again.
AWS OpsWorks Stacks supports five\n lifecycle events:\n setup, configuration, deploy, undeploy, and shutdown. For\n each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide\n custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the\n standard recipes. LayerCustomRecipes specifies the custom recipes for a\n 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.
" + "smithy.api#documentation": "OpsWorks Stacks supports five\n lifecycle events:\n setup, configuration, deploy, undeploy, and shutdown. For\n each layer, OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide\n custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the\n standard recipes. LayerCustomRecipes specifies the custom recipes for a\n 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, \n which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in \n the repository's phpapp2 folder.
" } }, "com.amazonaws.opsworks#RegisterEcsCluster": { @@ -7381,7 +7381,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
\nWe do not recommend using this action to register instances. The complete registration\n operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering\n the instance with the stack. RegisterInstance handles only the second step. You\n should instead use the AWS CLI register command, which performs the entire\n registration operation. For more information,\n see \n Registering an Instance with an AWS OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. \n For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance \n type. For more information about requirements for instances that you want to register, see \n Preparing the Instance.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Registers instances that were created outside of OpsWorks Stacks with a specified stack.
\nWe do not recommend using this action to register instances. The complete registration\n operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and registering\n the instance with the stack. RegisterInstance handles only the second step. You\n should instead use the CLI register command, which performs the entire\n registration operation. For more information,\n see \n Registering an Instance with an OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance \n API. \n For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance \n type. For more information about requirements for instances that you want to register, see \n Preparing the Instance.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#RegisterInstanceRequest": { @@ -7397,7 +7397,7 @@ "Hostname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance's hostname.
" + "smithy.api#documentation": "The instance's host name. The following are character limits for instance host names.
\nLinux-based instances: 63 characters
\nWindows-based instances: 15 characters
\nThe registered instance's AWS OpsWorks Stacks ID.
" + "smithy.api#documentation": "The registered instance's OpsWorks Stacks ID.
" } } }, @@ -7696,7 +7696,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes an AWS OpsWorks Stacks service error.
" + "smithy.api#documentation": "Describes an OpsWorks Stacks service error.
" } }, "com.amazonaws.opsworks#ServiceErrors": { @@ -7722,7 +7722,7 @@ } ], "traits": { - "smithy.api#documentation": "Specify the load-based auto scaling configuration for a specified layer. For more\n information, see Managing\n Load with Time-based and Load-based Instances.
\nTo use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Specify the load-based auto scaling configuration for a specified layer. For more\n information, see Managing\n Load with Time-based and Load-based Instances.
\nTo use load-based auto scaling, you must create a set of load-based auto scaling instances. \n Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough \n instances to handle the maximum anticipated load.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#SetLoadBasedAutoScalingRequest": { @@ -7744,13 +7744,13 @@ "UpScaling": { "target": "com.amazonaws.opsworks#AutoScalingThresholds", "traits": { - "smithy.api#documentation": "An AutoScalingThresholds object with the upscaling threshold configuration. If\n the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified\n number of instances.
An AutoScalingThresholds object with the upscaling threshold configuration. If\n the load exceeds these thresholds for a specified amount of time, OpsWorks Stacks starts a specified\n number of instances.
An AutoScalingThresholds object with the downscaling threshold configuration. If\n the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified\n number of instances.
An AutoScalingThresholds object with the downscaling threshold configuration. If\n the load falls below these thresholds for a specified amount of time, OpsWorks Stacks stops a specified\n number of instances.
Specifies a user's permissions. For more information, see Security and\n Permissions.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Specifies a user's permissions. For more information, see \n Security and\n Permissions.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#SetPermissionRequest": { @@ -7865,7 +7865,7 @@ "ExecutionTimeout": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.
" + "smithy.api#documentation": "The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before \n shutting down an instance.
" } }, "DelayUntilElbConnectionsDrained": { @@ -7891,7 +7891,7 @@ "Url": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.
The source URL. The following is an example of an Amazon S3 source \n URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.
When included in a request, the parameter depends on the repository type.
\nFor Amazon S3 bundles, set Password to the appropriate IAM secret access\n key.
For HTTP bundles and Subversion repositories, set Password to the\n password.
For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
\nIn responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
When included in a request, the parameter depends on the repository type.
\nFor Amazon S3 bundles, set Password to the appropriate IAM secret access\n key.
For HTTP bundles and Subversion repositories, set Password to the\n password.
For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
\nIn responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
In requests, the repository's SSH key.
\nIn responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
In requests, the repository's SSH key.
\nIn responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
" + "smithy.api#documentation": "The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. \n One of the simplest approaches is to have branches or revisions in your repository that represent different \n versions that can potentially be deployed.
" } } }, @@ -7992,7 +7992,7 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack name.
" + "smithy.api#documentation": "The stack name. Stack names can be a maximum of 64 characters.
" } }, "Arn": { @@ -8004,7 +8004,7 @@ "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see Regions and Endpoints.
" + "smithy.api#documentation": "The stack Amazon Web Services Region, such as ap-northeast-2. For more information about \n Amazon Web Services Regions, see Regions and Endpoints.
The stack AWS Identity and Access Management (IAM) role.
" + "smithy.api#documentation": "The stack Identity and Access Management (IAM) role.
" } }, "DefaultInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
" } }, "DefaultOs": { @@ -8058,7 +8058,7 @@ "CustomJson": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "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:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" + "smithy.api#documentation": "A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. \n You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. \n The string should be in the following format:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" } }, "ConfigurationManager": { @@ -8082,7 +8082,7 @@ "UseOpsworksSecurityGroups": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.
" + "smithy.api#documentation": "Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers.
" } }, "CustomCookbooksSource": { @@ -8094,7 +8094,7 @@ "DefaultSshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
" + "smithy.api#documentation": "A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or \n update an instance.
" } }, "CreatedAt": { @@ -8106,7 +8106,7 @@ "DefaultRootDeviceType": { "target": "com.amazonaws.opsworks#RootDeviceType", "traits": { - "smithy.api#documentation": "The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.
" + "smithy.api#documentation": "The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.\n
" } }, "AgentVersion": { @@ -8146,13 +8146,13 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The name. This parameter must be set to \"Chef\".
" + "smithy.api#documentation": "The name. This parameter must be set to Chef.
The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.
" + "smithy.api#documentation": "The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. \n The default value for Linux stacks is 12.
" } } }, @@ -8297,7 +8297,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a specified instance. When you stop a standard instance, the data disappears and must\n be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without\n losing data. For more information, see Starting,\n Stopping, and Rebooting Instances.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Stops a specified instance. When you stop a standard instance, the data disappears and must\n be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without\n losing data. For more information, see Starting,\n Stopping, and Rebooting Instances.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#StopInstanceRequest": { @@ -8313,7 +8313,7 @@ "Force": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, \n 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. \n You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.
Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, \n adding the Force parameter to the StopInstances API call disassociates the OpsWorks Stacks \n instance from EC2, and forces deletion of only the OpsWorks Stacks instance. \n You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the OpsWorks Stacks \n instance with a new one.
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
" + "smithy.api#documentation": "Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how \n tagging works, see Tags in the OpsWorks User Guide.
" } }, "com.amazonaws.opsworks#TagResourceRequest": { @@ -8410,7 +8410,7 @@ "Tags": { "target": "com.amazonaws.opsworks#Tags", "traits": { - "smithy.api#documentation": "A map that contains tag keys and tag values that are attached to a stack or layer.
\nThe key cannot be empty.
\nThe key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n
Leading and trailing white spaces are trimmed from both the key and value.
\nA maximum of 40 tags is allowed for any resource.
\nA map that contains tag keys and tag values that are attached to a stack or layer.
\nThe key cannot be empty.
\nThe key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, \n or the following special characters: + - = . _ : /\n
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, \n or the following special characters: + - = . _ : /\n
Leading and trailing white spaces are trimmed from both the key and value.
\nA maximum of 40 tags is allowed for any resource.
\nThe 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.
" + "smithy.api#documentation": "The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, \n the user will no longer be able to use the credentials to log in. If they are logged in at the time, they are \n automatically logged out.
" } }, "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance's AWS OpsWorks Stacks ID.
" + "smithy.api#documentation": "The instance's OpsWorks Stacks ID.
" } } }, @@ -8506,7 +8506,7 @@ } ], "traits": { - "smithy.api#documentation": "Unassigns a registered instance from all layers that are using the instance. \n The instance remains in the stack as an unassigned instance, and can be assigned to \n another layer as needed. You cannot use this action with instances that were created \n with AWS OpsWorks Stacks.
\n\n Required Permissions: To use this action, an IAM user must \n have a Manage permissions level for the stack or an attached policy that explicitly \n grants permissions. For more information about user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Unassigns a registered instance from all layers that are using the instance. \n The instance remains in the stack as an unassigned instance, and can be assigned to \n another layer as needed. You cannot use this action with instances that were created \n with OpsWorks Stacks.
\n\n Required Permissions: To use this action, an IAM user must \n have a Manage permissions level for the stack or an attached policy that explicitly \n grants permissions. For more information about user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#UnassignInstanceRequest": { @@ -8688,7 +8688,7 @@ "Environment": { "target": "com.amazonaws.opsworks#EnvironmentVariables", "traits": { - "smithy.api#documentation": "An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n 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).\"
\nIf you have specified one or more environment variables, you cannot modify the stack's Chef version.
\nAn array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n 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 - \n which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most \n if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20 KB).\"
\nIf you have specified one or more environment variables, you cannot modify the stack's Chef version.
\nThe new name.
" + "smithy.api#documentation": "The new name, which can be a maximum of 32 characters.
" } } }, @@ -8788,19 +8788,19 @@ "Hostname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The instance host name.
" + "smithy.api#documentation": "The instance host name. The following are character limits for instance host names.
\nLinux-based instances: 63 characters
\nWindows-based instances: 15 characters
\nThe instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.
\nA 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\n 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n 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,\n see AWS OpsWorks Stacks Operating Systems.
\nThe default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the AmiId parameter to\n specify the custom AMI that you want to use. For more information about supported operating\n systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using\n 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.
\nThe instance's operating system, which must be set to one of the following. You cannot update an instance that is using \n a custom AMI.
\nA 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\n 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.
\nThe default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the AmiId parameter to\n specify the custom AMI that you want to use. For more information about how to use custom AMIs with OpsWorks, see Using\n 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.
\nThe 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. \n You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.\n
" + "smithy.api#documentation": "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 \n instance is already using. \n You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using \n custom AMIs.\n
" } }, "SshKeyName": { @@ -8830,7 +8830,7 @@ "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The default AWS OpsWorks Stacks agent version. You have the following options:
\n\n INHERIT - Use the stack's default agent version setting.
\n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, you must edit the instance configuration and specify a\n new version.\n AWS OpsWorks Stacks then automatically installs that version on the instance.
\nThe default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions.
AgentVersion cannot be set to Chef 12.2.
" + "smithy.api#documentation": "The default OpsWorks Stacks agent version. You have the following options:
\n\n INHERIT - Use the stack's default agent version setting.
\n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, you must edit the instance configuration and specify a\n new version.\n OpsWorks Stacks installs that version on the instance.
\nThe default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions.
AgentVersion cannot be set to Chef 12.2.
" } } }, @@ -8871,13 +8871,13 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The layer name, which is used by the console.
" + "smithy.api#documentation": "The layer name, which is used by the console. Layer names can be a maximum of 32 characters.
" } }, "Shortname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "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/.
\nThe built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference\n
" + "smithy.api#documentation": "For custom layers only, use this parameter to specify the layer's short name, which is used internally by \n OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files \n are installed. It can have a maximum of 32 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.
\nBuilt-in layer short names are defined by OpsWorks Stacks. For more information, see the \n Layer reference in the OpsWorks User Guide.\n
" } }, "Attributes": { @@ -8889,13 +8889,13 @@ "CloudWatchLogsConfiguration": { "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", "traits": { - "smithy.api#documentation": "Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
" + "smithy.api#documentation": "Specifies CloudWatch Logs configuration options for the layer. For more information, \n see CloudWatchLogsLogStream.
" } }, "CustomInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.
" } }, "CustomJson": { @@ -9080,7 +9080,7 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack's new name.
" + "smithy.api#documentation": "The stack's new name. Stack names can be a maximum of 64 characters.
" } }, "Attributes": { @@ -9098,19 +9098,19 @@ "DefaultInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
" + "smithy.api#documentation": "The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.
" } }, "DefaultOs": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack's operating system, which must be set to one of the following:
\nA 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, \n 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.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.
The default option is the stack's current operating system.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.
" + "smithy.api#documentation": "The stack's operating system, which must be set to one of the following:
\nA 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, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
\n CentOS Linux 7\n
\n Red Hat Enterprise Linux 7\n
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.
The default option is the stack's current operating system.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.
" } }, "HostnameTheme": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The stack's new host name theme, with spaces replaced by underscores.\n The theme is used to generate host names for the stack's instances.\n By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the\n layer's short name. The other themes are:
\n Baked_Goods\n
\n Clouds\n
\n Europe_Cities\n
\n Fruits\n
\n Greek_Deities_and_Titans\n
\n Legendary_creatures_from_Japan\n
\n Planets_and_Moons\n
\n Roman_Deities\n
\n Scottish_Islands\n
\n US_Cities\n
\n Wild_Cats\n
To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.
The stack's new host name theme, with spaces replaced by underscores.\n The theme is used to generate host names for the stack's instances.\n By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to \n the\n layer's short name. The other themes are:
\n Baked_Goods\n
\n Clouds\n
\n Europe_Cities\n
\n Fruits\n
\n Greek_Deities_and_Titans\n
\n Legendary_creatures_from_Japan\n
\n Planets_and_Moons\n
\n Roman_Deities\n
\n Scottish_Islands\n
\n US_Cities\n
\n Wild_Cats\n
To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" + "smithy.api#documentation": "A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration \n JSON values or to pass data to recipes. The string should be in the following format:
\n\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n
For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.
" } }, "ConfigurationManager": { "target": "com.amazonaws.opsworks#StackConfigurationManager", "traits": { - "smithy.api#documentation": "The configuration manager. When you update 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.
" + "smithy.api#documentation": "The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the \n 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.
" } }, "ChefConfiguration": { @@ -9152,13 +9152,13 @@ "CustomCookbooksSource": { "target": "com.amazonaws.opsworks#Source", "traits": { - "smithy.api#documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or Cookbooks and Recipes.
" + "smithy.api#documentation": "Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.
" } }, "DefaultSshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "A default Amazon EC2 key-pair name. The default value is\n none. If you specify a key-pair name,\n AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.
A default Amazon EC2 key-pair name. The default value is\n none. If you specify a key-pair name,\n OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
\nAWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. UseOpsworksSecurityGroups allows you to\n provide your own custom security groups\n instead of using the built-in groups. UseOpsworksSecurityGroups has\n 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.
\nFalse - 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. Custom security groups are required only for those layers that need custom settings.
\nFor more information, see Create a New\n Stack.
" + "smithy.api#documentation": "Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
\nOpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. UseOpsworksSecurityGroups allows you to\n provide your own custom security groups\n instead of using the built-in groups. UseOpsworksSecurityGroups has\n the following settings:
True - OpsWorks Stacks automatically associates the appropriate built-in security group with each \n layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot \n delete the built-in security group.
\nFalse - OpsWorks Stacks does not associate built-in security groups with layers. You must create \n appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still \n manually associate a built-in security group with a layer on. Custom security groups are required only for those layers \n that need custom settings.
\nFor more information, see Create a New\n Stack.
" } }, "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The default AWS OpsWorks Stacks agent version. You have the following options:
\nAuto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n 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.
\nThe default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n 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.
\nThe default OpsWorks Stacks agent version. You have the following options:
\nAuto-update - Set this parameter to LATEST. OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must \n edit the stack configuration and specify a new version. OpsWorks Stacks installs that version \n on the stack's instances.
\nThe default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n 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 \n setting.
\nThe user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS OpsWorks Stacks generates one from the IAM user name.
The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, OpsWorks Stacks generates one from the IAM user name.
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" + "smithy.api#documentation": "Updates an Amazon EBS volume's name or mount point. For more information, see \n Resource Management.
\n\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.
" } }, "com.amazonaws.opsworks#UpdateVolumeRequest": { @@ -9270,7 +9270,7 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The new name.
" + "smithy.api#documentation": "The new name. Volume names can be a maximum of 128 characters.
" } }, "MountPoint": { @@ -9387,7 +9387,7 @@ "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The volume name.
" + "smithy.api#documentation": "The volume name. Volume names are a maximum of 128 characters.
" } }, "RaidArrayId": { @@ -9429,7 +9429,7 @@ "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The AWS region. For more information about AWS regions, see Regions and Endpoints.
" + "smithy.api#documentation": "The Amazon Web Services Region. For more information about Amazon Web Services Regions, see \n Regions and Endpoints.
" } }, "AvailabilityZone": { @@ -9441,7 +9441,7 @@ "VolumeType": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "The volume type. For more information, see \n Amazon EBS Volume Types.
\n\n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.
\n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.
\n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.
\n 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.
\n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.
The volume type. For more information, see \n Amazon EBS Volume Types.
\n\n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.
\n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.
\n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size \n of 16384 GiB.
\n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a \n minimum size of 125 GiB and a maximum size of 16384 GiB.
\n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.
The volume type. For more information, see \n Amazon EBS Volume Types.
\n\n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.
\n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.
\n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.
\n 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.
\n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.
The volume type. For more information, see \n Amazon EBS Volume Types.
\n\n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.
\n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.
\n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size \n of 16384 GiB.
\n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a \n minimum size of 125 GiB and a maximum size of 16384 GiB.
\n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.
Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.
\nThe key is the time period (a UTC hour) and must be an integer from 0 - 23.
\nThe value indicates whether the instance should be online or offline for the specified period, and must be set to \"on\" or \"off\"
\nThe 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.
\nThe 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.
\n\n { \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" } \n
Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.
\nThe key is the time period (a UTC hour) and must be an integer from 0 - 23.
\nThe value indicates whether the instance should be online or offline for the specified period, and must be \n set to \"on\" or \"off\"
\nThe 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.
\nThe following example specifies that the instance should be online for four hours, \n from UTC 1200 - 1600. It will be off for the remainder of the day.
\n\n { \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" } \n