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