aws-sdk-opsworks 1.55.0 → 1.56.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opsworks/client.rb +248 -229
- data/lib/aws-sdk-opsworks/client_api.rb +1 -0
- data/lib/aws-sdk-opsworks/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-opsworks/layer.rb +9 -10
- data/lib/aws-sdk-opsworks/resource.rb +65 -60
- data/lib/aws-sdk-opsworks/stack.rb +16 -14
- data/lib/aws-sdk-opsworks/types.rb +346 -319
- data/lib/aws-sdk-opsworks.rb +1 -1
- metadata +2 -2
|
@@ -196,8 +196,8 @@ module Aws::OpsWorks
|
|
|
196
196
|
end
|
|
197
197
|
|
|
198
198
|
# Describes a load-based auto scaling upscaling or downscaling threshold
|
|
199
|
-
# configuration, which specifies when
|
|
200
|
-
#
|
|
199
|
+
# configuration, which specifies when OpsWorks Stacks starts or stops
|
|
200
|
+
# load-based instances.
|
|
201
201
|
#
|
|
202
202
|
# @!attribute [rw] instance_count
|
|
203
203
|
# The number of instances to add or remove when the load exceeds a
|
|
@@ -211,14 +211,14 @@ module Aws::OpsWorks
|
|
|
211
211
|
#
|
|
212
212
|
# @!attribute [rw] ignore_metrics_time
|
|
213
213
|
# The amount of time (in minutes) after a scaling event occurs that
|
|
214
|
-
#
|
|
215
|
-
# scaling events. For example,
|
|
214
|
+
# OpsWorks Stacks should ignore metrics and suppress additional
|
|
215
|
+
# scaling events. For example, OpsWorks Stacks adds new instances
|
|
216
216
|
# following an upscaling event but the instances won't start reducing
|
|
217
217
|
# the load until they have been booted and configured. There is no
|
|
218
218
|
# point in raising additional scaling events during that operation,
|
|
219
219
|
# which typically takes several minutes. `IgnoreMetricsTime` allows
|
|
220
|
-
# you to direct
|
|
221
|
-
#
|
|
220
|
+
# you to direct OpsWorks Stacks to suppress scaling events long enough
|
|
221
|
+
# to get the new instances online.
|
|
222
222
|
# @return [Integer]
|
|
223
223
|
#
|
|
224
224
|
# @!attribute [rw] cpu_threshold
|
|
@@ -241,15 +241,15 @@ module Aws::OpsWorks
|
|
|
241
241
|
# @return [Float]
|
|
242
242
|
#
|
|
243
243
|
# @!attribute [rw] alarms
|
|
244
|
-
# Custom
|
|
244
|
+
# Custom CloudWatch auto scaling alarms, to be used as thresholds.
|
|
245
245
|
# This parameter takes a list of up to five alarm names, which are
|
|
246
246
|
# case sensitive and must be in the same region as the stack.
|
|
247
247
|
#
|
|
248
248
|
# <note markdown="1"> To use custom alarms, you must update your service role to allow
|
|
249
|
-
# `cloudwatch:DescribeAlarms`. You can either have
|
|
249
|
+
# `cloudwatch:DescribeAlarms`. You can either have OpsWorks Stacks
|
|
250
250
|
# update the role for you when you first use this feature or you can
|
|
251
|
-
# edit the role manually. For more information, see [Allowing
|
|
252
|
-
#
|
|
251
|
+
# edit the role manually. For more information, see [Allowing OpsWorks
|
|
252
|
+
# Stacks to Act on Your Behalf][1].
|
|
253
253
|
#
|
|
254
254
|
# </note>
|
|
255
255
|
#
|
|
@@ -282,8 +282,8 @@ module Aws::OpsWorks
|
|
|
282
282
|
# @!attribute [rw] device_name
|
|
283
283
|
# The device name that is exposed to the instance, such as `/dev/sdh`.
|
|
284
284
|
# For the root device, you can use the explicit device name or you can
|
|
285
|
-
# set this parameter to `ROOT_DEVICE` and
|
|
286
|
-
#
|
|
285
|
+
# set this parameter to `ROOT_DEVICE` and OpsWorks Stacks will provide
|
|
286
|
+
# the correct device name.
|
|
287
287
|
# @return [String]
|
|
288
288
|
#
|
|
289
289
|
# @!attribute [rw] no_device
|
|
@@ -340,12 +340,14 @@ module Aws::OpsWorks
|
|
|
340
340
|
# @return [String]
|
|
341
341
|
#
|
|
342
342
|
# @!attribute [rw] name
|
|
343
|
-
# The cloned stack name.
|
|
343
|
+
# The cloned stack name. Stack names can be a maximum of 64
|
|
344
|
+
# characters.
|
|
344
345
|
# @return [String]
|
|
345
346
|
#
|
|
346
347
|
# @!attribute [rw] region
|
|
347
|
-
# The cloned stack
|
|
348
|
-
#
|
|
348
|
+
# The cloned stack Amazon Web Services Region, such as
|
|
349
|
+
# `ap-northeast-2`. For more information about Amazon Web Services
|
|
350
|
+
# Regions, see [Regions and Endpoints][1].
|
|
349
351
|
#
|
|
350
352
|
#
|
|
351
353
|
#
|
|
@@ -364,9 +366,9 @@ module Aws::OpsWorks
|
|
|
364
366
|
#
|
|
365
367
|
# If the VPC ID corresponds to a default VPC and you have specified
|
|
366
368
|
# either the `DefaultAvailabilityZone` or the `DefaultSubnetId`
|
|
367
|
-
# parameter only,
|
|
368
|
-
# parameter. If you specify neither parameter,
|
|
369
|
-
#
|
|
369
|
+
# parameter only, OpsWorks Stacks infers the value of the other
|
|
370
|
+
# parameter. If you specify neither parameter, OpsWorks Stacks sets
|
|
371
|
+
# these parameters to the first valid Availability Zone for the
|
|
370
372
|
# specified region and the corresponding default VPC subnet ID,
|
|
371
373
|
# respectively.
|
|
372
374
|
#
|
|
@@ -377,8 +379,8 @@ module Aws::OpsWorks
|
|
|
377
379
|
#
|
|
378
380
|
# * You must specify a value for `DefaultSubnetId`.
|
|
379
381
|
#
|
|
380
|
-
# For more information about how to use
|
|
381
|
-
#
|
|
382
|
+
# For more information about how to use OpsWorks Stacks with a VPC,
|
|
383
|
+
# see [Running a Stack in a VPC][1]. For more information about
|
|
382
384
|
# default VPC and EC2 Classic, see [Supported Platforms][2].
|
|
383
385
|
#
|
|
384
386
|
#
|
|
@@ -393,11 +395,11 @@ module Aws::OpsWorks
|
|
|
393
395
|
# @return [Hash<String,String>]
|
|
394
396
|
#
|
|
395
397
|
# @!attribute [rw] service_role_arn
|
|
396
|
-
# The stack
|
|
397
|
-
#
|
|
398
|
+
# The stack Identity and Access Management (IAM) role, which allows
|
|
399
|
+
# OpsWorks Stacks to work with Amazon Web Services resources on your
|
|
398
400
|
# behalf. You must set this parameter to the Amazon Resource Name
|
|
399
401
|
# (ARN) for an existing IAM role. If you create a stack by using the
|
|
400
|
-
#
|
|
402
|
+
# OpsWorkss Stacks console, it creates the role for you. You can
|
|
401
403
|
# obtain an existing stack's IAM ARN programmatically by calling
|
|
402
404
|
# DescribePermissions. For more information about IAM ARNs, see [Using
|
|
403
405
|
# Identifiers][1].
|
|
@@ -429,12 +431,12 @@ module Aws::OpsWorks
|
|
|
429
431
|
# following.
|
|
430
432
|
#
|
|
431
433
|
# * A supported Linux operating system: An Amazon Linux version, such
|
|
432
|
-
# as `Amazon Linux
|
|
433
|
-
# 2017.
|
|
434
|
-
# Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
434
|
+
# as `Amazon Linux 2`, `Amazon Linux 2018.03`, `Amazon Linux
|
|
435
|
+
# 2017.09`, `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, `Amazon
|
|
436
|
+
# Linux 2016.03`, `Amazon Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
435
437
|
#
|
|
436
|
-
# * A supported Ubuntu operating system, such as `Ubuntu
|
|
437
|
-
# `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
438
|
+
# * A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS`,
|
|
439
|
+
# `Ubuntu 16.04 LTS`, `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
438
440
|
#
|
|
439
441
|
# * `CentOS Linux 7`
|
|
440
442
|
#
|
|
@@ -449,9 +451,10 @@ module Aws::OpsWorks
|
|
|
449
451
|
# when you create instances. For more information about how to use
|
|
450
452
|
# custom AMIs with OpsWorks, see [Using Custom AMIs][1].
|
|
451
453
|
#
|
|
452
|
-
# The default option is the parent stack's operating system.
|
|
453
|
-
#
|
|
454
|
-
#
|
|
454
|
+
# The default option is the parent stack's operating system. Not all
|
|
455
|
+
# operating systems are supported with all versions of Chef. For more
|
|
456
|
+
# information about supported operating systems, see [OpsWorks Stacks
|
|
457
|
+
# Operating Systems][2].
|
|
455
458
|
#
|
|
456
459
|
# <note markdown="1"> You can specify a different Linux operating system for the cloned
|
|
457
460
|
# stack, but you cannot change from Linux to Windows or Windows to
|
|
@@ -557,28 +560,27 @@ module Aws::OpsWorks
|
|
|
557
560
|
# @return [Boolean]
|
|
558
561
|
#
|
|
559
562
|
# @!attribute [rw] use_opsworks_security_groups
|
|
560
|
-
# Whether to associate the
|
|
561
|
-
#
|
|
562
|
-
#
|
|
563
|
-
#
|
|
564
|
-
#
|
|
565
|
-
#
|
|
566
|
-
#
|
|
567
|
-
#
|
|
568
|
-
#
|
|
569
|
-
# * True -
|
|
570
|
-
#
|
|
571
|
-
#
|
|
572
|
-
#
|
|
573
|
-
#
|
|
574
|
-
#
|
|
575
|
-
#
|
|
576
|
-
# groups
|
|
577
|
-
#
|
|
578
|
-
# security group with
|
|
579
|
-
#
|
|
580
|
-
#
|
|
581
|
-
# layers that need custom settings.
|
|
563
|
+
# Whether to associate the OpsWorks Stacks built-in security groups
|
|
564
|
+
# with the stack's layers.
|
|
565
|
+
#
|
|
566
|
+
# OpsWorks Stacks provides a standard set of security groups, one for
|
|
567
|
+
# each layer, which are associated with layers by default. With
|
|
568
|
+
# `UseOpsworksSecurityGroups` you can instead provide your own custom
|
|
569
|
+
# security groups. `UseOpsworksSecurityGroups` has the following
|
|
570
|
+
# settings:
|
|
571
|
+
#
|
|
572
|
+
# * True - OpsWorks Stacks automatically associates the appropriate
|
|
573
|
+
# built-in security group with each layer (default setting). You can
|
|
574
|
+
# associate additional security groups with a layer after you create
|
|
575
|
+
# it but you cannot delete the built-in security group.
|
|
576
|
+
#
|
|
577
|
+
# * False - OpsWorks Stacks does not associate built-in security
|
|
578
|
+
# groups with layers. You must create appropriate Amazon EC2
|
|
579
|
+
# security groups and associate a security group with each layer
|
|
580
|
+
# that you create. However, you can still manually associate a
|
|
581
|
+
# built-in security group with a layer on creation; custom security
|
|
582
|
+
# groups are required only for those layers that need custom
|
|
583
|
+
# settings.
|
|
582
584
|
#
|
|
583
585
|
# For more information, see [Create a New Stack][1].
|
|
584
586
|
#
|
|
@@ -600,9 +602,9 @@ module Aws::OpsWorks
|
|
|
600
602
|
#
|
|
601
603
|
# @!attribute [rw] default_ssh_key_name
|
|
602
604
|
# A default Amazon EC2 key pair name. The default value is none. If
|
|
603
|
-
# you specify a key pair name,
|
|
604
|
-
#
|
|
605
|
-
#
|
|
605
|
+
# you specify a key pair name, OpsWorks installs the public key on the
|
|
606
|
+
# instance and you can use the private key with an SSH client to log
|
|
607
|
+
# in to the instance. For more information, see [ Using SSH to
|
|
606
608
|
# Communicate with an Instance][1] and [ Managing SSH Access][2]. You
|
|
607
609
|
# can override this setting by specifying a different key pair, or no
|
|
608
610
|
# key pair, when you [ create an instance][3].
|
|
@@ -634,16 +636,16 @@ module Aws::OpsWorks
|
|
|
634
636
|
# @return [String]
|
|
635
637
|
#
|
|
636
638
|
# @!attribute [rw] agent_version
|
|
637
|
-
# The default
|
|
638
|
-
#
|
|
639
|
+
# The default OpsWorks Stacks agent version. You have the following
|
|
640
|
+
# options:
|
|
639
641
|
#
|
|
640
|
-
# * Auto-update - Set this parameter to `LATEST`.
|
|
642
|
+
# * Auto-update - Set this parameter to `LATEST`. OpsWorks Stacks
|
|
641
643
|
# automatically installs new agent versions on the stack's
|
|
642
644
|
# instances as soon as they are available.
|
|
643
645
|
#
|
|
644
646
|
# * Fixed version - Set this parameter to your preferred agent
|
|
645
647
|
# version. To update the agent version, you must edit the stack
|
|
646
|
-
# configuration and specify a new version.
|
|
648
|
+
# configuration and specify a new version. OpsWorks Stacks
|
|
647
649
|
# automatically installs that version on the stack's instances.
|
|
648
650
|
#
|
|
649
651
|
# The default setting is `LATEST`. To specify an agent version, you
|
|
@@ -700,7 +702,7 @@ module Aws::OpsWorks
|
|
|
700
702
|
include Aws::Structure
|
|
701
703
|
end
|
|
702
704
|
|
|
703
|
-
# Describes the Amazon CloudWatch
|
|
705
|
+
# Describes the Amazon CloudWatch Logs configuration for a layer.
|
|
704
706
|
#
|
|
705
707
|
# @!attribute [rw] enabled
|
|
706
708
|
# Whether CloudWatch Logs is enabled for a layer.
|
|
@@ -719,9 +721,9 @@ module Aws::OpsWorks
|
|
|
719
721
|
include Aws::Structure
|
|
720
722
|
end
|
|
721
723
|
|
|
722
|
-
# Describes the
|
|
723
|
-
#
|
|
724
|
-
#
|
|
724
|
+
# Describes the CloudWatch Logs configuration for a layer. For detailed
|
|
725
|
+
# information about members of this data type, see the [CloudWatch Logs
|
|
726
|
+
# Agent Reference][1].
|
|
725
727
|
#
|
|
726
728
|
#
|
|
727
729
|
#
|
|
@@ -939,7 +941,7 @@ module Aws::OpsWorks
|
|
|
939
941
|
# @!attribute [rw] type
|
|
940
942
|
# The app type. Each supported type is associated with a particular
|
|
941
943
|
# layer. For example, PHP applications are associated with a PHP
|
|
942
|
-
# layer.
|
|
944
|
+
# layer. OpsWorks Stacks deploys an application to those instances
|
|
943
945
|
# that are members of the corresponding layer. If your app isn't one
|
|
944
946
|
# of the standard types, or you prefer to implement your own Deploy
|
|
945
947
|
# recipes, specify `other`.
|
|
@@ -1123,7 +1125,12 @@ module Aws::OpsWorks
|
|
|
1123
1125
|
# @return [String]
|
|
1124
1126
|
#
|
|
1125
1127
|
# @!attribute [rw] hostname
|
|
1126
|
-
# The instance host name.
|
|
1128
|
+
# The instance host name. The following are character limits for
|
|
1129
|
+
# instance host names.
|
|
1130
|
+
#
|
|
1131
|
+
# * Linux-based instances: 63 characters
|
|
1132
|
+
#
|
|
1133
|
+
# * Windows-based instances: 15 characters
|
|
1127
1134
|
# @return [String]
|
|
1128
1135
|
#
|
|
1129
1136
|
# @!attribute [rw] os
|
|
@@ -1131,12 +1138,12 @@ module Aws::OpsWorks
|
|
|
1131
1138
|
# following.
|
|
1132
1139
|
#
|
|
1133
1140
|
# * A supported Linux operating system: An Amazon Linux version, such
|
|
1134
|
-
# as `Amazon Linux
|
|
1135
|
-
# 2017.
|
|
1136
|
-
# Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
1141
|
+
# as `Amazon Linux 2`, `Amazon Linux 2018.03`, `Amazon Linux
|
|
1142
|
+
# 2017.09`, `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, `Amazon
|
|
1143
|
+
# Linux 2016.03`, `Amazon Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
1137
1144
|
#
|
|
1138
|
-
# * A supported Ubuntu operating system, such as `Ubuntu
|
|
1139
|
-
# `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
1145
|
+
# * A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS`,
|
|
1146
|
+
# `Ubuntu 16.04 LTS`, `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
1140
1147
|
#
|
|
1141
1148
|
# * `CentOS Linux 7`
|
|
1142
1149
|
#
|
|
@@ -1150,16 +1157,16 @@ module Aws::OpsWorks
|
|
|
1150
1157
|
#
|
|
1151
1158
|
# * A custom AMI: `Custom`.
|
|
1152
1159
|
#
|
|
1153
|
-
#
|
|
1154
|
-
#
|
|
1160
|
+
# Not all operating systems are supported with all versions of Chef.
|
|
1161
|
+
# For more information about the supported operating systems, see
|
|
1162
|
+
# [OpsWorks Stacks Operating Systems][1].
|
|
1155
1163
|
#
|
|
1156
1164
|
# The default option is the current Amazon Linux version. If you set
|
|
1157
1165
|
# this parameter to `Custom`, you must use the CreateInstance
|
|
1158
1166
|
# action's AmiId parameter to specify the custom AMI that you want to
|
|
1159
1167
|
# use. Block device mappings are not supported if the value is
|
|
1160
|
-
# `Custom`. For more information about
|
|
1161
|
-
# see [
|
|
1162
|
-
# custom AMIs with AWS OpsWorks Stacks, see [Using Custom AMIs][2].
|
|
1168
|
+
# `Custom`. For more information about how to use custom AMIs with
|
|
1169
|
+
# OpsWorks Stacks, see [Using Custom AMIs][2].
|
|
1163
1170
|
#
|
|
1164
1171
|
#
|
|
1165
1172
|
#
|
|
@@ -1201,7 +1208,7 @@ module Aws::OpsWorks
|
|
|
1201
1208
|
# @!attribute [rw] subnet_id
|
|
1202
1209
|
# The ID of the instance's subnet. If the stack is running in a VPC,
|
|
1203
1210
|
# you can use this parameter to override the stack's default subnet
|
|
1204
|
-
# ID value and direct
|
|
1211
|
+
# ID value and direct OpsWorks Stacks to launch the instance in a
|
|
1205
1212
|
# different subnet.
|
|
1206
1213
|
# @return [String]
|
|
1207
1214
|
#
|
|
@@ -1255,16 +1262,15 @@ module Aws::OpsWorks
|
|
|
1255
1262
|
# @return [Boolean]
|
|
1256
1263
|
#
|
|
1257
1264
|
# @!attribute [rw] agent_version
|
|
1258
|
-
# The default
|
|
1259
|
-
#
|
|
1265
|
+
# The default OpsWorks Stacks agent version. You have the following
|
|
1266
|
+
# options:
|
|
1260
1267
|
#
|
|
1261
1268
|
# * `INHERIT` - Use the stack's default agent version setting.
|
|
1262
1269
|
#
|
|
1263
1270
|
# * *version\_number* - Use the specified agent version. This value
|
|
1264
1271
|
# overrides the stack's default setting. To update the agent
|
|
1265
1272
|
# version, edit the instance configuration and specify a new
|
|
1266
|
-
# version.
|
|
1267
|
-
# version on the instance.
|
|
1273
|
+
# version. OpsWorks Stacks installs that version on the instance.
|
|
1268
1274
|
#
|
|
1269
1275
|
# The default setting is `INHERIT`. To specify an agent version, you
|
|
1270
1276
|
# must use the complete version number, not the abbreviated number
|
|
@@ -1341,19 +1347,20 @@ module Aws::OpsWorks
|
|
|
1341
1347
|
# @return [String]
|
|
1342
1348
|
#
|
|
1343
1349
|
# @!attribute [rw] name
|
|
1344
|
-
# The layer name, which is used by the console.
|
|
1350
|
+
# The layer name, which is used by the console. Layer names can be a
|
|
1351
|
+
# maximum of 32 characters.
|
|
1345
1352
|
# @return [String]
|
|
1346
1353
|
#
|
|
1347
1354
|
# @!attribute [rw] shortname
|
|
1348
1355
|
# For custom layers only, use this parameter to specify the layer's
|
|
1349
|
-
# short name, which is used internally by
|
|
1350
|
-
#
|
|
1351
|
-
#
|
|
1352
|
-
#
|
|
1353
|
-
# '
|
|
1356
|
+
# short name, which is used internally by OpsWorks Stacks and by Chef
|
|
1357
|
+
# recipes. The short name is also used as the name for the directory
|
|
1358
|
+
# where your app files are installed. It can have a maximum of 32
|
|
1359
|
+
# characters, which are limited to the alphanumeric characters, '-',
|
|
1360
|
+
# '\_', and '.'.
|
|
1354
1361
|
#
|
|
1355
|
-
#
|
|
1356
|
-
#
|
|
1362
|
+
# Built-in layer short names are defined by OpsWorks Stacks. For more
|
|
1363
|
+
# information, see the [Layer Reference][1].
|
|
1357
1364
|
#
|
|
1358
1365
|
#
|
|
1359
1366
|
#
|
|
@@ -1386,7 +1393,7 @@ module Aws::OpsWorks
|
|
|
1386
1393
|
# A JSON-formatted string containing custom stack configuration and
|
|
1387
1394
|
# deployment attributes to be installed on the layer's instances. For
|
|
1388
1395
|
# more information, see [ Using Custom JSON][1]. This feature is
|
|
1389
|
-
# supported as of version 1.7.42 of the
|
|
1396
|
+
# supported as of version 1.7.42 of the CLI.
|
|
1390
1397
|
#
|
|
1391
1398
|
#
|
|
1392
1399
|
#
|
|
@@ -1500,19 +1507,20 @@ module Aws::OpsWorks
|
|
|
1500
1507
|
end
|
|
1501
1508
|
|
|
1502
1509
|
# @!attribute [rw] name
|
|
1503
|
-
# The stack name.
|
|
1510
|
+
# The stack name. Stack names can be a maximum of 64 characters.
|
|
1504
1511
|
# @return [String]
|
|
1505
1512
|
#
|
|
1506
1513
|
# @!attribute [rw] region
|
|
1507
|
-
# The stack's
|
|
1508
|
-
# about Amazon
|
|
1509
|
-
#
|
|
1510
|
-
#
|
|
1511
|
-
# the `--stack-region` parameter
|
|
1512
|
-
# `--region`
|
|
1513
|
-
#
|
|
1514
|
-
#
|
|
1515
|
-
#
|
|
1514
|
+
# The stack's Amazon Web Services Region, such as `ap-south-1`. For
|
|
1515
|
+
# more information about Amazon Web Services Regions, see [Regions and
|
|
1516
|
+
# Endpoints][1].
|
|
1517
|
+
#
|
|
1518
|
+
# <note markdown="1"> In the CLI, this API maps to the `--stack-region` parameter. If the
|
|
1519
|
+
# `--stack-region` parameter and the CLI common parameter `--region`
|
|
1520
|
+
# are set to the same value, the stack uses a *regional* endpoint. If
|
|
1521
|
+
# the `--stack-region` parameter is not set, but the CLI `--region`
|
|
1522
|
+
# parameter is, this also results in a stack with a *regional*
|
|
1523
|
+
# endpoint. However, if the `--region` parameter is set to
|
|
1516
1524
|
# `us-east-1`, and the `--stack-region` parameter is set to one of the
|
|
1517
1525
|
# following, then the stack uses a legacy or *classic* region:
|
|
1518
1526
|
# `us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1,
|
|
@@ -1520,11 +1528,11 @@ module Aws::OpsWorks
|
|
|
1520
1528
|
# actual API endpoint of the stack is in `us-east-1`. Only the
|
|
1521
1529
|
# preceding regions are supported as classic regions in the
|
|
1522
1530
|
# `us-east-1` API endpoint. Because it is a best practice to choose
|
|
1523
|
-
# the regional endpoint that is closest to where you manage
|
|
1524
|
-
# recommend that you use regional endpoints for new
|
|
1525
|
-
# CLI common `--region` parameter always specifies a
|
|
1526
|
-
# endpoint; it cannot be used to specify a classic
|
|
1527
|
-
# region.
|
|
1531
|
+
# the regional endpoint that is closest to where you manage Amazon Web
|
|
1532
|
+
# Services, we recommend that you use regional endpoints for new
|
|
1533
|
+
# stacks. The CLI common `--region` parameter always specifies a
|
|
1534
|
+
# regional API endpoint; it cannot be used to specify a classic
|
|
1535
|
+
# OpsWorks Stacks region.
|
|
1528
1536
|
#
|
|
1529
1537
|
# </note>
|
|
1530
1538
|
#
|
|
@@ -1546,9 +1554,9 @@ module Aws::OpsWorks
|
|
|
1546
1554
|
#
|
|
1547
1555
|
# If the VPC ID corresponds to a default VPC and you have specified
|
|
1548
1556
|
# either the `DefaultAvailabilityZone` or the `DefaultSubnetId`
|
|
1549
|
-
# parameter only,
|
|
1550
|
-
# parameter. If you specify neither parameter,
|
|
1551
|
-
#
|
|
1557
|
+
# parameter only, OpsWorks Stacks infers the value of the other
|
|
1558
|
+
# parameter. If you specify neither parameter, OpsWorks Stacks sets
|
|
1559
|
+
# these parameters to the first valid Availability Zone for the
|
|
1552
1560
|
# specified region and the corresponding default VPC subnet ID,
|
|
1553
1561
|
# respectively.
|
|
1554
1562
|
#
|
|
@@ -1559,8 +1567,8 @@ module Aws::OpsWorks
|
|
|
1559
1567
|
#
|
|
1560
1568
|
# * You must specify a value for `DefaultSubnetId`.
|
|
1561
1569
|
#
|
|
1562
|
-
# For more information about how to use
|
|
1563
|
-
#
|
|
1570
|
+
# For more information about how to use OpsWorks Stacks with a VPC,
|
|
1571
|
+
# see [Running a Stack in a VPC][1]. For more information about
|
|
1564
1572
|
# default VPC and EC2-Classic, see [Supported Platforms][2].
|
|
1565
1573
|
#
|
|
1566
1574
|
#
|
|
@@ -1575,11 +1583,11 @@ module Aws::OpsWorks
|
|
|
1575
1583
|
# @return [Hash<String,String>]
|
|
1576
1584
|
#
|
|
1577
1585
|
# @!attribute [rw] service_role_arn
|
|
1578
|
-
# The stack's
|
|
1579
|
-
#
|
|
1580
|
-
#
|
|
1581
|
-
#
|
|
1582
|
-
#
|
|
1586
|
+
# The stack's IAM role, which allows OpsWorks Stacks to work with
|
|
1587
|
+
# Amazon Web Services resources on your behalf. You must set this
|
|
1588
|
+
# parameter to the Amazon Resource Name (ARN) for an existing IAM
|
|
1589
|
+
# role. For more information about IAM ARNs, see [Using
|
|
1590
|
+
# Identifiers][1].
|
|
1583
1591
|
#
|
|
1584
1592
|
#
|
|
1585
1593
|
#
|
|
@@ -1602,12 +1610,12 @@ module Aws::OpsWorks
|
|
|
1602
1610
|
# create the instance. You can specify one of the following.
|
|
1603
1611
|
#
|
|
1604
1612
|
# * A supported Linux operating system: An Amazon Linux version, such
|
|
1605
|
-
# as `Amazon Linux
|
|
1606
|
-
# 2017.
|
|
1607
|
-
# Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
1613
|
+
# as `Amazon Linux 2`, `Amazon Linux 2018.03`, `Amazon Linux
|
|
1614
|
+
# 2017.09`, `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, `Amazon
|
|
1615
|
+
# Linux 2016.03`, `Amazon Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
1608
1616
|
#
|
|
1609
|
-
# * A supported Ubuntu operating system, such as `Ubuntu
|
|
1610
|
-
# `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
1617
|
+
# * A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS`,
|
|
1618
|
+
# `Ubuntu 16.04 LTS`, `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
1611
1619
|
#
|
|
1612
1620
|
# * `CentOS Linux 7`
|
|
1613
1621
|
#
|
|
@@ -1623,9 +1631,10 @@ module Aws::OpsWorks
|
|
|
1623
1631
|
# when you create instances. For more information, see [ Using
|
|
1624
1632
|
# Custom AMIs][1].
|
|
1625
1633
|
#
|
|
1626
|
-
# The default option is the current Amazon Linux version.
|
|
1627
|
-
#
|
|
1628
|
-
#
|
|
1634
|
+
# The default option is the current Amazon Linux version. Not all
|
|
1635
|
+
# operating systems are supported with all versions of Chef. For more
|
|
1636
|
+
# information about supported operating systems, see [OpsWorks Stacks
|
|
1637
|
+
# Operating Systems][2].
|
|
1629
1638
|
#
|
|
1630
1639
|
#
|
|
1631
1640
|
#
|
|
@@ -1726,22 +1735,21 @@ module Aws::OpsWorks
|
|
|
1726
1735
|
# @return [Boolean]
|
|
1727
1736
|
#
|
|
1728
1737
|
# @!attribute [rw] use_opsworks_security_groups
|
|
1729
|
-
# Whether to associate the
|
|
1730
|
-
#
|
|
1738
|
+
# Whether to associate the OpsWorks Stacks built-in security groups
|
|
1739
|
+
# with the stack's layers.
|
|
1731
1740
|
#
|
|
1732
|
-
#
|
|
1733
|
-
#
|
|
1734
|
-
#
|
|
1735
|
-
#
|
|
1741
|
+
# OpsWorks Stacks provides a standard set of built-in security groups,
|
|
1742
|
+
# one for each layer, which are associated with layers by default.
|
|
1743
|
+
# With `UseOpsworksSecurityGroups` you can instead provide your own
|
|
1744
|
+
# custom security groups. `UseOpsworksSecurityGroups` has the
|
|
1736
1745
|
# following settings:
|
|
1737
1746
|
#
|
|
1738
|
-
# * True -
|
|
1739
|
-
#
|
|
1740
|
-
#
|
|
1741
|
-
#
|
|
1742
|
-
# security group.
|
|
1747
|
+
# * True - OpsWorks Stacks automatically associates the appropriate
|
|
1748
|
+
# built-in security group with each layer (default setting). You can
|
|
1749
|
+
# associate additional security groups with a layer after you create
|
|
1750
|
+
# it, but you cannot delete the built-in security group.
|
|
1743
1751
|
#
|
|
1744
|
-
# * False -
|
|
1752
|
+
# * False - OpsWorks Stacks does not associate built-in security
|
|
1745
1753
|
# groups with layers. You must create appropriate EC2 security
|
|
1746
1754
|
# groups and associate a security group with each layer that you
|
|
1747
1755
|
# create. However, you can still manually associate a built-in
|
|
@@ -1768,9 +1776,9 @@ module Aws::OpsWorks
|
|
|
1768
1776
|
#
|
|
1769
1777
|
# @!attribute [rw] default_ssh_key_name
|
|
1770
1778
|
# A default Amazon EC2 key pair name. The default value is none. If
|
|
1771
|
-
# you specify a key pair name,
|
|
1772
|
-
#
|
|
1773
|
-
#
|
|
1779
|
+
# you specify a key pair name, OpsWorks installs the public key on the
|
|
1780
|
+
# instance and you can use the private key with an SSH client to log
|
|
1781
|
+
# in to the instance. For more information, see [ Using SSH to
|
|
1774
1782
|
# Communicate with an Instance][1] and [ Managing SSH Access][2]. You
|
|
1775
1783
|
# can override this setting by specifying a different key pair, or no
|
|
1776
1784
|
# key pair, when you [ create an instance][3].
|
|
@@ -1794,17 +1802,17 @@ module Aws::OpsWorks
|
|
|
1794
1802
|
# @return [String]
|
|
1795
1803
|
#
|
|
1796
1804
|
# @!attribute [rw] agent_version
|
|
1797
|
-
# The default
|
|
1798
|
-
#
|
|
1805
|
+
# The default OpsWorks Stacks agent version. You have the following
|
|
1806
|
+
# options:
|
|
1799
1807
|
#
|
|
1800
|
-
# * Auto-update - Set this parameter to `LATEST`.
|
|
1808
|
+
# * Auto-update - Set this parameter to `LATEST`. OpsWorks Stacks
|
|
1801
1809
|
# automatically installs new agent versions on the stack's
|
|
1802
1810
|
# instances as soon as they are available.
|
|
1803
1811
|
#
|
|
1804
1812
|
# * Fixed version - Set this parameter to your preferred agent
|
|
1805
1813
|
# version. To update the agent version, you must edit the stack
|
|
1806
|
-
# configuration and specify a new version.
|
|
1807
|
-
#
|
|
1814
|
+
# configuration and specify a new version. OpsWorks Stacks installs
|
|
1815
|
+
# that version on the stack's instances.
|
|
1808
1816
|
#
|
|
1809
1817
|
# The default setting is the most recent release of the agent. To
|
|
1810
1818
|
# specify an agent version, you must use the complete version number,
|
|
@@ -1866,10 +1874,9 @@ module Aws::OpsWorks
|
|
|
1866
1874
|
# @!attribute [rw] ssh_username
|
|
1867
1875
|
# The user's SSH user name. The allowable characters are \[a-z\],
|
|
1868
1876
|
# \[A-Z\], \[0-9\], '-', and '\_'. If the specified name includes
|
|
1869
|
-
# other punctuation marks,
|
|
1870
|
-
#
|
|
1871
|
-
#
|
|
1872
|
-
# IAM user name.
|
|
1877
|
+
# other punctuation marks, OpsWorks Stacks removes them. For example,
|
|
1878
|
+
# `my.name` is changed to `myname`. If you do not specify an SSH user
|
|
1879
|
+
# name, OpsWorks Stacks generates one from the IAM user name.
|
|
1873
1880
|
# @return [String]
|
|
1874
1881
|
#
|
|
1875
1882
|
# @!attribute [rw] ssh_public_key
|
|
@@ -2126,8 +2133,8 @@ module Aws::OpsWorks
|
|
|
2126
2133
|
# default setting is \\\{"migrate":\["false"\]\\}.
|
|
2127
2134
|
#
|
|
2128
2135
|
# * `rollback` Roll the app back to the previous version. When you
|
|
2129
|
-
# update an app,
|
|
2130
|
-
#
|
|
2136
|
+
# update an app, OpsWorks Stacks stores the previous version, up to
|
|
2137
|
+
# a maximum of five versions. You can use this command to roll an
|
|
2131
2138
|
# app back as many as four versions.
|
|
2132
2139
|
#
|
|
2133
2140
|
# * `start`: Start the app's web or application server.
|
|
@@ -2148,19 +2155,19 @@ module Aws::OpsWorks
|
|
|
2148
2155
|
#
|
|
2149
2156
|
# The `update_dependencies` command takes two arguments:
|
|
2150
2157
|
#
|
|
2151
|
-
# * `upgrade_os_to` - Specifies the
|
|
2152
|
-
# instances
|
|
2153
|
-
#
|
|
2158
|
+
# * `upgrade_os_to` - Specifies the Amazon Linux version that you want
|
|
2159
|
+
# instances to run, such as `Amazon Linux 2`. You must also set the
|
|
2160
|
+
# `allow_reboot` argument to true.
|
|
2154
2161
|
#
|
|
2155
|
-
# * `allow_reboot` - Specifies whether to allow
|
|
2162
|
+
# * `allow_reboot` - Specifies whether to allow OpsWorks Stacks to
|
|
2156
2163
|
# reboot the instances if necessary, after installing the updates.
|
|
2157
2164
|
# This argument can be set to either `true` or `false`. The default
|
|
2158
2165
|
# value is `false`.
|
|
2159
2166
|
#
|
|
2160
|
-
# For example, to upgrade an instance to Amazon Linux
|
|
2167
|
+
# For example, to upgrade an instance to Amazon Linux 2018.03, set
|
|
2161
2168
|
# `Args` to the following.
|
|
2162
2169
|
#
|
|
2163
|
-
# ` \{ "upgrade_os_to":["Amazon Linux
|
|
2170
|
+
# ` \{ "upgrade_os_to":["Amazon Linux 2018.03"],
|
|
2164
2171
|
# "allow_reboot":["true"] \} `
|
|
2165
2172
|
# @return [Hash<String,Array<String>>]
|
|
2166
2173
|
#
|
|
@@ -2222,9 +2229,9 @@ module Aws::OpsWorks
|
|
|
2222
2229
|
end
|
|
2223
2230
|
|
|
2224
2231
|
# @!attribute [rw] volume_id
|
|
2225
|
-
# The
|
|
2226
|
-
#
|
|
2227
|
-
#
|
|
2232
|
+
# The OpsWorks Stacks volume ID, which is the GUID that OpsWorks
|
|
2233
|
+
# Stacks assigned to the instance when you registered the volume with
|
|
2234
|
+
# the stack, not the Amazon EC2 volume ID.
|
|
2228
2235
|
# @return [String]
|
|
2229
2236
|
#
|
|
2230
2237
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DeregisterVolumeRequest AWS API Documentation
|
|
@@ -2835,7 +2842,7 @@ module Aws::OpsWorks
|
|
|
2835
2842
|
# request.
|
|
2836
2843
|
#
|
|
2837
2844
|
# @!attribute [rw] agent_installer_url
|
|
2838
|
-
# The
|
|
2845
|
+
# The OpsWorks Stacks agent installer's URL.
|
|
2839
2846
|
# @return [String]
|
|
2840
2847
|
#
|
|
2841
2848
|
# @!attribute [rw] parameters
|
|
@@ -2879,8 +2886,13 @@ module Aws::OpsWorks
|
|
|
2879
2886
|
|
|
2880
2887
|
# @!attribute [rw] stack_ids
|
|
2881
2888
|
# An array of stack IDs that specify the stacks to be described. If
|
|
2882
|
-
# you omit this parameter,
|
|
2883
|
-
# every
|
|
2889
|
+
# you omit this parameter, and have permissions to get information
|
|
2890
|
+
# about all stacks, `DescribeStacks` returns a description of every
|
|
2891
|
+
# stack. If the IAM policy that is attached to an IAM user limits the
|
|
2892
|
+
# `DescribeStacks` action to specific stack ARNs, this parameter is
|
|
2893
|
+
# required, and the user must specify a stack ARN that is allowed by
|
|
2894
|
+
# the policy. Otherwise, `DescribeStacks` returns an `AccessDenied`
|
|
2895
|
+
# error.
|
|
2884
2896
|
# @return [Array<String>]
|
|
2885
2897
|
#
|
|
2886
2898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeStacksRequest AWS API Documentation
|
|
@@ -3074,9 +3086,9 @@ module Aws::OpsWorks
|
|
|
3074
3086
|
#
|
|
3075
3087
|
# If you specify the `io1` volume type, you must also specify a value
|
|
3076
3088
|
# for the `Iops` attribute. The maximum ratio of provisioned IOPS to
|
|
3077
|
-
# requested volume size (in GiB) is 50:1.
|
|
3078
|
-
# size (in GiB) specified in the AMI attributes to set
|
|
3079
|
-
# (volume size).
|
|
3089
|
+
# requested volume size (in GiB) is 50:1. Amazon Web Services uses the
|
|
3090
|
+
# default volume size (in GiB) specified in the AMI attributes to set
|
|
3091
|
+
# IOPS to 50 x (volume size).
|
|
3080
3092
|
# @return [String]
|
|
3081
3093
|
#
|
|
3082
3094
|
# @!attribute [rw] delete_on_termination
|
|
@@ -3131,7 +3143,7 @@ module Aws::OpsWorks
|
|
|
3131
3143
|
# @return [String]
|
|
3132
3144
|
#
|
|
3133
3145
|
# @!attribute [rw] name
|
|
3134
|
-
# The name.
|
|
3146
|
+
# The name, which can be a maximum of 32 characters.
|
|
3135
3147
|
# @return [String]
|
|
3136
3148
|
#
|
|
3137
3149
|
# @!attribute [rw] domain
|
|
@@ -3139,8 +3151,8 @@ module Aws::OpsWorks
|
|
|
3139
3151
|
# @return [String]
|
|
3140
3152
|
#
|
|
3141
3153
|
# @!attribute [rw] region
|
|
3142
|
-
# The
|
|
3143
|
-
# Endpoints][1].
|
|
3154
|
+
# The Amazon Web Services Region. For more information, see [Regions
|
|
3155
|
+
# and Endpoints][1].
|
|
3144
3156
|
#
|
|
3145
3157
|
#
|
|
3146
3158
|
#
|
|
@@ -3166,11 +3178,11 @@ module Aws::OpsWorks
|
|
|
3166
3178
|
# Describes an Elastic Load Balancing instance.
|
|
3167
3179
|
#
|
|
3168
3180
|
# @!attribute [rw] elastic_load_balancer_name
|
|
3169
|
-
# The Elastic Load Balancing instance
|
|
3181
|
+
# The Elastic Load Balancing instance name.
|
|
3170
3182
|
# @return [String]
|
|
3171
3183
|
#
|
|
3172
3184
|
# @!attribute [rw] region
|
|
3173
|
-
# The instance's
|
|
3185
|
+
# The instance's Amazon Web Services Region.
|
|
3174
3186
|
# @return [String]
|
|
3175
3187
|
#
|
|
3176
3188
|
# @!attribute [rw] dns_name
|
|
@@ -3178,11 +3190,11 @@ module Aws::OpsWorks
|
|
|
3178
3190
|
# @return [String]
|
|
3179
3191
|
#
|
|
3180
3192
|
# @!attribute [rw] stack_id
|
|
3181
|
-
# The ID of the stack
|
|
3193
|
+
# The ID of the stack with which the instance is associated.
|
|
3182
3194
|
# @return [String]
|
|
3183
3195
|
#
|
|
3184
3196
|
# @!attribute [rw] layer_id
|
|
3185
|
-
# The ID of the layer
|
|
3197
|
+
# The ID of the layer to which the instance is attached.
|
|
3186
3198
|
# @return [String]
|
|
3187
3199
|
#
|
|
3188
3200
|
# @!attribute [rw] vpc_id
|
|
@@ -3198,8 +3210,8 @@ module Aws::OpsWorks
|
|
|
3198
3210
|
# @return [Array<String>]
|
|
3199
3211
|
#
|
|
3200
3212
|
# @!attribute [rw] ec2_instance_ids
|
|
3201
|
-
# A list of the EC2 instances
|
|
3202
|
-
# is managing traffic
|
|
3213
|
+
# A list of the EC2 instances for which the Elastic Load Balancing
|
|
3214
|
+
# instance is managing traffic.
|
|
3203
3215
|
# @return [Array<String>]
|
|
3204
3216
|
#
|
|
3205
3217
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/ElasticLoadBalancer AWS API Documentation
|
|
@@ -3234,11 +3246,11 @@ module Aws::OpsWorks
|
|
|
3234
3246
|
# @return [String]
|
|
3235
3247
|
#
|
|
3236
3248
|
# @!attribute [rw] secure
|
|
3237
|
-
# (Optional) Whether the variable's value
|
|
3238
|
-
# DescribeApps action. To
|
|
3239
|
-
#
|
|
3240
|
-
#
|
|
3241
|
-
#
|
|
3249
|
+
# (Optional) Whether the variable's value is returned by the
|
|
3250
|
+
# DescribeApps action. To hide an environment variable's value, set
|
|
3251
|
+
# `Secure` to `true`. `DescribeApps` returns `*****FILTERED*****`
|
|
3252
|
+
# instead of the actual value. The default value for `Secure` is
|
|
3253
|
+
# `false`.
|
|
3242
3254
|
# @return [Boolean]
|
|
3243
3255
|
#
|
|
3244
3256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/EnvironmentVariable AWS API Documentation
|
|
@@ -3283,14 +3295,14 @@ module Aws::OpsWorks
|
|
|
3283
3295
|
end
|
|
3284
3296
|
|
|
3285
3297
|
# @!attribute [rw] instance_id
|
|
3286
|
-
# The instance's
|
|
3298
|
+
# The instance's OpsWorks Stacks ID.
|
|
3287
3299
|
# @return [String]
|
|
3288
3300
|
#
|
|
3289
3301
|
# @!attribute [rw] valid_for_in_minutes
|
|
3290
3302
|
# The length of time (in minutes) that the grant is valid. When the
|
|
3291
3303
|
# grant expires at the end of this period, the user will no longer be
|
|
3292
3304
|
# able to use the credentials to log in. If the user is logged in at
|
|
3293
|
-
# the time,
|
|
3305
|
+
# the time, they are logged out.
|
|
3294
3306
|
# @return [Integer]
|
|
3295
3307
|
#
|
|
3296
3308
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/GrantAccessRequest AWS API Documentation
|
|
@@ -3382,7 +3394,7 @@ module Aws::OpsWorks
|
|
|
3382
3394
|
# @return [String]
|
|
3383
3395
|
#
|
|
3384
3396
|
# @!attribute [rw] elastic_ip
|
|
3385
|
-
# The instance [Elastic IP address
|
|
3397
|
+
# The instance [Elastic IP address][1].
|
|
3386
3398
|
#
|
|
3387
3399
|
#
|
|
3388
3400
|
#
|
|
@@ -3390,7 +3402,12 @@ module Aws::OpsWorks
|
|
|
3390
3402
|
# @return [String]
|
|
3391
3403
|
#
|
|
3392
3404
|
# @!attribute [rw] hostname
|
|
3393
|
-
# The instance host name.
|
|
3405
|
+
# The instance host name. The following are character limits for
|
|
3406
|
+
# instance host names.
|
|
3407
|
+
#
|
|
3408
|
+
# * Linux-based instances: 63 characters
|
|
3409
|
+
#
|
|
3410
|
+
# * Windows-based instances: 15 characters
|
|
3394
3411
|
# @return [String]
|
|
3395
3412
|
#
|
|
3396
3413
|
# @!attribute [rw] infrastructure_class
|
|
@@ -3401,12 +3418,12 @@ module Aws::OpsWorks
|
|
|
3401
3418
|
# @!attribute [rw] install_updates_on_boot
|
|
3402
3419
|
# Whether to install operating system and package updates when the
|
|
3403
3420
|
# instance boots. The default value is `true`. If this value is set to
|
|
3404
|
-
# `false`, you must
|
|
3421
|
+
# `false`, you must update instances manually by using
|
|
3405
3422
|
# CreateDeployment to run the `update_dependencies` stack command or
|
|
3406
3423
|
# by manually running `yum` (Amazon Linux) or `apt-get` (Ubuntu) on
|
|
3407
3424
|
# the instances.
|
|
3408
3425
|
#
|
|
3409
|
-
# <note markdown="1"> We strongly recommend using the default value of `true
|
|
3426
|
+
# <note markdown="1"> We strongly recommend using the default value of `true` to ensure
|
|
3410
3427
|
# that your instances have the latest security updates.
|
|
3411
3428
|
#
|
|
3412
3429
|
# </note>
|
|
@@ -3467,7 +3484,7 @@ module Aws::OpsWorks
|
|
|
3467
3484
|
# @return [String]
|
|
3468
3485
|
#
|
|
3469
3486
|
# @!attribute [rw] reported_agent_version
|
|
3470
|
-
# The instance's reported
|
|
3487
|
+
# The instance's reported OpsWorks Stacks agent version.
|
|
3471
3488
|
# @return [String]
|
|
3472
3489
|
#
|
|
3473
3490
|
# @!attribute [rw] reported_os
|
|
@@ -3756,7 +3773,7 @@ module Aws::OpsWorks
|
|
|
3756
3773
|
# @return [String]
|
|
3757
3774
|
#
|
|
3758
3775
|
# @!attribute [rw] name
|
|
3759
|
-
# The layer name.
|
|
3776
|
+
# The layer name. Layer names can be a maximum of 32 characters.
|
|
3760
3777
|
# @return [String]
|
|
3761
3778
|
#
|
|
3762
3779
|
# @!attribute [rw] shortname
|
|
@@ -3767,10 +3784,10 @@ module Aws::OpsWorks
|
|
|
3767
3784
|
# The layer attributes.
|
|
3768
3785
|
#
|
|
3769
3786
|
# For the `HaproxyStatsPassword`, `MysqlRootPassword`, and
|
|
3770
|
-
# `GangliaPassword` attributes,
|
|
3787
|
+
# `GangliaPassword` attributes, OpsWorks Stacks returns
|
|
3771
3788
|
# `*****FILTERED*****` instead of the actual value
|
|
3772
3789
|
#
|
|
3773
|
-
# For an ECS Cluster layer,
|
|
3790
|
+
# For an ECS Cluster layer, OpsWorks Stacks the `EcsClusterArn`
|
|
3774
3791
|
# attribute is set to the cluster's ARN.
|
|
3775
3792
|
# @return [Hash<String,String>]
|
|
3776
3793
|
#
|
|
@@ -3836,14 +3853,13 @@ module Aws::OpsWorks
|
|
|
3836
3853
|
# @return [Boolean]
|
|
3837
3854
|
#
|
|
3838
3855
|
# @!attribute [rw] default_recipes
|
|
3839
|
-
#
|
|
3856
|
+
# OpsWorks Stacks supports five lifecycle events: **setup**,
|
|
3840
3857
|
# **configuration**, **deploy**, **undeploy**, and **shutdown**. For
|
|
3841
|
-
# each layer,
|
|
3842
|
-
#
|
|
3843
|
-
#
|
|
3844
|
-
#
|
|
3845
|
-
#
|
|
3846
|
-
# of the five events.
|
|
3858
|
+
# each layer, OpsWorks Stacks runs a set of standard recipes for each
|
|
3859
|
+
# event. You can also provide custom recipes for any or all layers and
|
|
3860
|
+
# events. OpsWorks Stacks runs custom event recipes after the standard
|
|
3861
|
+
# recipes. `LayerCustomRecipes` specifies the custom recipes for a
|
|
3862
|
+
# particular layer to be run in response to each of the five events.
|
|
3847
3863
|
#
|
|
3848
3864
|
# To specify a recipe, use the cookbook's directory name in the
|
|
3849
3865
|
# repository followed by two colons and the recipe name, which is the
|
|
@@ -3989,14 +4005,14 @@ module Aws::OpsWorks
|
|
|
3989
4005
|
#
|
|
3990
4006
|
# @!attribute [rw] up_scaling
|
|
3991
4007
|
# An `AutoScalingThresholds` object that describes the upscaling
|
|
3992
|
-
# configuration, which defines how and when
|
|
3993
|
-
#
|
|
4008
|
+
# configuration, which defines how and when OpsWorks Stacks increases
|
|
4009
|
+
# the number of instances.
|
|
3994
4010
|
# @return [Types::AutoScalingThresholds]
|
|
3995
4011
|
#
|
|
3996
4012
|
# @!attribute [rw] down_scaling
|
|
3997
4013
|
# An `AutoScalingThresholds` object that describes the downscaling
|
|
3998
|
-
# configuration, which defines how and when
|
|
3999
|
-
#
|
|
4014
|
+
# configuration, which defines how and when OpsWorks Stacks reduces
|
|
4015
|
+
# the number of instances.
|
|
4000
4016
|
# @return [Types::AutoScalingThresholds]
|
|
4001
4017
|
#
|
|
4002
4018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/LoadBasedAutoScalingConfiguration AWS API Documentation
|
|
@@ -4010,15 +4026,14 @@ module Aws::OpsWorks
|
|
|
4010
4026
|
include Aws::Structure
|
|
4011
4027
|
end
|
|
4012
4028
|
|
|
4013
|
-
# Describes supported operating systems in
|
|
4029
|
+
# Describes supported operating systems in OpsWorks Stacks.
|
|
4014
4030
|
#
|
|
4015
4031
|
# @!attribute [rw] name
|
|
4016
|
-
# The name of the operating system, such as `Amazon Linux
|
|
4032
|
+
# The name of the operating system, such as `Amazon Linux 2`.
|
|
4017
4033
|
# @return [String]
|
|
4018
4034
|
#
|
|
4019
4035
|
# @!attribute [rw] id
|
|
4020
|
-
# The ID of a supported operating system, such as `Amazon Linux
|
|
4021
|
-
# 2018.03`.
|
|
4036
|
+
# The ID of a supported operating system, such as `Amazon Linux 2`.
|
|
4022
4037
|
# @return [String]
|
|
4023
4038
|
#
|
|
4024
4039
|
# @!attribute [rw] type
|
|
@@ -4027,8 +4042,8 @@ module Aws::OpsWorks
|
|
|
4027
4042
|
# @return [String]
|
|
4028
4043
|
#
|
|
4029
4044
|
# @!attribute [rw] configuration_managers
|
|
4030
|
-
# Supported configuration manager name and versions for an
|
|
4031
|
-
#
|
|
4045
|
+
# Supported configuration manager name and versions for an OpsWorks
|
|
4046
|
+
# Stacks operating system.
|
|
4032
4047
|
# @return [Array<Types::OperatingSystemConfigurationManager>]
|
|
4033
4048
|
#
|
|
4034
4049
|
# @!attribute [rw] reported_name
|
|
@@ -4088,9 +4103,9 @@ module Aws::OpsWorks
|
|
|
4088
4103
|
# @return [String]
|
|
4089
4104
|
#
|
|
4090
4105
|
# @!attribute [rw] iam_user_arn
|
|
4091
|
-
# The Amazon Resource Name (ARN) for an
|
|
4092
|
-
#
|
|
4093
|
-
#
|
|
4106
|
+
# The Amazon Resource Name (ARN) for an Identity and Access Management
|
|
4107
|
+
# (IAM) role. For more information about IAM ARNs, see [Using
|
|
4108
|
+
# Identifiers][1].
|
|
4094
4109
|
#
|
|
4095
4110
|
#
|
|
4096
4111
|
#
|
|
@@ -4228,7 +4243,7 @@ module Aws::OpsWorks
|
|
|
4228
4243
|
# @return [String]
|
|
4229
4244
|
#
|
|
4230
4245
|
# @!attribute [rw] db_instance_identifier
|
|
4231
|
-
# The
|
|
4246
|
+
# The database instance identifier.
|
|
4232
4247
|
# @return [String]
|
|
4233
4248
|
#
|
|
4234
4249
|
# @!attribute [rw] db_user
|
|
@@ -4236,12 +4251,12 @@ module Aws::OpsWorks
|
|
|
4236
4251
|
# @return [String]
|
|
4237
4252
|
#
|
|
4238
4253
|
# @!attribute [rw] db_password
|
|
4239
|
-
#
|
|
4240
|
-
#
|
|
4254
|
+
# OpsWorks Stacks returns `*****FILTERED*****` instead of the actual
|
|
4255
|
+
# value.
|
|
4241
4256
|
# @return [String]
|
|
4242
4257
|
#
|
|
4243
4258
|
# @!attribute [rw] region
|
|
4244
|
-
# The instance's
|
|
4259
|
+
# The instance's Amazon Web Services Region.
|
|
4245
4260
|
# @return [String]
|
|
4246
4261
|
#
|
|
4247
4262
|
# @!attribute [rw] address
|
|
@@ -4257,10 +4272,10 @@ module Aws::OpsWorks
|
|
|
4257
4272
|
# @return [String]
|
|
4258
4273
|
#
|
|
4259
4274
|
# @!attribute [rw] missing_on_rds
|
|
4260
|
-
# Set to `true` if
|
|
4261
|
-
#
|
|
4262
|
-
#
|
|
4263
|
-
#
|
|
4275
|
+
# Set to `true` if OpsWorks Stacks is unable to discover the Amazon
|
|
4276
|
+
# RDS instance. OpsWorks Stacks attempts to discover the instance only
|
|
4277
|
+
# once. If this value is set to `true`, you must deregister the
|
|
4278
|
+
# instance, and then register it again.
|
|
4264
4279
|
# @return [Boolean]
|
|
4265
4280
|
#
|
|
4266
4281
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/RdsDbInstance AWS API Documentation
|
|
@@ -4291,14 +4306,14 @@ module Aws::OpsWorks
|
|
|
4291
4306
|
include Aws::Structure
|
|
4292
4307
|
end
|
|
4293
4308
|
|
|
4294
|
-
#
|
|
4309
|
+
# OpsWorks Stacks supports five lifecycle events: **setup**,
|
|
4295
4310
|
# **configuration**, **deploy**, **undeploy**, and **shutdown**. For
|
|
4296
|
-
# each layer,
|
|
4297
|
-
#
|
|
4298
|
-
# layers and events.
|
|
4299
|
-
#
|
|
4300
|
-
#
|
|
4301
|
-
#
|
|
4311
|
+
# each layer, OpsWorks Stacks runs a set of standard recipes for each
|
|
4312
|
+
# event. In addition, you can provide custom recipes for any or all
|
|
4313
|
+
# layers and events. OpsWorks Stacks runs custom event recipes after the
|
|
4314
|
+
# standard recipes. `LayerCustomRecipes` specifies the custom recipes
|
|
4315
|
+
# for a particular layer to be run in response to each of the five
|
|
4316
|
+
# events.
|
|
4302
4317
|
#
|
|
4303
4318
|
# To specify a recipe, use the cookbook's directory name in the
|
|
4304
4319
|
# repository followed by two colons and the recipe name, which is the
|
|
@@ -4409,7 +4424,12 @@ module Aws::OpsWorks
|
|
|
4409
4424
|
# @return [String]
|
|
4410
4425
|
#
|
|
4411
4426
|
# @!attribute [rw] hostname
|
|
4412
|
-
# The instance's
|
|
4427
|
+
# The instance's host name. The following are character limits for
|
|
4428
|
+
# instance host names.
|
|
4429
|
+
#
|
|
4430
|
+
# * Linux-based instances: 63 characters
|
|
4431
|
+
#
|
|
4432
|
+
# * Windows-based instances: 15 characters
|
|
4413
4433
|
# @return [String]
|
|
4414
4434
|
#
|
|
4415
4435
|
# @!attribute [rw] public_ip
|
|
@@ -4450,7 +4470,7 @@ module Aws::OpsWorks
|
|
|
4450
4470
|
# Contains the response to a `RegisterInstanceResult` request.
|
|
4451
4471
|
#
|
|
4452
4472
|
# @!attribute [rw] instance_id
|
|
4453
|
-
# The registered instance's
|
|
4473
|
+
# The registered instance's OpsWorks Stacks ID.
|
|
4454
4474
|
# @return [String]
|
|
4455
4475
|
#
|
|
4456
4476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/RegisterInstanceResult AWS API Documentation
|
|
@@ -4586,7 +4606,7 @@ module Aws::OpsWorks
|
|
|
4586
4606
|
include Aws::Structure
|
|
4587
4607
|
end
|
|
4588
4608
|
|
|
4589
|
-
# Describes an
|
|
4609
|
+
# Describes an OpsWorks Stacks service error.
|
|
4590
4610
|
#
|
|
4591
4611
|
# @!attribute [rw] service_error_id
|
|
4592
4612
|
# The error ID.
|
|
@@ -4636,15 +4656,15 @@ module Aws::OpsWorks
|
|
|
4636
4656
|
# @!attribute [rw] up_scaling
|
|
4637
4657
|
# An `AutoScalingThresholds` object with the upscaling threshold
|
|
4638
4658
|
# configuration. If the load exceeds these thresholds for a specified
|
|
4639
|
-
# amount of time,
|
|
4659
|
+
# amount of time, OpsWorks Stacks starts a specified number of
|
|
4640
4660
|
# instances.
|
|
4641
4661
|
# @return [Types::AutoScalingThresholds]
|
|
4642
4662
|
#
|
|
4643
4663
|
# @!attribute [rw] down_scaling
|
|
4644
4664
|
# An `AutoScalingThresholds` object with the downscaling threshold
|
|
4645
4665
|
# configuration. If the load falls below these thresholds for a
|
|
4646
|
-
# specified amount of time,
|
|
4647
|
-
#
|
|
4666
|
+
# specified amount of time, OpsWorks Stacks stops a specified number
|
|
4667
|
+
# of instances.
|
|
4648
4668
|
# @return [Types::AutoScalingThresholds]
|
|
4649
4669
|
#
|
|
4650
4670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/SetLoadBasedAutoScalingRequest AWS API Documentation
|
|
@@ -4728,8 +4748,8 @@ module Aws::OpsWorks
|
|
|
4728
4748
|
# The Shutdown event configuration.
|
|
4729
4749
|
#
|
|
4730
4750
|
# @!attribute [rw] execution_timeout
|
|
4731
|
-
# The time, in seconds, that
|
|
4732
|
-
#
|
|
4751
|
+
# The time, in seconds, that OpsWorks Stacks waits after triggering a
|
|
4752
|
+
# Shutdown event before shutting down an instance.
|
|
4733
4753
|
# @return [Integer]
|
|
4734
4754
|
#
|
|
4735
4755
|
# @!attribute [rw] delay_until_elb_connections_drained
|
|
@@ -4792,8 +4812,8 @@ module Aws::OpsWorks
|
|
|
4792
4812
|
# For more information on how to safely handle IAM credentials, see
|
|
4793
4813
|
# [https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html][1].
|
|
4794
4814
|
#
|
|
4795
|
-
# In responses,
|
|
4796
|
-
#
|
|
4815
|
+
# In responses, OpsWorks Stacks returns `*****FILTERED*****` instead
|
|
4816
|
+
# of the actual value.
|
|
4797
4817
|
#
|
|
4798
4818
|
#
|
|
4799
4819
|
#
|
|
@@ -4803,13 +4823,13 @@ module Aws::OpsWorks
|
|
|
4803
4823
|
# @!attribute [rw] ssh_key
|
|
4804
4824
|
# In requests, the repository's SSH key.
|
|
4805
4825
|
#
|
|
4806
|
-
# In responses,
|
|
4807
|
-
#
|
|
4826
|
+
# In responses, OpsWorks Stacks returns `*****FILTERED*****` instead
|
|
4827
|
+
# of the actual value.
|
|
4808
4828
|
# @return [String]
|
|
4809
4829
|
#
|
|
4810
4830
|
# @!attribute [rw] revision
|
|
4811
|
-
# The application's version.
|
|
4812
|
-
#
|
|
4831
|
+
# The application's version. OpsWorks Stacks enables you to easily
|
|
4832
|
+
# deploy new versions of an application. One of the simplest
|
|
4813
4833
|
# approaches is to have branches or revisions in your repository that
|
|
4814
4834
|
# represent different versions that can potentially be deployed.
|
|
4815
4835
|
# @return [String]
|
|
@@ -4859,7 +4879,7 @@ module Aws::OpsWorks
|
|
|
4859
4879
|
# @return [String]
|
|
4860
4880
|
#
|
|
4861
4881
|
# @!attribute [rw] name
|
|
4862
|
-
# The stack name.
|
|
4882
|
+
# The stack name. Stack names can be a maximum of 64 characters.
|
|
4863
4883
|
# @return [String]
|
|
4864
4884
|
#
|
|
4865
4885
|
# @!attribute [rw] arn
|
|
@@ -4867,8 +4887,9 @@ module Aws::OpsWorks
|
|
|
4867
4887
|
# @return [String]
|
|
4868
4888
|
#
|
|
4869
4889
|
# @!attribute [rw] region
|
|
4870
|
-
# The stack
|
|
4871
|
-
# information about
|
|
4890
|
+
# The stack Amazon Web Services Region, such as `ap-northeast-2`. For
|
|
4891
|
+
# more information about Amazon Web Services Regions, see [Regions and
|
|
4892
|
+
# Endpoints][1].
|
|
4872
4893
|
#
|
|
4873
4894
|
#
|
|
4874
4895
|
#
|
|
@@ -4884,7 +4905,7 @@ module Aws::OpsWorks
|
|
|
4884
4905
|
# @return [Hash<String,String>]
|
|
4885
4906
|
#
|
|
4886
4907
|
# @!attribute [rw] service_role_arn
|
|
4887
|
-
# The stack
|
|
4908
|
+
# The stack Identity and Access Management (IAM) role.
|
|
4888
4909
|
# @return [String]
|
|
4889
4910
|
#
|
|
4890
4911
|
# @!attribute [rw] default_instance_profile_arn
|
|
@@ -4955,7 +4976,7 @@ module Aws::OpsWorks
|
|
|
4955
4976
|
# @return [Boolean]
|
|
4956
4977
|
#
|
|
4957
4978
|
# @!attribute [rw] use_opsworks_security_groups
|
|
4958
|
-
# Whether the stack automatically associates the
|
|
4979
|
+
# Whether the stack automatically associates the OpsWorks Stacks
|
|
4959
4980
|
# built-in security groups with the stack's layers.
|
|
4960
4981
|
# @return [Boolean]
|
|
4961
4982
|
#
|
|
@@ -5027,13 +5048,13 @@ module Aws::OpsWorks
|
|
|
5027
5048
|
# Describes the configuration manager.
|
|
5028
5049
|
#
|
|
5029
5050
|
# @!attribute [rw] name
|
|
5030
|
-
# The name. This parameter must be set to
|
|
5051
|
+
# The name. This parameter must be set to `Chef`.
|
|
5031
5052
|
# @return [String]
|
|
5032
5053
|
#
|
|
5033
5054
|
# @!attribute [rw] version
|
|
5034
5055
|
# The Chef version. This parameter must be set to 12, 11.10, or 11.4
|
|
5035
5056
|
# for Linux stacks, and to 12.2 for Windows stacks. The default value
|
|
5036
|
-
# for Linux stacks is
|
|
5057
|
+
# for Linux stacks is 12.
|
|
5037
5058
|
# @return [String]
|
|
5038
5059
|
#
|
|
5039
5060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/StackConfigurationManager AWS API Documentation
|
|
@@ -5116,11 +5137,11 @@ module Aws::OpsWorks
|
|
|
5116
5137
|
# @!attribute [rw] force
|
|
5117
5138
|
# Specifies whether to force an instance to stop. If the instance's
|
|
5118
5139
|
# root device type is `ebs`, or EBS-backed, adding the `Force`
|
|
5119
|
-
# parameter to the `StopInstances` API call disassociates the
|
|
5120
|
-
#
|
|
5121
|
-
#
|
|
5122
|
-
#
|
|
5123
|
-
#
|
|
5140
|
+
# parameter to the `StopInstances` API call disassociates the OpsWorks
|
|
5141
|
+
# Stacks instance from EC2, and forces deletion of *only* the OpsWorks
|
|
5142
|
+
# Stacks instance. You must also delete the formerly-associated
|
|
5143
|
+
# instance in EC2 after troubleshooting and replacing the OpsWorks
|
|
5144
|
+
# Stacks instance with a new one.
|
|
5124
5145
|
# @return [Boolean]
|
|
5125
5146
|
#
|
|
5126
5147
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/StopInstanceRequest AWS API Documentation
|
|
@@ -5192,11 +5213,11 @@ module Aws::OpsWorks
|
|
|
5192
5213
|
# The length of time (in minutes) that the grant is valid. When the
|
|
5193
5214
|
# grant expires, at the end of this period, the user will no longer be
|
|
5194
5215
|
# able to use the credentials to log in. If they are logged in at the
|
|
5195
|
-
# time, they
|
|
5216
|
+
# time, they are automatically logged out.
|
|
5196
5217
|
# @return [Integer]
|
|
5197
5218
|
#
|
|
5198
5219
|
# @!attribute [rw] instance_id
|
|
5199
|
-
# The instance's
|
|
5220
|
+
# The instance's OpsWorks Stacks ID.
|
|
5200
5221
|
# @return [String]
|
|
5201
5222
|
#
|
|
5202
5223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/TemporaryCredential AWS API Documentation
|
|
@@ -5358,7 +5379,7 @@ module Aws::OpsWorks
|
|
|
5358
5379
|
# @return [String]
|
|
5359
5380
|
#
|
|
5360
5381
|
# @!attribute [rw] name
|
|
5361
|
-
# The new name.
|
|
5382
|
+
# The new name, which can be a maximum of 32 characters.
|
|
5362
5383
|
# @return [String]
|
|
5363
5384
|
#
|
|
5364
5385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/UpdateElasticIpRequest AWS API Documentation
|
|
@@ -5398,7 +5419,12 @@ module Aws::OpsWorks
|
|
|
5398
5419
|
# @return [String]
|
|
5399
5420
|
#
|
|
5400
5421
|
# @!attribute [rw] hostname
|
|
5401
|
-
# The instance host name.
|
|
5422
|
+
# The instance host name. The following are character limits for
|
|
5423
|
+
# instance host names.
|
|
5424
|
+
#
|
|
5425
|
+
# * Linux-based instances: 63 characters
|
|
5426
|
+
#
|
|
5427
|
+
# * Windows-based instances: 15 characters
|
|
5402
5428
|
# @return [String]
|
|
5403
5429
|
#
|
|
5404
5430
|
# @!attribute [rw] os
|
|
@@ -5406,12 +5432,12 @@ module Aws::OpsWorks
|
|
|
5406
5432
|
# following. You cannot update an instance that is using a custom AMI.
|
|
5407
5433
|
#
|
|
5408
5434
|
# * A supported Linux operating system: An Amazon Linux version, such
|
|
5409
|
-
# as `Amazon Linux
|
|
5410
|
-
# 2017.
|
|
5411
|
-
# Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
5435
|
+
# as `Amazon Linux 2`, `Amazon Linux 2018.03`, `Amazon Linux
|
|
5436
|
+
# 2017.09`, `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, `Amazon
|
|
5437
|
+
# Linux 2016.03`, `Amazon Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
5412
5438
|
#
|
|
5413
|
-
# * A supported Ubuntu operating system, such as `Ubuntu
|
|
5414
|
-
# `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
5439
|
+
# * A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS`,
|
|
5440
|
+
# `Ubuntu 16.04 LTS`, `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
5415
5441
|
#
|
|
5416
5442
|
# * `CentOS Linux 7`
|
|
5417
5443
|
#
|
|
@@ -5423,15 +5449,15 @@ module Aws::OpsWorks
|
|
|
5423
5449
|
# Standard`, or `Microsoft Windows Server 2012 R2 with SQL Server
|
|
5424
5450
|
# Web`.
|
|
5425
5451
|
#
|
|
5426
|
-
#
|
|
5427
|
-
#
|
|
5452
|
+
# Not all operating systems are supported with all versions of Chef.
|
|
5453
|
+
# For more information about supported operating systems, see
|
|
5454
|
+
# [OpsWorks Stacks Operating Systems][1].
|
|
5428
5455
|
#
|
|
5429
5456
|
# The default option is the current Amazon Linux version. If you set
|
|
5430
5457
|
# this parameter to `Custom`, you must use the AmiId parameter to
|
|
5431
5458
|
# specify the custom AMI that you want to use. For more information
|
|
5432
|
-
# about
|
|
5433
|
-
#
|
|
5434
|
-
# [Using Custom AMIs][2].
|
|
5459
|
+
# about how to use custom AMIs with OpsWorks, see [Using Custom
|
|
5460
|
+
# AMIs][2].
|
|
5435
5461
|
#
|
|
5436
5462
|
# <note markdown="1"> You can specify a different Linux operating system for the updated
|
|
5437
5463
|
# stack, but you cannot change from Linux to Windows or Windows to
|
|
@@ -5487,16 +5513,16 @@ module Aws::OpsWorks
|
|
|
5487
5513
|
# @return [Boolean]
|
|
5488
5514
|
#
|
|
5489
5515
|
# @!attribute [rw] agent_version
|
|
5490
|
-
# The default
|
|
5491
|
-
#
|
|
5516
|
+
# The default OpsWorks Stacks agent version. You have the following
|
|
5517
|
+
# options:
|
|
5492
5518
|
#
|
|
5493
5519
|
# * `INHERIT` - Use the stack's default agent version setting.
|
|
5494
5520
|
#
|
|
5495
5521
|
# * *version\_number* - Use the specified agent version. This value
|
|
5496
5522
|
# overrides the stack's default setting. To update the agent
|
|
5497
5523
|
# version, you must edit the instance configuration and specify a
|
|
5498
|
-
# new version.
|
|
5499
|
-
#
|
|
5524
|
+
# new version. OpsWorks Stacks installs that version on the
|
|
5525
|
+
# instance.
|
|
5500
5526
|
#
|
|
5501
5527
|
# The default setting is `INHERIT`. To specify an agent version, you
|
|
5502
5528
|
# must use the complete version number, not the abbreviated number
|
|
@@ -5530,19 +5556,20 @@ module Aws::OpsWorks
|
|
|
5530
5556
|
# @return [String]
|
|
5531
5557
|
#
|
|
5532
5558
|
# @!attribute [rw] name
|
|
5533
|
-
# The layer name, which is used by the console.
|
|
5559
|
+
# The layer name, which is used by the console. Layer names can be a
|
|
5560
|
+
# maximum of 32 characters.
|
|
5534
5561
|
# @return [String]
|
|
5535
5562
|
#
|
|
5536
5563
|
# @!attribute [rw] shortname
|
|
5537
5564
|
# For custom layers only, use this parameter to specify the layer's
|
|
5538
|
-
# short name, which is used internally by
|
|
5539
|
-
#
|
|
5540
|
-
#
|
|
5541
|
-
#
|
|
5542
|
-
# /\\A\[a-z0-9\\-\\\_\\.\]+\\Z/.
|
|
5565
|
+
# short name, which is used internally by OpsWorks Stacks and by Chef.
|
|
5566
|
+
# The short name is also used as the name for the directory where your
|
|
5567
|
+
# app files are installed. It can have a maximum of 32 characters and
|
|
5568
|
+
# must be in the following format: /\\A\[a-z0-9\\-\\\_\\.\]+\\Z/.
|
|
5543
5569
|
#
|
|
5544
|
-
#
|
|
5545
|
-
#
|
|
5570
|
+
# Built-in layer short names are defined by OpsWorks Stacks. For more
|
|
5571
|
+
# information, see the [Layer reference][1] in the OpsWorks User
|
|
5572
|
+
# Guide.
|
|
5546
5573
|
#
|
|
5547
5574
|
#
|
|
5548
5575
|
#
|
|
@@ -5706,7 +5733,8 @@ module Aws::OpsWorks
|
|
|
5706
5733
|
# @return [String]
|
|
5707
5734
|
#
|
|
5708
5735
|
# @!attribute [rw] name
|
|
5709
|
-
# The stack's new name.
|
|
5736
|
+
# The stack's new name. Stack names can be a maximum of 64
|
|
5737
|
+
# characters.
|
|
5710
5738
|
# @return [String]
|
|
5711
5739
|
#
|
|
5712
5740
|
# @!attribute [rw] attributes
|
|
@@ -5734,12 +5762,12 @@ module Aws::OpsWorks
|
|
|
5734
5762
|
# following:
|
|
5735
5763
|
#
|
|
5736
5764
|
# * A supported Linux operating system: An Amazon Linux version, such
|
|
5737
|
-
# as `Amazon Linux
|
|
5738
|
-
# 2017.
|
|
5739
|
-
# Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
5765
|
+
# as `Amazon Linux 2`, `Amazon Linux 2018.03`, `Amazon Linux
|
|
5766
|
+
# 2017.09`, `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, `Amazon
|
|
5767
|
+
# Linux 2016.03`, `Amazon Linux 2015.09`, or `Amazon Linux 2015.03`.
|
|
5740
5768
|
#
|
|
5741
|
-
# * A supported Ubuntu operating system, such as `Ubuntu
|
|
5742
|
-
# `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
5769
|
+
# * A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS`,
|
|
5770
|
+
# `Ubuntu 16.04 LTS`, `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
|
|
5743
5771
|
#
|
|
5744
5772
|
# * `CentOS Linux 7`
|
|
5745
5773
|
#
|
|
@@ -5755,9 +5783,10 @@ module Aws::OpsWorks
|
|
|
5755
5783
|
# when you create instances. For more information about how to use
|
|
5756
5784
|
# custom AMIs with OpsWorks, see [Using Custom AMIs][1].
|
|
5757
5785
|
#
|
|
5758
|
-
# The default option is the stack's current operating system.
|
|
5759
|
-
#
|
|
5760
|
-
#
|
|
5786
|
+
# The default option is the stack's current operating system. Not all
|
|
5787
|
+
# operating systems are supported with all versions of Chef. For more
|
|
5788
|
+
# information about supported operating systems, see [OpsWorks Stacks
|
|
5789
|
+
# Operating Systems][2].
|
|
5761
5790
|
#
|
|
5762
5791
|
#
|
|
5763
5792
|
#
|
|
@@ -5870,12 +5899,12 @@ module Aws::OpsWorks
|
|
|
5870
5899
|
#
|
|
5871
5900
|
# @!attribute [rw] default_ssh_key_name
|
|
5872
5901
|
# A default Amazon EC2 key-pair name. The default value is `none`. If
|
|
5873
|
-
# you specify a key-pair name,
|
|
5874
|
-
#
|
|
5875
|
-
#
|
|
5876
|
-
#
|
|
5877
|
-
#
|
|
5878
|
-
# key pair,
|
|
5902
|
+
# you specify a key-pair name, OpsWorks Stacks installs the public key
|
|
5903
|
+
# on the instance and you can use the private key with an SSH client
|
|
5904
|
+
# to log in to the instance. For more information, see [ Using SSH to
|
|
5905
|
+
# Communicate with an Instance][1] and [ Managing SSH Access][2]. You
|
|
5906
|
+
# can override this setting by specifying a different key pair, or no
|
|
5907
|
+
# key pair, when you [ create an instance][3].
|
|
5879
5908
|
#
|
|
5880
5909
|
#
|
|
5881
5910
|
#
|
|
@@ -5896,22 +5925,21 @@ module Aws::OpsWorks
|
|
|
5896
5925
|
# @return [String]
|
|
5897
5926
|
#
|
|
5898
5927
|
# @!attribute [rw] use_opsworks_security_groups
|
|
5899
|
-
# Whether to associate the
|
|
5900
|
-
#
|
|
5928
|
+
# Whether to associate the OpsWorks Stacks built-in security groups
|
|
5929
|
+
# with the stack's layers.
|
|
5901
5930
|
#
|
|
5902
|
-
#
|
|
5903
|
-
#
|
|
5904
|
-
#
|
|
5905
|
-
#
|
|
5931
|
+
# OpsWorks Stacks provides a standard set of built-in security groups,
|
|
5932
|
+
# one for each layer, which are associated with layers by default.
|
|
5933
|
+
# `UseOpsworksSecurityGroups` allows you to provide your own custom
|
|
5934
|
+
# security groups instead of using the built-in groups.
|
|
5906
5935
|
# `UseOpsworksSecurityGroups` has the following settings:
|
|
5907
5936
|
#
|
|
5908
|
-
# * True -
|
|
5909
|
-
#
|
|
5910
|
-
#
|
|
5911
|
-
#
|
|
5912
|
-
# security group.
|
|
5937
|
+
# * True - OpsWorks Stacks automatically associates the appropriate
|
|
5938
|
+
# built-in security group with each layer (default setting). You can
|
|
5939
|
+
# associate additional security groups with a layer after you create
|
|
5940
|
+
# it, but you cannot delete the built-in security group.
|
|
5913
5941
|
#
|
|
5914
|
-
# * False -
|
|
5942
|
+
# * False - OpsWorks Stacks does not associate built-in security
|
|
5915
5943
|
# groups with layers. You must create appropriate EC2 security
|
|
5916
5944
|
# groups and associate a security group with each layer that you
|
|
5917
5945
|
# create. However, you can still manually associate a built-in
|
|
@@ -5926,17 +5954,17 @@ module Aws::OpsWorks
|
|
|
5926
5954
|
# @return [Boolean]
|
|
5927
5955
|
#
|
|
5928
5956
|
# @!attribute [rw] agent_version
|
|
5929
|
-
# The default
|
|
5930
|
-
#
|
|
5957
|
+
# The default OpsWorks Stacks agent version. You have the following
|
|
5958
|
+
# options:
|
|
5931
5959
|
#
|
|
5932
|
-
# * Auto-update - Set this parameter to `LATEST`.
|
|
5960
|
+
# * Auto-update - Set this parameter to `LATEST`. OpsWorks Stacks
|
|
5933
5961
|
# automatically installs new agent versions on the stack's
|
|
5934
5962
|
# instances as soon as they are available.
|
|
5935
5963
|
#
|
|
5936
5964
|
# * Fixed version - Set this parameter to your preferred agent
|
|
5937
5965
|
# version. To update the agent version, you must edit the stack
|
|
5938
|
-
# configuration and specify a new version.
|
|
5939
|
-
#
|
|
5966
|
+
# configuration and specify a new version. OpsWorks Stacks installs
|
|
5967
|
+
# that version on the stack's instances.
|
|
5940
5968
|
#
|
|
5941
5969
|
# The default setting is `LATEST`. To specify an agent version, you
|
|
5942
5970
|
# must use the complete version number, not the abbreviated number
|
|
@@ -5981,10 +6009,9 @@ module Aws::OpsWorks
|
|
|
5981
6009
|
# @!attribute [rw] ssh_username
|
|
5982
6010
|
# The user's SSH user name. The allowable characters are \[a-z\],
|
|
5983
6011
|
# \[A-Z\], \[0-9\], '-', and '\_'. If the specified name includes
|
|
5984
|
-
# other punctuation marks,
|
|
5985
|
-
#
|
|
5986
|
-
#
|
|
5987
|
-
# IAM user name.
|
|
6012
|
+
# other punctuation marks, OpsWorks Stacks removes them. For example,
|
|
6013
|
+
# `my.name` will be changed to `myname`. If you do not specify an SSH
|
|
6014
|
+
# user name, OpsWorks Stacks generates one from the IAM user name.
|
|
5988
6015
|
# @return [String]
|
|
5989
6016
|
#
|
|
5990
6017
|
# @!attribute [rw] ssh_public_key
|
|
@@ -6017,7 +6044,7 @@ module Aws::OpsWorks
|
|
|
6017
6044
|
# @return [String]
|
|
6018
6045
|
#
|
|
6019
6046
|
# @!attribute [rw] name
|
|
6020
|
-
# The new name.
|
|
6047
|
+
# The new name. Volume names can be a maximum of 128 characters.
|
|
6021
6048
|
# @return [String]
|
|
6022
6049
|
#
|
|
6023
6050
|
# @!attribute [rw] mount_point
|
|
@@ -6099,7 +6126,7 @@ module Aws::OpsWorks
|
|
|
6099
6126
|
# @return [String]
|
|
6100
6127
|
#
|
|
6101
6128
|
# @!attribute [rw] name
|
|
6102
|
-
# The volume name.
|
|
6129
|
+
# The volume name. Volume names are a maximum of 128 characters.
|
|
6103
6130
|
# @return [String]
|
|
6104
6131
|
#
|
|
6105
6132
|
# @!attribute [rw] raid_array_id
|
|
@@ -6131,8 +6158,8 @@ module Aws::OpsWorks
|
|
|
6131
6158
|
# @return [String]
|
|
6132
6159
|
#
|
|
6133
6160
|
# @!attribute [rw] region
|
|
6134
|
-
# The
|
|
6135
|
-
# and Endpoints][1].
|
|
6161
|
+
# The Amazon Web Services Region. For more information about Amazon
|
|
6162
|
+
# Web Services Regions, see [Regions and Endpoints][1].
|
|
6136
6163
|
#
|
|
6137
6164
|
#
|
|
6138
6165
|
#
|
|
@@ -6162,10 +6189,10 @@ module Aws::OpsWorks
|
|
|
6162
6189
|
# minimum size of 1 GiB and a maximum size of 16384 GiB.
|
|
6163
6190
|
#
|
|
6164
6191
|
# * `st1` - Throughput Optimized hard disk drive (HDD). Throughput
|
|
6165
|
-
# optimized HDD volumes must have a minimum size of
|
|
6192
|
+
# optimized HDD volumes must have a minimum size of 125 GiB and a
|
|
6166
6193
|
# maximum size of 16384 GiB.
|
|
6167
6194
|
#
|
|
6168
|
-
# * `sc1` - Cold HDD. Cold HDD volumes must have a minimum size of
|
|
6195
|
+
# * `sc1` - Cold HDD. Cold HDD volumes must have a minimum size of 125
|
|
6169
6196
|
# GiB and a maximum size of 16384 GiB.
|
|
6170
6197
|
#
|
|
6171
6198
|
#
|
|
@@ -6243,10 +6270,10 @@ module Aws::OpsWorks
|
|
|
6243
6270
|
# minimum size of 1 GiB and a maximum size of 16384 GiB.
|
|
6244
6271
|
#
|
|
6245
6272
|
# * `st1` - Throughput Optimized hard disk drive (HDD). Throughput
|
|
6246
|
-
# optimized HDD volumes must have a minimum size of
|
|
6273
|
+
# optimized HDD volumes must have a minimum size of 125 GiB and a
|
|
6247
6274
|
# maximum size of 16384 GiB.
|
|
6248
6275
|
#
|
|
6249
|
-
# * `sc1` - Cold HDD. Cold HDD volumes must have a minimum size of
|
|
6276
|
+
# * `sc1` - Cold HDD. Cold HDD volumes must have a minimum size of 125
|
|
6250
6277
|
# GiB and a maximum size of 16384 GiB.
|
|
6251
6278
|
#
|
|
6252
6279
|
#
|