aws-sdk 1.9.5 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. data/lib/aws/api_config/DynamoDB-2012-08-10.yml +4 -0
  2. data/lib/aws/api_config/EC2-2013-02-01.yml +1 -1
  3. data/lib/aws/api_config/ElasticTranscoder-2012-09-25.yml +948 -19
  4. data/lib/aws/api_config/OpsWorks-2013-02-18.yml +83 -2
  5. data/lib/aws/auto_scaling/client.rb +15 -0
  6. data/lib/aws/cloud_formation/client.rb +11 -0
  7. data/lib/aws/cloud_front/client.rb +58 -40
  8. data/lib/aws/cloud_search/client.rb +20 -0
  9. data/lib/aws/cloud_watch/client.rb +5 -0
  10. data/lib/aws/core.rb +5 -4
  11. data/lib/aws/core/configuration.rb +3 -1
  12. data/lib/aws/core/policy.rb +27 -1
  13. data/lib/aws/data_pipeline/client.rb +12 -0
  14. data/lib/aws/direct_connect/client.rb +11 -0
  15. data/lib/aws/dynamo_db/client.rb +17 -0
  16. data/lib/aws/dynamo_db/client_v2.rb +905 -417
  17. data/lib/aws/ec2.rb +1 -1
  18. data/lib/aws/ec2/client.rb +88 -0
  19. data/lib/aws/ec2/instance.rb +3 -1
  20. data/lib/aws/ec2/security_group.rb +1 -1
  21. data/lib/aws/elastic_beanstalk/client.rb +21 -0
  22. data/lib/aws/elastic_transcoder/client.rb +681 -114
  23. data/lib/aws/elasticache/client.rb +23 -0
  24. data/lib/aws/elb/client.rb +13 -0
  25. data/lib/aws/emr/client.rb +3 -0
  26. data/lib/aws/glacier/client.rb +7 -0
  27. data/lib/aws/iam/client.rb +35 -0
  28. data/lib/aws/import_export/client.rb +5 -0
  29. data/lib/aws/ops_works/client.rb +718 -238
  30. data/lib/aws/rds/client.rb +46 -0
  31. data/lib/aws/redshift/client.rb +30 -0
  32. data/lib/aws/route_53/client.rb +10 -0
  33. data/lib/aws/s3.rb +1 -1
  34. data/lib/aws/s3/client.rb +42 -27
  35. data/lib/aws/s3/client/xml.rb +10 -0
  36. data/lib/aws/s3/multipart_upload.rb +43 -16
  37. data/lib/aws/s3/s3_object.rb +61 -26
  38. data/lib/aws/s3/uploaded_part.rb +3 -1
  39. data/lib/aws/s3/uploaded_part_collection.rb +1 -1
  40. data/lib/aws/simple_db/client.rb +10 -0
  41. data/lib/aws/simple_email_service/client.rb +11 -0
  42. data/lib/aws/simple_workflow/client.rb +18 -0
  43. data/lib/aws/sns/client.rb +9 -0
  44. data/lib/aws/sqs/client.rb +9 -0
  45. data/lib/aws/storage_gateway/client.rb +72 -37
  46. data/lib/aws/sts/client.rb +3 -0
  47. data/lib/aws/version.rb +1 -1
  48. metadata +17 -9
  49. checksums.yaml +0 -7
@@ -29,6 +29,7 @@ module AWS
29
29
  # @return [Core::Response]
30
30
  # The #data method of the response object returns
31
31
  # a hash with the following structure:
32
+ #
32
33
  # * `:success` - (Boolean)
33
34
 
34
35
  # @!method create_job(options = {})
@@ -43,6 +44,7 @@ module AWS
43
44
  # @return [Core::Response]
44
45
  # The #data method of the response object returns
45
46
  # a hash with the following structure:
47
+ #
46
48
  # * `:job_id` - (String)
47
49
  # * `:job_type` - (String)
48
50
  # * `:aws_shipping_address` - (String)
@@ -57,6 +59,7 @@ module AWS
57
59
  # @return [Core::Response]
58
60
  # The #data method of the response object returns
59
61
  # a hash with the following structure:
62
+ #
60
63
  # * `:job_id` - (String)
61
64
  # * `:job_type` - (String)
62
65
  # * `:aws_shipping_address` - (String)
@@ -82,6 +85,7 @@ module AWS
82
85
  # @return [Core::Response]
83
86
  # The #data method of the response object returns
84
87
  # a hash with the following structure:
88
+ #
85
89
  # * `:jobs` - (Array<Hash>)
86
90
  # * `:job_id` - (String)
87
91
  # * `:creation_date` - (Time)
@@ -101,6 +105,7 @@ module AWS
101
105
  # @return [Core::Response]
102
106
  # The #data method of the response object returns
103
107
  # a hash with the following structure:
108
+ #
104
109
  # * `:success` - (Boolean)
105
110
  # * `:warning_message` - (String)
106
111
 
@@ -22,82 +22,188 @@ module AWS
22
22
 
23
23
  # client methods #
24
24
 
25
+ # @!method attach_elastic_load_balancer(options = {})
26
+ # Calls the AttachElasticLoadBalancer API operation.
27
+ # @param [Hash] options
28
+ # * `:elastic_load_balancer_name` - *required* - (String) The Elastic
29
+ # Load Balancing instance's name.
30
+ # * `:layer_id` - *required* - (String) The ID of the layer that the
31
+ # Elastic Load Balancing instance is to be attached to.
32
+ # @return [Core::Response]
33
+
25
34
  # @!method clone_stack(options = {})
26
35
  # Calls the CloneStack API operation.
27
36
  # @param [Hash] options
28
- # * `:source_stack_id` - *required* - (String)
29
- # * `:name` - (String)
30
- # * `:region` - (String)
31
- # * `:attributes` - (Hash<String,String>)
32
- # * `:service_role_arn` - *required* - (String)
33
- # * `:default_instance_profile_arn` - (String)
34
- # * `:default_os` - (String)
35
- # * `:hostname_theme` - (String)
36
- # * `:default_availability_zone` - (String)
37
- # * `:custom_json` - (String)
38
- # * `:use_custom_cookbooks` - (Boolean)
37
+ # * `:source_stack_id` - *required* - (String) The source stack ID.
38
+ # * `:name` - (String) The cloned stack name.
39
+ # * `:region` - (String) The cloned stack AWS region, such as
40
+ # "us-east-1". For more information about AWS regions, see Regions
41
+ # and Endpoints.
42
+ # * `:attributes` - (Hash<String,String>) A list of stack attributes
43
+ # and values as key/value pairs to be added to the cloned stack.
44
+ # * `:service_role_arn` - *required* - (String) The stack AWS Identity
45
+ # and Access Management (IAM) role, which allows OpsWorks to work
46
+ # with AWS resources on your behalf. You must set this parameter to
47
+ # the Amazon Resource Name (ARN) for an existing IAM role. If you
48
+ # create a stack by using the OpsWorks console, it creates the role
49
+ # for you. You can obtain an existing stack's IAM ARN
50
+ # programmatically by calling DescribePermissions. For more
51
+ # information about IAM ARNs, see Using Identifiers. You must set
52
+ # this parameter to a valid service role ARN or the action will fail;
53
+ # there is no default value. You can specify the source stack's
54
+ # service role ARN, if you prefer, but you must do so explicitly.
55
+ # * `:default_instance_profile_arn` - (String) The ARN of an IAM
56
+ # profile that is the default profile for all of the stack's EC2
57
+ # instances. For more information about IAM ARNs, see Using
58
+ # Identifiers.
59
+ # * `:default_os` - (String) The cloned stack default operating system,
60
+ # which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
61
+ # * `:hostname_theme` - (String) The stack's host name theme, with
62
+ # spaces are replaced by underscores. The theme is used to generate
63
+ # hostnames for the stack's instances. By default, HostnameTheme is
64
+ # set to Layer_Dependent, which creates hostnames by appending
65
+ # integers to the layer's shortname. The other themes are:
66
+ # Baked_Goods Clouds European_Cities Fruits Greek_Deities
67
+ # Legendary_Creatures_from_Japan Planets_and_Moons Roman_Deities
68
+ # Scottish_Islands US_Cities Wild_Cats To obtain a generated
69
+ # hostname, call GetHostNameSuggestion, which returns a hostname
70
+ # based on the current theme.
71
+ # * `:default_availability_zone` - (String) The cloned stack's
72
+ # Availability Zone. For more information, see Regions and Endpoints.
73
+ # * `:custom_json` - (String) A string that contains user-defined,
74
+ # custom JSON. It is used to override the corresponding default stack
75
+ # configuration JSON values. The string should be in the following
76
+ # format and must escape characters such as '"'.: "{\"key1\":
77
+ # \"value1\", \"key2\": \"value2\",...}" For more information on
78
+ # custom JSON, see . Use Custom JSON to Modify the Stack
79
+ # Configuration JSON
80
+ # * `:use_custom_cookbooks` - (Boolean) Whether to use custom
81
+ # cookbooks.
39
82
  # * `:custom_cookbooks_source` - (Hash)
40
- # * `:type` - (String) Valid values include:
83
+ # * `:type` - (String) The repository type. Valid values include:
41
84
  # * `git`
42
85
  # * `svn`
43
86
  # * `archive`
44
87
  # * `s3`
45
- # * `:url` - (String)
46
- # * `:username` - (String)
47
- # * `:password` - (String)
48
- # * `:ssh_key` - (String)
49
- # * `:revision` - (String)
50
- # * `:default_ssh_key_name` - (String)
51
- # * `:clone_permissions` - (Boolean)
52
- # * `:clone_app_ids` - (Array<String>)
88
+ # * `:url` - (String) The source URL.
89
+ # * `:username` - (String) This parameter depends on the repository
90
+ # type. For Amazon S3 bundles, set Username to the appropriate AWS
91
+ # access key. For HTTP bundles, Git repositories, and Subversion
92
+ # repositories, set Username to the user name.
93
+ # * `:password` - (String) This parameter depends on the repository
94
+ # type. For Amazon S3 bundles, set Password to the appropriate AWS
95
+ # secret key. For HTTP bundles, Git repositories, and Subversion
96
+ # repositories, set Password to the password.
97
+ # * `:ssh_key` - (String) The repository's SSH key.
98
+ # * `:revision` - (String) The application's version. OpsWorks
99
+ # enables you to easily deploy new versions of an application. One
100
+ # of the simplest approaches is to have branches or revisions in
101
+ # your repository that represent different versions that can
102
+ # potentially be deployed.
103
+ # * `:default_ssh_key_name` - (String) A default SSH key for the stack
104
+ # instances. You can override this value when you create or update an
105
+ # instance.
106
+ # * `:clone_permissions` - (Boolean) Whether to clone the source
107
+ # stack's permissions.
108
+ # * `:clone_app_ids` - (Array<String>) A list of source stack app IDs
109
+ # to be included in the cloned stack.
110
+ # * `:default_root_device_type` - (String) The default root device
111
+ # type. This value is used by default for all instances in the cloned
112
+ # stack, but you can override it when you create an instance. For
113
+ # more information, see Storage for the Root Device. Valid values
114
+ # include:
115
+ # * `ebs`
116
+ # * `instance-store`
53
117
  # @return [Core::Response]
54
118
  # The #data method of the response object returns
55
119
  # a hash with the following structure:
120
+ #
56
121
  # * `:stack_id` - (String)
57
122
 
58
123
  # @!method create_app(options = {})
59
124
  # Calls the CreateApp API operation.
60
125
  # @param [Hash] options
61
- # * `:stack_id` - *required* - (String)
62
- # * `:name` - *required* - (String)
63
- # * `:description` - (String)
64
- # * `:type` - *required* - (String) Valid values include:
126
+ # * `:stack_id` - *required* - (String) The stack ID.
127
+ # * `:shortname` - (String) The app's short name.
128
+ # * `:name` - *required* - (String) The app name.
129
+ # * `:description` - (String) A description of the app.
130
+ # * `:type` - *required* - (String) The app type. Each supported type
131
+ # is associated with a particular layer. For example, PHP
132
+ # applications are associated with a PHP layer. OpsWorks deploys an
133
+ # application to those instances that are members of the
134
+ # corresponding layer. Valid values include:
65
135
  # * `rails`
66
136
  # * `php`
67
137
  # * `nodejs`
68
138
  # * `static`
69
139
  # * `other`
70
- # * `:app_source` - (Hash)
71
- # * `:type` - (String) Valid values include:
140
+ # * `:app_source` - (Hash) A Source object that specifies the app
141
+ # repository.
142
+ # * `:type` - (String) The repository type. Valid values include:
72
143
  # * `git`
73
144
  # * `svn`
74
145
  # * `archive`
75
146
  # * `s3`
76
- # * `:url` - (String)
77
- # * `:username` - (String)
78
- # * `:password` - (String)
79
- # * `:ssh_key` - (String)
80
- # * `:revision` - (String)
81
- # * `:domains` - (Array<String>)
82
- # * `:enable_ssl` - (Boolean)
83
- # * `:ssl_configuration` - (Hash)
84
- # * `:certificate` - *required* - (String)
85
- # * `:private_key` - *required* - (String)
86
- # * `:chain` - (String)
87
- # * `:attributes` - (Hash<String,String>)
147
+ # * `:url` - (String) The source URL.
148
+ # * `:username` - (String) This parameter depends on the repository
149
+ # type. For Amazon S3 bundles, set Username to the appropriate AWS
150
+ # access key. For HTTP bundles, Git repositories, and Subversion
151
+ # repositories, set Username to the user name.
152
+ # * `:password` - (String) This parameter depends on the repository
153
+ # type. For Amazon S3 bundles, set Password to the appropriate AWS
154
+ # secret key. For HTTP bundles, Git repositories, and Subversion
155
+ # repositories, set Password to the password.
156
+ # * `:ssh_key` - (String) The repository's SSH key.
157
+ # * `:revision` - (String) The application's version. OpsWorks
158
+ # enables you to easily deploy new versions of an application. One
159
+ # of the simplest approaches is to have branches or revisions in
160
+ # your repository that represent different versions that can
161
+ # potentially be deployed.
162
+ # * `:domains` - (Array<String>) The app virtual host settings, with
163
+ # multiple domains separated by commas. For example:
164
+ # 'www.example.com, example.com'
165
+ # * `:enable_ssl` - (Boolean) Whether to enable SSL for the app.
166
+ # * `:ssl_configuration` - (Hash) An SslConfiguration object with the
167
+ # SSL configuration.
168
+ # * `:certificate` - *required* - (String) The contents of the
169
+ # certificate's domain.crt file.
170
+ # * `:private_key` - *required* - (String) The private key; the
171
+ # contents of the certificate's domain.kex file.
172
+ # * `:chain` - (String) Optional. Can be used to specify an
173
+ # intermediate certificate authority key or client authentication.
174
+ # * `:attributes` - (Hash<String,String>) One or more user-defined
175
+ # key/value pairs to be added to the stack attributes bag.
88
176
  # @return [Core::Response]
89
177
  # The #data method of the response object returns
90
178
  # a hash with the following structure:
179
+ #
91
180
  # * `:app_id` - (String)
92
181
 
93
182
  # @!method create_deployment(options = {})
94
183
  # Calls the CreateDeployment API operation.
95
184
  # @param [Hash] options
96
- # * `:stack_id` - *required* - (String)
97
- # * `:app_id` - (String)
98
- # * `:instance_ids` - (Array<String>)
99
- # * `:command` - *required* - (Hash)
100
- # * `:name` - *required* - (String) Valid values include:
185
+ # * `:stack_id` - *required* - (String) The stack ID.
186
+ # * `:app_id` - (String) The app ID. This parameter is required for app
187
+ # deployments, but not for other deployment commands.
188
+ # * `:instance_ids` - (Array<String>) The instance IDs for the
189
+ # deployment targets.
190
+ # * `:command` - *required* - (Hash) A DeploymentCommand object that
191
+ # specifies the deployment command and any associated arguments.
192
+ # * `:name` - *required* - (String) Specifies the deployment
193
+ # operation. You can specify only one command. For stacks, the
194
+ # available commands are: execute_recipes: Execute the recipes that
195
+ # are specified by the Args parameter. install_dependencies:
196
+ # Installs the stack's dependencies. update_custom_cookbooks:
197
+ # Update the stack's custom cookbooks. update_dependencies: Update
198
+ # the stack's dependencies. For apps, the available commands are:
199
+ # deploy: Deploy the app. rollback Roll the app back to the
200
+ # previous version. When you update an app, OpsWorks stores the
201
+ # previous version, up to a maximum of five versions. You can use
202
+ # this command to roll an app back as many as four versions. start:
203
+ # Start the app's web or application server. stop: Stop the app's
204
+ # web or application server. restart: Restart the app's web or
205
+ # application server. undeploy: Undeploy the app. Valid values
206
+ # include:
101
207
  # * `install_dependencies`
102
208
  # * `update_dependencies`
103
209
  # * `update_custom_cookbooks`
@@ -108,146 +214,278 @@ module AWS
108
214
  # * `stop`
109
215
  # * `restart`
110
216
  # * `undeploy`
111
- # * `:args` - (Hash<String,Array<String>>)
112
- # * `:comment` - (String)
113
- # * `:custom_json` - (String)
217
+ # * `:args` - (Hash<String,Array<String>>) An array of command
218
+ # arguments. This parameter is currently used only to specify the
219
+ # list of recipes to be executed by the ExecuteRecipes command.
220
+ # * `:comment` - (String) A user-defined comment.
221
+ # * `:custom_json` - (String) A string that contains user-defined,
222
+ # custom JSON. It is used to override the corresponding default stack
223
+ # configuration JSON values. The string should be in the following
224
+ # format and must escape characters such as '"'.: "{\"key1\":
225
+ # \"value1\", \"key2\": \"value2\",...}" For more information on
226
+ # custom JSON, see Use Custom JSON to Modify the Stack Configuration
227
+ # JSON.
114
228
  # @return [Core::Response]
115
229
  # The #data method of the response object returns
116
230
  # a hash with the following structure:
231
+ #
117
232
  # * `:deployment_id` - (String)
118
233
 
119
234
  # @!method create_instance(options = {})
120
235
  # Calls the CreateInstance API operation.
121
236
  # @param [Hash] options
122
- # * `:stack_id` - *required* - (String)
123
- # * `:layer_ids` - *required* - (Array<String>)
124
- # * `:instance_type` - *required* - (String)
125
- # * `:auto_scaling_type` - (String) Valid values include:
126
- # * `AlwaysRunning`
127
- # * `TimeBasedAutoScaling`
128
- # * `LoadBasedAutoScaling`
129
- # * `:hostname` - (String)
130
- # * `:os` - (String)
131
- # * `:ssh_key_name` - (String)
132
- # * `:availability_zone` - (String)
237
+ # * `:stack_id` - *required* - (String) The stack ID.
238
+ # * `:layer_ids` - *required* - (Array<String>) An array that contains
239
+ # the instance layer IDs.
240
+ # * `:instance_type` - *required* - (String) The instance type.
241
+ # OpsWorks supports all instance types except Cluster Compute,
242
+ # Cluster GPU, and High Memory Cluster. For more information, see
243
+ # Instance Families and Types. The parameter values that you use to
244
+ # specify the various types are in the API Name column of the
245
+ # Available Instance Types table.
246
+ # * `:auto_scaling_type` - (String) The instance auto scaling type,
247
+ # which has three possible values: AlwaysRunning: A 24/7 instance,
248
+ # which is not affected by auto scaling. TimeBasedAutoScaling: A
249
+ # time-based auto scaling instance, which is started and stopped
250
+ # based on a specified schedule. To specify the schedule, call
251
+ # SetTimeBasedAutoScaling. LoadBasedAutoScaling: A load-based auto
252
+ # scaling instance, which is started and stopped based on load
253
+ # metrics. To use load-based auto scaling, you must enable it for the
254
+ # instance layer and configure the thresholds by calling
255
+ # SetLoadBasedAutoScaling. Valid values include:
256
+ # * `load`
257
+ # * `timer`
258
+ # * `:hostname` - (String) The instance host name.
259
+ # * `:os` - (String) The instance's operating system, which must be
260
+ # either "Amazon Linux" or "Ubuntu 12.04 LTS".
261
+ # * `:ssh_key_name` - (String) The instance SSH key name.
262
+ # * `:availability_zone` - (String) The instance Availability Zone. For
263
+ # more information, see Regions and Endpoints.
264
+ # * `:architecture` - (String) The instance architecture. Instance
265
+ # types do not necessarily support both architectures. For a list of
266
+ # the architectures that are supported by the different instance
267
+ # types, see Instance Families and Types. Valid values include:
268
+ # * `x86_64`
269
+ # * `i386`
270
+ # * `:root_device_type` - (String) The instance root device type. For
271
+ # more information, see Storage for the Root Device. Valid values
272
+ # include:
273
+ # * `ebs`
274
+ # * `instance-store`
133
275
  # @return [Core::Response]
134
276
  # The #data method of the response object returns
135
277
  # a hash with the following structure:
278
+ #
136
279
  # * `:instance_id` - (String)
137
280
 
138
281
  # @!method create_layer(options = {})
139
282
  # Calls the CreateLayer API operation.
140
283
  # @param [Hash] options
141
- # * `:stack_id` - *required* - (String)
142
- # * `:type` - *required* - (String)
143
- # * `:name` - *required* - (String)
144
- # * `:shortname` - *required* - (String)
145
- # * `:attributes` - (Hash<String,String>)
146
- # * `:custom_instance_profile_arn` - (String)
147
- # * `:custom_security_group_ids` - (Array<String>)
148
- # * `:packages` - (Array<String>)
149
- # * `:volume_configurations` - (Array<Hash>)
150
- # * `:mount_point` - *required* - (String)
151
- # * `:raid_level` - (Integer)
152
- # * `:number_of_disks` - *required* - (Integer)
153
- # * `:size` - *required* - (Integer)
154
- # * `:enable_auto_healing` - (Boolean)
155
- # * `:auto_assign_elastic_ips` - (Boolean)
156
- # * `:custom_recipes` - (Hash)
157
- # * `:setup` - (Array<String>)
158
- # * `:configure` - (Array<String>)
159
- # * `:deploy` - (Array<String>)
160
- # * `:undeploy` - (Array<String>)
161
- # * `:shutdown` - (Array<String>)
284
+ # * `:stack_id` - *required* - (String) The layer stack ID.
285
+ # * `:type` - *required* - (String) The layer type. A stack cannot have
286
+ # more than one layer of the same type. This parameter must be set to
287
+ # one of the following: lb: An HAProxy layer web: A Static Web Server
288
+ # layer rails-app: A Rails App Server layer php-app: A PHP App Server
289
+ # layer nodejs-app: A Node.js App Server layer memcached: A Memcached
290
+ # layer db-master: A MySQL layer monitoring-master: A Ganglia layer
291
+ # custom: A custom layer Valid values include:
292
+ # * `lb`
293
+ # * `web`
294
+ # * `php-app`
295
+ # * `rails-app`
296
+ # * `nodejs-app`
297
+ # * `memcached`
298
+ # * `db-master`
299
+ # * `monitoring-master`
300
+ # * `custom`
301
+ # * `:name` - *required* - (String) The layer name, which is used by
302
+ # the console.
303
+ # * `:shortname` - *required* - (String) The layer short name, which is
304
+ # used internally by OpsWorks and by Chef recipes. The shortname is
305
+ # also used as the name for the directory where your app files are
306
+ # installed. It can have a maximum of 200 characters, which are
307
+ # limited to the alphanumeric characters, '-', '_', and '.'.
308
+ # * `:attributes` - (Hash<String,String>) One or more user-defined
309
+ # key/value pairs to be added to the stack attributes bag.
310
+ # * `:custom_instance_profile_arn` - (String) The ARN of an IAM profile
311
+ # that to be used for the layer's EC2 instances. For more information
312
+ # about IAM ARNs, see Using Identifiers.
313
+ # * `:custom_security_group_ids` - (Array<String>) An array containing
314
+ # the layer custom security group IDs.
315
+ # * `:packages` - (Array<String>) An array of Package objects that
316
+ # describe the layer packages.
317
+ # * `:volume_configurations` - (Array<Hash>) A VolumeConfigurations
318
+ # object that describes the layer Amazon EBS volumes.
319
+ # * `:mount_point` - *required* - (String) The volume mount point.
320
+ # For example "/dev/sdh".
321
+ # * `:raid_level` - (Integer) The volume RAID level.
322
+ # * `:number_of_disks` - *required* - (Integer) The number of disks
323
+ # in the volume.
324
+ # * `:size` - *required* - (Integer) The volume size.
325
+ # * `:enable_auto_healing` - (Boolean) Whether to disable auto healing
326
+ # for the layer.
327
+ # * `:auto_assign_elastic_ips` - (Boolean) Whether to automatically
328
+ # assign an Elastic IP address to the layer.
329
+ # * `:custom_recipes` - (Hash) A LayerCustomRecipes object that
330
+ # specifies the layer custom recipes.
331
+ # * `:setup` - (Array<String>) An array of custom recipe names to be
332
+ # run following a setup event.
333
+ # * `:configure` - (Array<String>) An array of custom recipe names to
334
+ # be run following a configure event.
335
+ # * `:deploy` - (Array<String>) An array of custom recipe names to be
336
+ # run following a deploy event.
337
+ # * `:undeploy` - (Array<String>) An array of custom recipe names to
338
+ # be run following a undeploy event.
339
+ # * `:shutdown` - (Array<String>) An array of custom recipe names to
340
+ # be run following a shutdown event.
162
341
  # @return [Core::Response]
163
342
  # The #data method of the response object returns
164
343
  # a hash with the following structure:
344
+ #
165
345
  # * `:layer_id` - (String)
166
346
 
167
347
  # @!method create_stack(options = {})
168
348
  # Calls the CreateStack API operation.
169
349
  # @param [Hash] options
170
- # * `:name` - *required* - (String)
171
- # * `:region` - *required* - (String)
172
- # * `:attributes` - (Hash<String,String>)
173
- # * `:service_role_arn` - *required* - (String)
174
- # * `:default_instance_profile_arn` - *required* - (String)
175
- # * `:default_os` - (String)
176
- # * `:hostname_theme` - (String)
177
- # * `:default_availability_zone` - (String)
178
- # * `:custom_json` - (String)
179
- # * `:use_custom_cookbooks` - (Boolean)
350
+ # * `:name` - *required* - (String) The stack name.
351
+ # * `:region` - *required* - (String) The stack AWS region, such as
352
+ # "us-east-1". For more information about Amazon regions, see Regions
353
+ # and Endpoints.
354
+ # * `:attributes` - (Hash<String,String>) One or more user-defined
355
+ # key/value pairs to be added to the stack attributes bag.
356
+ # * `:service_role_arn` - *required* - (String) The stack AWS Identity
357
+ # and Access Management (IAM) role, which allows OpsWorks to work
358
+ # with AWS resources on your behalf. You must set this parameter to
359
+ # the Amazon Resource Name (ARN) for an existing IAM role. For more
360
+ # information about IAM ARNs, see Using Identifiers.
361
+ # * `:default_instance_profile_arn` - *required* - (String) The ARN of
362
+ # an IAM profile that is the default profile for all of the stack's
363
+ # EC2 instances. For more information about IAM ARNs, see Using
364
+ # Identifiers.
365
+ # * `:default_os` - (String) The cloned stack default operating system,
366
+ # which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
367
+ # * `:hostname_theme` - (String) The stack's host name theme, with
368
+ # spaces are replaced by underscores. The theme is used to generate
369
+ # hostnames for the stack's instances. By default, HostnameTheme is
370
+ # set to Layer_Dependent, which creates hostnames by appending
371
+ # integers to the layer's shortname. The other themes are:
372
+ # Baked_Goods Clouds European_Cities Fruits Greek_Deities
373
+ # Legendary_Creatures_from_Japan Planets_and_Moons Roman_Deities
374
+ # Scottish_Islands US_Cities Wild_Cats To obtain a generated
375
+ # hostname, call GetHostNameSuggestion, which returns a hostname
376
+ # based on the current theme.
377
+ # * `:default_availability_zone` - (String) The stack default
378
+ # Availability Zone. For more information, see Regions and Endpoints.
379
+ # * `:custom_json` - (String) A string that contains user-defined,
380
+ # custom JSON. It is used to override the corresponding default stack
381
+ # configuration JSON values. The string should be in the following
382
+ # format and must escape characters such as '"'.: "{\"key1\":
383
+ # \"value1\", \"key2\": \"value2\",...}" For more information on
384
+ # custom JSON, see Use Custom JSON to Modify the Stack Configuration
385
+ # JSON.
386
+ # * `:use_custom_cookbooks` - (Boolean) Whether the stack uses custom
387
+ # cookbooks.
180
388
  # * `:custom_cookbooks_source` - (Hash)
181
- # * `:type` - (String) Valid values include:
389
+ # * `:type` - (String) The repository type. Valid values include:
182
390
  # * `git`
183
391
  # * `svn`
184
392
  # * `archive`
185
393
  # * `s3`
186
- # * `:url` - (String)
187
- # * `:username` - (String)
188
- # * `:password` - (String)
189
- # * `:ssh_key` - (String)
190
- # * `:revision` - (String)
191
- # * `:default_ssh_key_name` - (String)
394
+ # * `:url` - (String) The source URL.
395
+ # * `:username` - (String) This parameter depends on the repository
396
+ # type. For Amazon S3 bundles, set Username to the appropriate AWS
397
+ # access key. For HTTP bundles, Git repositories, and Subversion
398
+ # repositories, set Username to the user name.
399
+ # * `:password` - (String) This parameter depends on the repository
400
+ # type. For Amazon S3 bundles, set Password to the appropriate AWS
401
+ # secret key. For HTTP bundles, Git repositories, and Subversion
402
+ # repositories, set Password to the password.
403
+ # * `:ssh_key` - (String) The repository's SSH key.
404
+ # * `:revision` - (String) The application's version. OpsWorks
405
+ # enables you to easily deploy new versions of an application. One
406
+ # of the simplest approaches is to have branches or revisions in
407
+ # your repository that represent different versions that can
408
+ # potentially be deployed.
409
+ # * `:default_ssh_key_name` - (String) A default SSH key for the stack
410
+ # instances. You can override this value when you create or update an
411
+ # instance.
412
+ # * `:default_root_device_type` - (String) The default root device
413
+ # type. This value is used by default for all instances in the cloned
414
+ # stack, but you can override it when you create an instance. For
415
+ # more information, see Storage for the Root Device. Valid values
416
+ # include:
417
+ # * `ebs`
418
+ # * `instance-store`
192
419
  # @return [Core::Response]
193
420
  # The #data method of the response object returns
194
421
  # a hash with the following structure:
422
+ #
195
423
  # * `:stack_id` - (String)
196
424
 
197
425
  # @!method create_user_profile(options = {})
198
426
  # Calls the CreateUserProfile API operation.
199
427
  # @param [Hash] options
200
- # * `:iam_user_arn` - *required* - (String)
201
- # * `:ssh_username` - (String)
202
- # * `:ssh_public_key` - (String)
428
+ # * `:iam_user_arn` - *required* - (String) The user's IAM ARN.
429
+ # * `:ssh_username` - (String) The user's SSH user name.
430
+ # * `:ssh_public_key` - (String) The user's public SSH key.
203
431
  # @return [Core::Response]
204
432
  # The #data method of the response object returns
205
433
  # a hash with the following structure:
434
+ #
206
435
  # * `:iam_user_arn` - (String)
207
436
 
208
437
  # @!method delete_app(options = {})
209
438
  # Calls the DeleteApp API operation.
210
439
  # @param [Hash] options
211
- # * `:app_id` - *required* - (String)
440
+ # * `:app_id` - *required* - (String) The app ID.
212
441
  # @return [Core::Response]
213
442
 
214
443
  # @!method delete_instance(options = {})
215
444
  # Calls the DeleteInstance API operation.
216
445
  # @param [Hash] options
217
- # * `:instance_id` - *required* - (String)
218
- # * `:delete_elastic_ip` - (Boolean)
219
- # * `:delete_volumes` - (Boolean)
446
+ # * `:instance_id` - *required* - (String) The instance ID.
447
+ # * `:delete_elastic_ip` - (Boolean) Whether to delete the instance
448
+ # Elastic IP address.
449
+ # * `:delete_volumes` - (Boolean) Whether to delete the instance Amazon
450
+ # EBS volumes.
220
451
  # @return [Core::Response]
221
452
 
222
453
  # @!method delete_layer(options = {})
223
454
  # Calls the DeleteLayer API operation.
224
455
  # @param [Hash] options
225
- # * `:layer_id` - *required* - (String)
456
+ # * `:layer_id` - *required* - (String) The layer ID.
226
457
  # @return [Core::Response]
227
458
 
228
459
  # @!method delete_stack(options = {})
229
460
  # Calls the DeleteStack API operation.
230
461
  # @param [Hash] options
231
- # * `:stack_id` - *required* - (String)
462
+ # * `:stack_id` - *required* - (String) The stack ID.
232
463
  # @return [Core::Response]
233
464
 
234
465
  # @!method delete_user_profile(options = {})
235
466
  # Calls the DeleteUserProfile API operation.
236
467
  # @param [Hash] options
237
- # * `:iam_user_arn` - *required* - (String)
468
+ # * `:iam_user_arn` - *required* - (String) The user's IAM ARN.
238
469
  # @return [Core::Response]
239
470
 
240
471
  # @!method describe_apps(options = {})
241
472
  # Calls the DescribeApps API operation.
242
473
  # @param [Hash] options
243
- # * `:stack_id` - (String)
244
- # * `:app_ids` - (Array<String>)
474
+ # * `:stack_id` - (String) The app stack ID. If you use this parameter,
475
+ # DescribeApps returns a description of the apps in the specified
476
+ # stack.
477
+ # * `:app_ids` - (Array<String>) An array of app IDs for the apps to be
478
+ # described. If you use this parameter, DescribeApps returns a
479
+ # description of the specified apps. Otherwise, it returns a
480
+ # description of every app.
245
481
  # @return [Core::Response]
246
482
  # The #data method of the response object returns
247
483
  # a hash with the following structure:
484
+ #
248
485
  # * `:apps` - (Array<Hash>)
249
486
  # * `:app_id` - (String)
250
487
  # * `:stack_id` - (String)
488
+ # * `:shortname` - (String)
251
489
  # * `:name` - (String)
252
490
  # * `:description` - (String)
253
491
  # * `:type` - (String)
@@ -270,12 +508,20 @@ module AWS
270
508
  # @!method describe_commands(options = {})
271
509
  # Calls the DescribeCommands API operation.
272
510
  # @param [Hash] options
273
- # * `:deployment_id` - (String)
274
- # * `:instance_id` - (String)
275
- # * `:command_ids` - (Array<String>)
511
+ # * `:deployment_id` - (String) The deployment ID. If you include this
512
+ # parameter, DescribeCommands returns a description of the commands
513
+ # associated with the specified deployment.
514
+ # * `:instance_id` - (String) The instance ID. If you include this
515
+ # parameter, DescribeCommands returns a description of the commands
516
+ # associated with the specified instance.
517
+ # * `:command_ids` - (Array<String>) An array of command IDs. If you
518
+ # include this parameter, DescribeCommands returns a description of
519
+ # the specified commands. Otherwise, it returns a description of
520
+ # every command.
276
521
  # @return [Core::Response]
277
522
  # The #data method of the response object returns
278
523
  # a hash with the following structure:
524
+ #
279
525
  # * `:commands` - (Array<Hash>)
280
526
  # * `:command_id` - (String)
281
527
  # * `:instance_id` - (String)
@@ -291,12 +537,20 @@ module AWS
291
537
  # @!method describe_deployments(options = {})
292
538
  # Calls the DescribeDeployments API operation.
293
539
  # @param [Hash] options
294
- # * `:stack_id` - (String)
295
- # * `:app_id` - (String)
296
- # * `:deployment_ids` - (Array<String>)
540
+ # * `:stack_id` - (String) The stack ID. If you include this parameter,
541
+ # DescribeDeployments returns a description of the commands
542
+ # associated with the specified stack.
543
+ # * `:app_id` - (String) The app ID. If you include this parameter,
544
+ # DescribeDeployments returns a description of the commands
545
+ # associated with the specified app.
546
+ # * `:deployment_ids` - (Array<String>) An array of deployment IDs to
547
+ # be described. If you include this parameter, DescribeDeployments
548
+ # returns a description of the specified deployments. Otherwise, it
549
+ # returns a description of every deployment.
297
550
  # @return [Core::Response]
298
551
  # The #data method of the response object returns
299
552
  # a hash with the following structure:
553
+ #
300
554
  # * `:deployments` - (Array<Hash>)
301
555
  # * `:deployment_id` - (String)
302
556
  # * `:stack_id` - (String)
@@ -317,26 +571,60 @@ module AWS
317
571
  # @!method describe_elastic_ips(options = {})
318
572
  # Calls the DescribeElasticIps API operation.
319
573
  # @param [Hash] options
320
- # * `:instance_id` - (String)
321
- # * `:ips` - (Array<String>)
574
+ # * `:instance_id` - (String) The instance ID. If you include this
575
+ # parameter, DescribeElasticIps returns a description of the Elastic
576
+ # IP addresses associated with the specified instance.
577
+ # * `:ips` - (Array<String>) An array of Elastic IP addresses to be
578
+ # described. If you include this parameter, DescribeElasticIps
579
+ # returns a description of the specified Elastic IP addresses.
580
+ # Otherwise, it returns a description of every Elastic IP address.
322
581
  # @return [Core::Response]
323
582
  # The #data method of the response object returns
324
583
  # a hash with the following structure:
584
+ #
325
585
  # * `:elastic_ips` - (Array<Hash>)
326
586
  # * `:ip` - (String)
327
587
  # * `:name` - (String)
328
588
  # * `:region` - (String)
329
589
 
590
+ # @!method describe_elastic_load_balancers(options = {})
591
+ # Calls the DescribeElasticLoadBalancers API operation.
592
+ # @param [Hash] options
593
+ # * `:stack_id` - (String) A stack ID. The action describes the Elastic
594
+ # Load Balancing instances for the stack.
595
+ # * `:layer_ids` - (Array<String>) A list of layer IDs. The action
596
+ # describes the Elastic Load Balancing instances for the specified
597
+ # layers.
598
+ # @return [Core::Response]
599
+ # The #data method of the response object returns
600
+ # a hash with the following structure:
601
+ #
602
+ # * `:elastic_load_balancers` - (Array<Hash>)
603
+ # * `:elastic_load_balancer_name` - (String)
604
+ # * `:region` - (String)
605
+ # * `:dns_name` - (String)
606
+ # * `:stack_id` - (String)
607
+ # * `:layer_id` - (String)
608
+ # * `:availability_zones` - (Array<String>)
609
+ # * `:ec_2_instance_ids` - (Array<String>)
610
+
330
611
  # @!method describe_instances(options = {})
331
612
  # Calls the DescribeInstances API operation.
332
613
  # @param [Hash] options
333
- # * `:stack_id` - (String)
334
- # * `:layer_id` - (String)
335
- # * `:app_id` - (String)
336
- # * `:instance_ids` - (Array<String>)
614
+ # * `:stack_id` - (String) A stack ID. If you use this parameter,
615
+ # DescribeInstances returns descriptions of the instances associated
616
+ # with the specified stack.
617
+ # * `:layer_id` - (String) A layer ID. If you use this parameter,
618
+ # DescribeInstances returns descriptions of the instances associated
619
+ # with the specified layer.
620
+ # * `:instance_ids` - (Array<String>) An array of instance IDs to be
621
+ # described. If you use this parameter, DescribeInstances returns a
622
+ # description of the specified instances. Otherwise, it returns a
623
+ # description of every instance.
337
624
  # @return [Core::Response]
338
625
  # The #data method of the response object returns
339
626
  # a hash with the following structure:
627
+ #
340
628
  # * `:instances` - (Array<Hash>)
341
629
  # * `:instance_id` - (String)
342
630
  # * `:ec2_instance_id` - (String)
@@ -360,15 +648,22 @@ module AWS
360
648
  # * `:ssh_host_dsa_key_fingerprint` - (String)
361
649
  # * `:created_at` - (String)
362
650
  # * `:last_service_error_id` - (String)
651
+ # * `:architecture` - (String)
652
+ # * `:root_device_type` - (String)
653
+ # * `:root_device_volume_id` - (String)
363
654
 
364
655
  # @!method describe_layers(options = {})
365
656
  # Calls the DescribeLayers API operation.
366
657
  # @param [Hash] options
367
- # * `:stack_id` - *required* - (String)
368
- # * `:layer_ids` - (Array<String>)
658
+ # * `:stack_id` - *required* - (String) The stack ID.
659
+ # * `:layer_ids` - (Array<String>) An array of layer IDs that specify
660
+ # the layers to be described. If you omit this parameter,
661
+ # DescribeLayers returns a description of every layer in the
662
+ # specified stack.
369
663
  # @return [Core::Response]
370
664
  # The #data method of the response object returns
371
665
  # a hash with the following structure:
666
+ #
372
667
  # * `:layers` - (Array<Hash>)
373
668
  # * `:stack_id` - (String)
374
669
  # * `:layer_id` - (String)
@@ -404,10 +699,11 @@ module AWS
404
699
  # @!method describe_load_based_auto_scaling(options = {})
405
700
  # Calls the DescribeLoadBasedAutoScaling API operation.
406
701
  # @param [Hash] options
407
- # * `:layer_ids` - *required* - (Array<String>)
702
+ # * `:layer_ids` - *required* - (Array<String>) An array of layer IDs.
408
703
  # @return [Core::Response]
409
704
  # The #data method of the response object returns
410
705
  # a hash with the following structure:
706
+ #
411
707
  # * `:load_based_auto_scaling_configurations` - (Array<Hash>)
412
708
  # * `:layer_id` - (String)
413
709
  # * `:enable` - (Boolean)
@@ -429,11 +725,13 @@ module AWS
429
725
  # @!method describe_permissions(options = {})
430
726
  # Calls the DescribePermissions API operation.
431
727
  # @param [Hash] options
432
- # * `:iam_user_arn` - *required* - (String)
433
- # * `:stack_id` - *required* - (String)
728
+ # * `:iam_user_arn` - *required* - (String) The user's IAM ARN. For
729
+ # more information about IAM ARNs, see Using Identifiers.
730
+ # * `:stack_id` - *required* - (String) The stack ID.
434
731
  # @return [Core::Response]
435
732
  # The #data method of the response object returns
436
733
  # a hash with the following structure:
734
+ #
437
735
  # * `:permissions` - (Array<Hash>)
438
736
  # * `:stack_id` - (String)
439
737
  # * `:iam_user_arn` - (String)
@@ -443,11 +741,17 @@ module AWS
443
741
  # @!method describe_raid_arrays(options = {})
444
742
  # Calls the DescribeRaidArrays API operation.
445
743
  # @param [Hash] options
446
- # * `:instance_id` - (String)
447
- # * `:raid_array_ids` - (Array<String>)
744
+ # * `:instance_id` - (String) The instance ID. If you use this
745
+ # parameter, DescribeRaidArrays returns descriptions of the RAID
746
+ # arrays associated with the specified instance.
747
+ # * `:raid_array_ids` - (Array<String>) An array of RAID array IDs. If
748
+ # you use this parameter, DescribeRaidArrays returns descriptions of
749
+ # the specified arrays. Otherwise, it returns a description of every
750
+ # array.
448
751
  # @return [Core::Response]
449
752
  # The #data method of the response object returns
450
753
  # a hash with the following structure:
754
+ #
451
755
  # * `:raid_arrays` - (Array<Hash>)
452
756
  # * `:raid_array_id` - (String)
453
757
  # * `:instance_id` - (String)
@@ -463,12 +767,20 @@ module AWS
463
767
  # @!method describe_service_errors(options = {})
464
768
  # Calls the DescribeServiceErrors API operation.
465
769
  # @param [Hash] options
466
- # * `:stack_id` - (String)
467
- # * `:instance_id` - (String)
468
- # * `:service_error_ids` - (Array<String>)
770
+ # * `:stack_id` - (String) The stack ID. If you use this parameter,
771
+ # DescribeServiceErrors returns descriptions of the errors associated
772
+ # with the specified stack.
773
+ # * `:instance_id` - (String) The instance ID. If you use this
774
+ # parameter, DescribeServiceErrors returns descriptions of the errors
775
+ # associated with the specified instance.
776
+ # * `:service_error_ids` - (Array<String>) An array of service error
777
+ # IDs. If you use this parameter, DescribeServiceErrors returns
778
+ # descriptions of the specified errors. Otherwise, it returns a
779
+ # description of every error.
469
780
  # @return [Core::Response]
470
781
  # The #data method of the response object returns
471
782
  # a hash with the following structure:
783
+ #
472
784
  # * `:service_errors` - (Array<Hash>)
473
785
  # * `:service_error_id` - (String)
474
786
  # * `:stack_id` - (String)
@@ -480,10 +792,13 @@ module AWS
480
792
  # @!method describe_stacks(options = {})
481
793
  # Calls the DescribeStacks API operation.
482
794
  # @param [Hash] options
483
- # * `:stack_ids` - (Array<String>)
795
+ # * `:stack_ids` - (Array<String>) An array of stack IDs that specify
796
+ # the stacks to be described. If you omit this parameter,
797
+ # DescribeStacks returns a description of every stack.
484
798
  # @return [Core::Response]
485
799
  # The #data method of the response object returns
486
800
  # a hash with the following structure:
801
+ #
487
802
  # * `:stacks` - (Array<Hash>)
488
803
  # * `:stack_id` - (String)
489
804
  # * `:name` - (String)
@@ -505,14 +820,17 @@ module AWS
505
820
  # * `:revision` - (String)
506
821
  # * `:default_ssh_key_name` - (String)
507
822
  # * `:created_at` - (String)
823
+ # * `:default_root_device_type` - (String)
508
824
 
509
825
  # @!method describe_time_based_auto_scaling(options = {})
510
826
  # Calls the DescribeTimeBasedAutoScaling API operation.
511
827
  # @param [Hash] options
512
- # * `:instance_ids` - *required* - (Array<String>)
828
+ # * `:instance_ids` - *required* - (Array<String>) An array of instance
829
+ # IDs.
513
830
  # @return [Core::Response]
514
831
  # The #data method of the response object returns
515
832
  # a hash with the following structure:
833
+ #
516
834
  # * `:time_based_auto_scaling_configurations` - (Array<Hash>)
517
835
  # * `:instance_id` - (String)
518
836
  # * `:auto_scaling_schedule` - (Hash)
@@ -527,10 +845,12 @@ module AWS
527
845
  # @!method describe_user_profiles(options = {})
528
846
  # Calls the DescribeUserProfiles API operation.
529
847
  # @param [Hash] options
530
- # * `:iam_user_arns` - *required* - (Array<String>)
848
+ # * `:iam_user_arns` - *required* - (Array<String>) An array of IAM
849
+ # user ARNs that identify the users to be described.
531
850
  # @return [Core::Response]
532
851
  # The #data method of the response object returns
533
852
  # a hash with the following structure:
853
+ #
534
854
  # * `:user_profiles` - (Array<Hash>)
535
855
  # * `:iam_user_arn` - (String)
536
856
  # * `:name` - (String)
@@ -540,12 +860,20 @@ module AWS
540
860
  # @!method describe_volumes(options = {})
541
861
  # Calls the DescribeVolumes API operation.
542
862
  # @param [Hash] options
543
- # * `:instance_id` - (String)
544
- # * `:raid_array_id` - (String)
545
- # * `:volume_ids` - (Array<String>)
863
+ # * `:instance_id` - (String) The instance ID. If you use this
864
+ # parameter, DescribeVolumes returns descriptions of the volumes
865
+ # associated with the specified instance.
866
+ # * `:raid_array_id` - (String) The RAID array ID. If you use this
867
+ # parameter, DescribeVolumes returns descriptions of the volumes
868
+ # associated with the specified RAID array.
869
+ # * `:volume_ids` - (Array<String>) Am array of volume IDs. If you use
870
+ # this parameter, DescribeVolumes returns descriptions of the
871
+ # specified volumes. Otherwise, it returns a description of every
872
+ # volume.
546
873
  # @return [Core::Response]
547
874
  # The #data method of the response object returns
548
875
  # a hash with the following structure:
876
+ #
549
877
  # * `:volumes` - (Array<Hash>)
550
878
  # * `:volume_id` - (String)
551
879
  # * `:ec2_volume_id` - (String)
@@ -559,195 +887,347 @@ module AWS
559
887
  # * `:region` - (String)
560
888
  # * `:availability_zone` - (String)
561
889
 
890
+ # @!method detach_elastic_load_balancer(options = {})
891
+ # Calls the DetachElasticLoadBalancer API operation.
892
+ # @param [Hash] options
893
+ # * `:elastic_load_balancer_name` - *required* - (String) The Elastic
894
+ # Load Balancing instance's name.
895
+ # * `:layer_id` - *required* - (String) The ID of the layer that the
896
+ # Elastic Load Balancing instance is attached to.
897
+ # @return [Core::Response]
898
+
562
899
  # @!method get_hostname_suggestion(options = {})
563
900
  # Calls the GetHostnameSuggestion API operation.
564
901
  # @param [Hash] options
565
- # * `:layer_id` - *required* - (String)
902
+ # * `:layer_id` - *required* - (String) The layer ID.
566
903
  # @return [Core::Response]
567
904
  # The #data method of the response object returns
568
905
  # a hash with the following structure:
906
+ #
569
907
  # * `:layer_id` - (String)
570
908
  # * `:hostname` - (String)
571
909
 
572
910
  # @!method reboot_instance(options = {})
573
911
  # Calls the RebootInstance API operation.
574
912
  # @param [Hash] options
575
- # * `:instance_id` - *required* - (String)
913
+ # * `:instance_id` - *required* - (String) The instance ID.
576
914
  # @return [Core::Response]
577
915
 
578
916
  # @!method set_load_based_auto_scaling(options = {})
579
917
  # Calls the SetLoadBasedAutoScaling API operation.
580
918
  # @param [Hash] options
581
- # * `:layer_id` - *required* - (String)
582
- # * `:enable` - (Boolean)
583
- # * `:up_scaling` - (Hash)
584
- # * `:instance_count` - (Integer)
585
- # * `:thresholds_wait_time` - (Integer)
586
- # * `:ignore_metrics_time` - (Integer)
587
- # * `:cpu_threshold` - (Float)
588
- # * `:memory_threshold` - (Float)
589
- # * `:load_threshold` - (Float)
590
- # * `:down_scaling` - (Hash)
591
- # * `:instance_count` - (Integer)
592
- # * `:thresholds_wait_time` - (Integer)
593
- # * `:ignore_metrics_time` - (Integer)
594
- # * `:cpu_threshold` - (Float)
595
- # * `:memory_threshold` - (Float)
596
- # * `:load_threshold` - (Float)
919
+ # * `:layer_id` - *required* - (String) The layer ID.
920
+ # * `:enable` - (Boolean) Enables load-based auto scaling for the
921
+ # layer.
922
+ # * `:up_scaling` - (Hash) An AutoScalingThresholds object with the
923
+ # upscaling threshold configuration. If the load exceeds these
924
+ # thresholds for a specified amount of time, OpsWorks starts a
925
+ # specified number of instances.
926
+ # * `:instance_count` - (Integer) The number of instances to add or
927
+ # remove when the load exceeds a threshold.
928
+ # * `:thresholds_wait_time` - (Integer) The amount of time, in
929
+ # minutes, that the load must exceed a threshold before more
930
+ # instances are added or removed.
931
+ # * `:ignore_metrics_time` - (Integer) The amount of time (in
932
+ # minutes) after a scaling event occurs that OpsWorks should ignore
933
+ # metrics and not raise any additional scaling events. For example,
934
+ # OpsWorks adds new instances following an upscaling event but the
935
+ # instances won't start reducing the load until they have been
936
+ # booted and configured. There is no point in raising additional
937
+ # scaling events during that operation, which typically takes
938
+ # several minutes. IgnoreMetricsTime allows you to direct OpsWorks
939
+ # to not raise any scaling events long enough to get the new
940
+ # instances online.
941
+ # * `:cpu_threshold` - (Float) The CPU utilization threshold, as a
942
+ # percent of the available CPU.
943
+ # * `:memory_threshold` - (Float) The memory utilization threshold,
944
+ # as a percent of the available memory.
945
+ # * `:load_threshold` - (Float) The load threshold. For more
946
+ # information about how load is computed, see Load (computing).
947
+ # * `:down_scaling` - (Hash) An AutoScalingThresholds object with the
948
+ # downscaling threshold configuration. If the load falls below these
949
+ # thresholds for a specified amount of time, OpsWorks stops a
950
+ # specified number of instances.
951
+ # * `:instance_count` - (Integer) The number of instances to add or
952
+ # remove when the load exceeds a threshold.
953
+ # * `:thresholds_wait_time` - (Integer) The amount of time, in
954
+ # minutes, that the load must exceed a threshold before more
955
+ # instances are added or removed.
956
+ # * `:ignore_metrics_time` - (Integer) The amount of time (in
957
+ # minutes) after a scaling event occurs that OpsWorks should ignore
958
+ # metrics and not raise any additional scaling events. For example,
959
+ # OpsWorks adds new instances following an upscaling event but the
960
+ # instances won't start reducing the load until they have been
961
+ # booted and configured. There is no point in raising additional
962
+ # scaling events during that operation, which typically takes
963
+ # several minutes. IgnoreMetricsTime allows you to direct OpsWorks
964
+ # to not raise any scaling events long enough to get the new
965
+ # instances online.
966
+ # * `:cpu_threshold` - (Float) The CPU utilization threshold, as a
967
+ # percent of the available CPU.
968
+ # * `:memory_threshold` - (Float) The memory utilization threshold,
969
+ # as a percent of the available memory.
970
+ # * `:load_threshold` - (Float) The load threshold. For more
971
+ # information about how load is computed, see Load (computing).
597
972
  # @return [Core::Response]
598
973
 
599
974
  # @!method set_permission(options = {})
600
975
  # Calls the SetPermission API operation.
601
976
  # @param [Hash] options
602
- # * `:stack_id` - *required* - (String)
603
- # * `:iam_user_arn` - *required* - (String)
604
- # * `:allow_ssh` - (Boolean)
605
- # * `:allow_sudo` - (Boolean)
977
+ # * `:stack_id` - *required* - (String) The stack ID.
978
+ # * `:iam_user_arn` - *required* - (String) The user's IAM ARN.
979
+ # * `:allow_ssh` - (Boolean) The user is allowed to use SSH to
980
+ # communicate with the instance.
981
+ # * `:allow_sudo` - (Boolean) The user is allowed to use sudo to
982
+ # elevate privileges.
606
983
  # @return [Core::Response]
607
984
 
608
985
  # @!method set_time_based_auto_scaling(options = {})
609
986
  # Calls the SetTimeBasedAutoScaling API operation.
610
987
  # @param [Hash] options
611
- # * `:instance_id` - *required* - (String)
612
- # * `:auto_scaling_schedule` - (Hash)
613
- # * `:monday` - (Hash<String,String>)
614
- # * `:tuesday` - (Hash<String,String>)
615
- # * `:wednesday` - (Hash<String,String>)
616
- # * `:thursday` - (Hash<String,String>)
617
- # * `:friday` - (Hash<String,String>)
618
- # * `:saturday` - (Hash<String,String>)
619
- # * `:sunday` - (Hash<String,String>)
988
+ # * `:instance_id` - *required* - (String) The instance ID.
989
+ # * `:auto_scaling_schedule` - (Hash) An AutoScalingSchedule with the
990
+ # instance schedule.
991
+ # * `:monday` - (Hash<String,String>) The schedule for Monday.
992
+ # * `:tuesday` - (Hash<String,String>) The schedule for Tuesday.
993
+ # * `:wednesday` - (Hash<String,String>) The schedule for Wednesday.
994
+ # * `:thursday` - (Hash<String,String>) The schedule for Thursday.
995
+ # * `:friday` - (Hash<String,String>) The schedule for Friday.
996
+ # * `:saturday` - (Hash<String,String>) The schedule for Saturday.
997
+ # * `:sunday` - (Hash<String,String>) The schedule for Sunday.
620
998
  # @return [Core::Response]
621
999
 
622
1000
  # @!method start_instance(options = {})
623
1001
  # Calls the StartInstance API operation.
624
1002
  # @param [Hash] options
625
- # * `:instance_id` - *required* - (String)
1003
+ # * `:instance_id` - *required* - (String) The instance ID.
626
1004
  # @return [Core::Response]
627
1005
 
628
1006
  # @!method start_stack(options = {})
629
1007
  # Calls the StartStack API operation.
630
1008
  # @param [Hash] options
631
- # * `:stack_id` - *required* - (String)
1009
+ # * `:stack_id` - *required* - (String) The stack ID.
632
1010
  # @return [Core::Response]
633
1011
 
634
1012
  # @!method stop_instance(options = {})
635
1013
  # Calls the StopInstance API operation.
636
1014
  # @param [Hash] options
637
- # * `:instance_id` - *required* - (String)
1015
+ # * `:instance_id` - *required* - (String) The instance ID.
638
1016
  # @return [Core::Response]
639
1017
 
640
1018
  # @!method stop_stack(options = {})
641
1019
  # Calls the StopStack API operation.
642
1020
  # @param [Hash] options
643
- # * `:stack_id` - *required* - (String)
1021
+ # * `:stack_id` - *required* - (String) The stack ID.
644
1022
  # @return [Core::Response]
645
1023
 
646
1024
  # @!method update_app(options = {})
647
1025
  # Calls the UpdateApp API operation.
648
1026
  # @param [Hash] options
649
- # * `:app_id` - *required* - (String)
650
- # * `:name` - (String)
651
- # * `:description` - (String)
652
- # * `:type` - (String) Valid values include:
1027
+ # * `:app_id` - *required* - (String) The app ID.
1028
+ # * `:name` - (String) The app name.
1029
+ # * `:description` - (String) A description of the app.
1030
+ # * `:type` - (String) The app type. Valid values include:
653
1031
  # * `rails`
654
1032
  # * `php`
655
1033
  # * `nodejs`
656
1034
  # * `static`
657
1035
  # * `other`
658
- # * `:app_source` - (Hash)
659
- # * `:type` - (String) Valid values include:
1036
+ # * `:app_source` - (Hash) A Source object that specifies the app
1037
+ # repository.
1038
+ # * `:type` - (String) The repository type. Valid values include:
660
1039
  # * `git`
661
1040
  # * `svn`
662
1041
  # * `archive`
663
1042
  # * `s3`
664
- # * `:url` - (String)
665
- # * `:username` - (String)
666
- # * `:password` - (String)
667
- # * `:ssh_key` - (String)
668
- # * `:revision` - (String)
669
- # * `:domains` - (Array<String>)
670
- # * `:enable_ssl` - (Boolean)
671
- # * `:ssl_configuration` - (Hash)
672
- # * `:certificate` - *required* - (String)
673
- # * `:private_key` - *required* - (String)
674
- # * `:chain` - (String)
675
- # * `:attributes` - (Hash<String,String>)
1043
+ # * `:url` - (String) The source URL.
1044
+ # * `:username` - (String) This parameter depends on the repository
1045
+ # type. For Amazon S3 bundles, set Username to the appropriate AWS
1046
+ # access key. For HTTP bundles, Git repositories, and Subversion
1047
+ # repositories, set Username to the user name.
1048
+ # * `:password` - (String) This parameter depends on the repository
1049
+ # type. For Amazon S3 bundles, set Password to the appropriate AWS
1050
+ # secret key. For HTTP bundles, Git repositories, and Subversion
1051
+ # repositories, set Password to the password.
1052
+ # * `:ssh_key` - (String) The repository's SSH key.
1053
+ # * `:revision` - (String) The application's version. OpsWorks
1054
+ # enables you to easily deploy new versions of an application. One
1055
+ # of the simplest approaches is to have branches or revisions in
1056
+ # your repository that represent different versions that can
1057
+ # potentially be deployed.
1058
+ # * `:domains` - (Array<String>) The app's virtual host settings, with
1059
+ # multiple domains separated by commas. For example:
1060
+ # 'www.example.com, example.com'
1061
+ # * `:enable_ssl` - (Boolean) Whether SSL is enabled for the app.
1062
+ # * `:ssl_configuration` - (Hash) An SslConfiguration object with the
1063
+ # SSL configuration.
1064
+ # * `:certificate` - *required* - (String) The contents of the
1065
+ # certificate's domain.crt file.
1066
+ # * `:private_key` - *required* - (String) The private key; the
1067
+ # contents of the certificate's domain.kex file.
1068
+ # * `:chain` - (String) Optional. Can be used to specify an
1069
+ # intermediate certificate authority key or client authentication.
1070
+ # * `:attributes` - (Hash<String,String>) One or more user-defined
1071
+ # key/value pairs to be added to the stack attributes bag.
676
1072
  # @return [Core::Response]
677
1073
 
678
1074
  # @!method update_instance(options = {})
679
1075
  # Calls the UpdateInstance API operation.
680
1076
  # @param [Hash] options
681
- # * `:instance_id` - *required* - (String)
682
- # * `:layer_ids` - (Array<String>)
683
- # * `:instance_type` - (String)
684
- # * `:auto_scaling_type` - (String) Valid values include:
685
- # * `AlwaysRunning`
686
- # * `TimeBasedAutoScaling`
687
- # * `LoadBasedAutoScaling`
688
- # * `:hostname` - (String)
689
- # * `:os` - (String)
690
- # * `:ssh_key_name` - (String)
1077
+ # * `:instance_id` - *required* - (String) The instance ID.
1078
+ # * `:layer_ids` - (Array<String>) The instance's layer IDs.
1079
+ # * `:instance_type` - (String) The instance type. OpsWorks supports
1080
+ # all instance types except Cluster Compute, Cluster GPU, and High
1081
+ # Memory Cluster. For more information, see Instance Families and
1082
+ # Types. The parameter values that you use to specify the various
1083
+ # types are in the API Name column of the Available Instance Types
1084
+ # table.
1085
+ # * `:auto_scaling_type` - (String) The instance's auto scaling type,
1086
+ # which has three possible values: AlwaysRunning: A 24/7 instance,
1087
+ # which is not affected by auto scaling. TimeBasedAutoScaling: A
1088
+ # time-based auto scaling instance, which is started and stopped
1089
+ # based on a specified schedule. LoadBasedAutoScaling: A load-based
1090
+ # auto scaling instance, which is started and stopped based on load
1091
+ # metrics. Valid values include:
1092
+ # * `load`
1093
+ # * `timer`
1094
+ # * `:hostname` - (String) The instance host name.
1095
+ # * `:os` - (String) The instance operating system.
1096
+ # * `:ssh_key_name` - (String) The instance SSH key name.
1097
+ # * `:architecture` - (String) The instance architecture. Instance
1098
+ # types do not necessarily support both architectures. For a list of
1099
+ # the architectures that are supported by the different instance
1100
+ # types, see Instance Families and Types. Valid values include:
1101
+ # * `x86_64`
1102
+ # * `i386`
691
1103
  # @return [Core::Response]
692
1104
 
693
1105
  # @!method update_layer(options = {})
694
1106
  # Calls the UpdateLayer API operation.
695
1107
  # @param [Hash] options
696
- # * `:layer_id` - *required* - (String)
697
- # * `:name` - (String)
698
- # * `:shortname` - (String)
699
- # * `:attributes` - (Hash<String,String>)
700
- # * `:custom_instance_profile_arn` - (String)
701
- # * `:custom_security_group_ids` - (Array<String>)
702
- # * `:packages` - (Array<String>)
703
- # * `:volume_configurations` - (Array<Hash>)
704
- # * `:mount_point` - *required* - (String)
705
- # * `:raid_level` - (Integer)
706
- # * `:number_of_disks` - *required* - (Integer)
707
- # * `:size` - *required* - (Integer)
708
- # * `:enable_auto_healing` - (Boolean)
709
- # * `:auto_assign_elastic_ips` - (Boolean)
710
- # * `:custom_recipes` - (Hash)
711
- # * `:setup` - (Array<String>)
712
- # * `:configure` - (Array<String>)
713
- # * `:deploy` - (Array<String>)
714
- # * `:undeploy` - (Array<String>)
715
- # * `:shutdown` - (Array<String>)
1108
+ # * `:layer_id` - *required* - (String) The layer ID.
1109
+ # * `:name` - (String) The layer name, which is used by the console.
1110
+ # * `:shortname` - (String) The layer short name, which is used
1111
+ # internally by OpsWorksand by Chef. The shortname is also used as
1112
+ # the name for the directory where your app files are installed. It
1113
+ # can have a maximum of 200 characters and must be in the following
1114
+ # format: /\A[a-z0-9\-\_\.]+\Z/.
1115
+ # * `:attributes` - (Hash<String,String>) One or more user-defined
1116
+ # key/value pairs to be added to the stack attributes bag.
1117
+ # * `:custom_instance_profile_arn` - (String) The ARN of an IAM profile
1118
+ # to be used for all of the layer's EC2 instances. For more
1119
+ # information about IAM ARNs, see Using Identifiers.
1120
+ # * `:custom_security_group_ids` - (Array<String>) An array containing
1121
+ # the layer's custom security group IDs.
1122
+ # * `:packages` - (Array<String>) An array of Package objects that
1123
+ # describe the layer's packages.
1124
+ # * `:volume_configurations` - (Array<Hash>) A VolumeConfigurations
1125
+ # object that describes the layer's Amazon EBS volumes.
1126
+ # * `:mount_point` - *required* - (String) The volume mount point.
1127
+ # For example "/dev/sdh".
1128
+ # * `:raid_level` - (Integer) The volume RAID level.
1129
+ # * `:number_of_disks` - *required* - (Integer) The number of disks
1130
+ # in the volume.
1131
+ # * `:size` - *required* - (Integer) The volume size.
1132
+ # * `:enable_auto_healing` - (Boolean) Whether to disable auto healing
1133
+ # for the layer.
1134
+ # * `:auto_assign_elastic_ips` - (Boolean) Whether to automatically
1135
+ # assign an Elastic IP address to the layer.
1136
+ # * `:custom_recipes` - (Hash) A LayerCustomRecipes object that
1137
+ # specifies the layer's custom recipes.
1138
+ # * `:setup` - (Array<String>) An array of custom recipe names to be
1139
+ # run following a setup event.
1140
+ # * `:configure` - (Array<String>) An array of custom recipe names to
1141
+ # be run following a configure event.
1142
+ # * `:deploy` - (Array<String>) An array of custom recipe names to be
1143
+ # run following a deploy event.
1144
+ # * `:undeploy` - (Array<String>) An array of custom recipe names to
1145
+ # be run following a undeploy event.
1146
+ # * `:shutdown` - (Array<String>) An array of custom recipe names to
1147
+ # be run following a shutdown event.
716
1148
  # @return [Core::Response]
717
1149
 
718
1150
  # @!method update_stack(options = {})
719
1151
  # Calls the UpdateStack API operation.
720
1152
  # @param [Hash] options
721
- # * `:stack_id` - *required* - (String)
722
- # * `:name` - (String)
723
- # * `:attributes` - (Hash<String,String>)
724
- # * `:service_role_arn` - (String)
725
- # * `:default_instance_profile_arn` - (String)
726
- # * `:default_os` - (String)
727
- # * `:hostname_theme` - (String)
728
- # * `:default_availability_zone` - (String)
729
- # * `:custom_json` - (String)
730
- # * `:use_custom_cookbooks` - (Boolean)
1153
+ # * `:stack_id` - *required* - (String) The stack ID.
1154
+ # * `:name` - (String) The stack's new name.
1155
+ # * `:attributes` - (Hash<String,String>) One or more user-defined
1156
+ # key/value pairs to be added to the stack attributes bag.
1157
+ # * `:service_role_arn` - (String) The stack AWS Identity and Access
1158
+ # Management (IAM) role, which allows OpsWorks to work with AWS
1159
+ # resources on your behalf. You must set this parameter to the Amazon
1160
+ # Resource Name (ARN) for an existing IAM role. For more information
1161
+ # about IAM ARNs, see Using Identifiers. You must set this parameter
1162
+ # to a valid service role ARN or the action will fail; there is no
1163
+ # default value. You can specify the stack's current service role
1164
+ # ARN, if you prefer, but you must do so explicitly.
1165
+ # * `:default_instance_profile_arn` - (String) The ARN of an IAM
1166
+ # profile that is the default profile for all of the stack's EC2
1167
+ # instances. For more information about IAM ARNs, see Using
1168
+ # Identifiers.
1169
+ # * `:default_os` - (String) The cloned stack default operating system,
1170
+ # which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
1171
+ # * `:hostname_theme` - (String) The stack's new host name theme, with
1172
+ # spaces are replaced by underscores. The theme is used to generate
1173
+ # hostnames for the stack's instances. By default, HostnameTheme is
1174
+ # set to Layer_Dependent, which creates hostnames by appending
1175
+ # integers to the layer's shortname. The other themes are:
1176
+ # Baked_Goods Clouds European_Cities Fruits Greek_Deities
1177
+ # Legendary_Creatures_from_Japan Planets_and_Moons Roman_Deities
1178
+ # Scottish_Islands US_Cities Wild_Cats To obtain a generated
1179
+ # hostname, call GetHostNameSuggestion, which returns a hostname
1180
+ # based on the current theme.
1181
+ # * `:default_availability_zone` - (String) The stack new default
1182
+ # Availability Zone. For more information, see Regions and Endpoints.
1183
+ # * `:custom_json` - (String) A string that contains user-defined,
1184
+ # custom JSON. It is used to override the corresponding default stack
1185
+ # configuration JSON values. The string should be in the following
1186
+ # format and must escape characters such as '"'.: "{\"key1\":
1187
+ # \"value1\", \"key2\": \"value2\",...}" For more information on
1188
+ # custom JSON, see Use Custom JSON to Modify the Stack Configuration
1189
+ # JSON.
1190
+ # * `:use_custom_cookbooks` - (Boolean) Whether the stack uses custom
1191
+ # cookbooks.
731
1192
  # * `:custom_cookbooks_source` - (Hash)
732
- # * `:type` - (String) Valid values include:
1193
+ # * `:type` - (String) The repository type. Valid values include:
733
1194
  # * `git`
734
1195
  # * `svn`
735
1196
  # * `archive`
736
1197
  # * `s3`
737
- # * `:url` - (String)
738
- # * `:username` - (String)
739
- # * `:password` - (String)
740
- # * `:ssh_key` - (String)
741
- # * `:revision` - (String)
742
- # * `:default_ssh_key_name` - (String)
1198
+ # * `:url` - (String) The source URL.
1199
+ # * `:username` - (String) This parameter depends on the repository
1200
+ # type. For Amazon S3 bundles, set Username to the appropriate AWS
1201
+ # access key. For HTTP bundles, Git repositories, and Subversion
1202
+ # repositories, set Username to the user name.
1203
+ # * `:password` - (String) This parameter depends on the repository
1204
+ # type. For Amazon S3 bundles, set Password to the appropriate AWS
1205
+ # secret key. For HTTP bundles, Git repositories, and Subversion
1206
+ # repositories, set Password to the password.
1207
+ # * `:ssh_key` - (String) The repository's SSH key.
1208
+ # * `:revision` - (String) The application's version. OpsWorks
1209
+ # enables you to easily deploy new versions of an application. One
1210
+ # of the simplest approaches is to have branches or revisions in
1211
+ # your repository that represent different versions that can
1212
+ # potentially be deployed.
1213
+ # * `:default_ssh_key_name` - (String) A default SSH key for the stack
1214
+ # instances. You can override this value when you create or update an
1215
+ # instance.
1216
+ # * `:default_root_device_type` - (String) The default root device
1217
+ # type. This value is used by default for all instances in the cloned
1218
+ # stack, but you can override it when you create an instance. For
1219
+ # more information, see Storage for the Root Device. Valid values
1220
+ # include:
1221
+ # * `ebs`
1222
+ # * `instance-store`
743
1223
  # @return [Core::Response]
744
1224
 
745
1225
  # @!method update_user_profile(options = {})
746
1226
  # Calls the UpdateUserProfile API operation.
747
1227
  # @param [Hash] options
748
- # * `:iam_user_arn` - *required* - (String)
749
- # * `:ssh_username` - (String)
750
- # * `:ssh_public_key` - (String)
1228
+ # * `:iam_user_arn` - *required* - (String) The user IAM ARN.
1229
+ # * `:ssh_username` - (String) The user's new SSH user name.
1230
+ # * `:ssh_public_key` - (String) The user's new SSH public key.
751
1231
  # @return [Core::Response]
752
1232
 
753
1233
  # end client methods #