String version
The agent version.
StackConfigurationManager configurationManager
The configuration manager.
String appId
The app ID.
String stackId
The app stack ID.
String shortname
The app's short name.
String name
The app name.
String description
A description of the app.
SdkInternalList<T> dataSources
The app's data sources.
String type
The app type.
Source appSource
A Source object that describes the app repository.
SdkInternalList<T> domains
The app vhost settings with multiple domains separated by commas. For example:
'www.example.com, example.com'
Boolean enableSsl
Whether to enable SSL for the app.
SslConfiguration sslConfiguration
An SslConfiguration object with the SSL configuration.
SdkInternalMap<K,V> attributes
The stack attributes.
String createdAt
When the app was created.
SdkInternalList<T> environment
An array of EnvironmentVariable objects that specify environment variables to be associated with the
app. After you deploy the app, these variables are defined on the associated app server instances. For more
information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.
String instanceId
The instance ID.
SdkInternalList<T> layerIds
The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.
Integer instanceCount
The number of instances to add or remove when the load exceeds a threshold.
Integer thresholdsWaitTime
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
Integer ignoreMetricsTime
The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and
suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling
event but the instances won't start reducing the load until they have been booted and configured. There is no
point in raising additional scaling events during that operation, which typically takes several minutes.
IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to
get the new instances online.
Double cpuThreshold
The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
Double memoryThreshold
The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
Double loadThreshold
The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
SdkInternalList<T> alarms
Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.
To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can
either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role
manually. For more information, see Allowing AWS
OpsWorks Stacks to Act on Your Behalf.
String deviceName
The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use
the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will
provide the correct device name.
String noDevice
Suppresses the specified device included in the AMI's block device mapping.
String virtualName
The virtual device name. For more information, see BlockDeviceMapping.
EbsBlockDevice ebs
An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
String sourceStackId
The source stack ID.
String name
The cloned stack name.
String region
The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
String vpcId
The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.
If your account supports EC2 Classic, the default value is no VPC.
If your account does not support EC2 Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone
or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter.
If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId.
For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.
SdkInternalMap<K,V> attributes
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
String serviceRoleArn
The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
String defaultInstanceProfileArn
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
Microsoft Windows Server 2012 R2 Base,
Microsoft Windows Server 2012 R2 with SQL Server Express,
Microsoft Windows Server 2012 R2 with SQL Server Standard, or
Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more
information about how to use custom AMIs with OpsWorks, see Using Custom
AMIs.
The default option is the parent stack's operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.
String hostnameTheme
The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names
for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the
current theme.
String defaultAvailabilityZone
The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a
value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the
VpcId parameter description.
String defaultSubnetId
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId
parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance.
If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For
information on default values and when this parameter is required, see the VpcId parameter
description.
String customJson
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
StackConfigurationManager configurationManager
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on
Chef 11.10 stacks. For more information, see Create a New Stack.
Boolean useCustomCookbooks
Whether to use custom cookbooks.
Boolean useOpsworksSecurityGroups
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated
with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom
security groups. UseOpsworksSecurityGroups has the following settings:
True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.
False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
Source customCookbooksSource
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
String defaultSshKeyName
A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
Boolean clonePermissions
Whether to clone the source stack's permissions.
SdkInternalList<T> cloneAppIds
A list of source stack app IDs to be included in the cloned stack.
String defaultRootDeviceType
The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
String agentVersion
The default AWS OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent
versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is LATEST. To specify an agent version, you must use the complete version
number, not the abbreviated number shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
String stackId
The cloned stack ID.
Boolean enabled
Whether CloudWatch Logs is enabled for a layer.
SdkInternalList<T> logStreams
A list of configuration options for CloudWatch Logs.
String logGroupName
Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
String datetimeFormat
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
String timeZone
Specifies the time zone of log event time stamps.
String file
Specifies log files that you want to push to CloudWatch Logs.
File can point to a specific file or multiple files (by using wild card characters such as
/var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification
time. We recommend that you use wild card characters to specify a series of files of the same type, such as
access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like
access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80
and access_log_443. To specify multiple, different file types, add another log stream entry to the
configuration file, so that each log file type is stored in a different log group.
Zipped files are not supported.
String fileFingerprintLines
Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.
String multiLineStartPattern
Specifies the pattern for identifying the start of a log message.
String initialPosition
Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.
String encoding
Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8.
Encodings supported by Python codecs.decode() can be used here.
Integer bufferDuration
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
Integer batchCount
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
Integer batchSize
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
String commandId
The command ID.
String instanceId
The ID of the instance where the command was executed.
String deploymentId
The command deployment ID.
String createdAt
Date and time when the command was run.
String acknowledgedAt
Date and time when the command was acknowledged.
String completedAt
Date when the command completed.
String status
The command status:
failed
successful
skipped
pending
Integer exitCode
The command exit code.
String logUrl
The URL of the command log.
String type
The command type:
configure
deploy
execute_recipes
install_dependencies
restart
rollback
setup
start
stop
undeploy
update_custom_cookbooks
update_dependencies
String stackId
The stack ID.
String shortname
The app's short name.
String name
The app name.
String description
A description of the app.
SdkInternalList<T> dataSources
The app's data source.
String type
The app type. Each supported type is associated with a particular layer. For example, PHP applications are
associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of
the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy
recipes, specify other.
Source appSource
A Source object that specifies the app repository.
SdkInternalList<T> domains
The app virtual host settings, with multiple domains separated by commas. For example:
'www.example.com, example.com'
Boolean enableSsl
Whether to enable SSL for the app.
SslConfiguration sslConfiguration
An SslConfiguration object with the SSL configuration.
SdkInternalMap<K,V> attributes
One or more user-defined key/value pairs to be added to the stack attributes.
SdkInternalList<T> environment
An array of EnvironmentVariable objects that specify environment variables to be associated with the
app. After you deploy the app, these variables are defined on the associated app server instance. For more
information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."
If you have specified one or more environment variables, you cannot modify the stack's Chef version.
String appId
The app ID.
String stackId
The stack ID.
String appId
The app ID. This parameter is required for app deployments, but not for other deployment commands.
SdkInternalList<T> instanceIds
The instance IDs for the deployment targets.
SdkInternalList<T> layerIds
The layer IDs for the deployment targets.
DeploymentCommand command
A DeploymentCommand object that specifies the deployment command and any associated arguments.
String comment
A user-defined comment.
String customJson
A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.
String deploymentId
The deployment ID, which can be used with other requests to identify the deployment.
String stackId
The stack ID.
SdkInternalList<T> layerIds
An array that contains the instance's layer IDs.
String instanceType
The instance type, such as t2.micro. For a list of supported instance types, open the stack in the
console, choose Instances, and choose + Instance. The Size list contains the currently
supported types. For more information, see Instance Families and Types.
The parameter values that you use to specify the various types are in the API Name column of the
Available Instance Types table.
String autoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
String hostname
The instance host name.
String os
The instance's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
Microsoft Windows Server 2012 R2 with SQL Server Express,
Microsoft Windows Server 2012 R2 with SQL Server Standard, or
Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom.
For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom, you
must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block
device mappings are not supported if the value is Custom. For more information about supported
operating systems, see Operating SystemsFor
more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom
AMIs.
String amiId
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
If you specify a custom AMI, you must set Os to Custom.
String sshKeyName
The instance's Amazon EC2 key-pair name.
String availabilityZone
The instance Availability Zone. For more information, see Regions and Endpoints.
String virtualizationType
The instance's virtualization type, paravirtual or hvm.
String subnetId
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.
String architecture
The instance architecture. The default option is x86_64. Instance types do not necessarily support
both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
String rootDeviceType
The instance root device type. For more information, see Storage for the Root Device.
SdkInternalList<T> blockDeviceMappings
An array of BlockDeviceMapping objects that specify the instance's block devices. For more
information, see Block Device
Mapping. Note that block device mappings are not supported for custom AMIs.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true. To control when updates are installed, set this value to false. You must then
update your instances manually by using CreateDeployment to run the update_dependencies stack
command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true to ensure that your instances have the latest
security updates.
Boolean ebsOptimized
Whether to create an Amazon EBS-optimized instance.
String agentVersion
The default AWS OpsWorks Stacks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.
The default setting is INHERIT. To specify an agent version, you must use the complete version
number, not the abbreviated number shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
String tenancy
The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit
tenancy settings from the VPC. The following are valid values for this parameter: dedicated,
default, or host. Because there are costs associated with changes in tenancy options,
we recommend that you research tenancy options before choosing them for your instances. For more information
about dedicated hosts, see Dedicated Hosts Overview and
Amazon EC2 Dedicated Hosts. For more information about
dedicated instances, see Dedicated Instances and
Amazon EC2 Dedicated Instances.
String instanceId
The instance ID.
String stackId
The layer stack ID.
String type
The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
String name
The layer name, which is used by the console.
String shortname
For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.
SdkInternalMap<K,V> attributes
One or more user-defined key-value pairs to be added to the stack attributes.
To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
CloudWatchLogsConfiguration cloudWatchLogsConfiguration
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
String customInstanceProfileArn
The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String customJson
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.
SdkInternalList<T> customSecurityGroupIds
An array containing the layer custom security group IDs.
SdkInternalList<T> packages
An array of Package objects that describes the layer packages.
SdkInternalList<T> volumeConfigurations
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Boolean enableAutoHealing
Whether to disable auto healing for the layer.
Boolean autoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
Boolean autoAssignPublicIps
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
Recipes customRecipes
A LayerCustomRecipes object that specifies the layer custom recipes.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true. To control when updates are installed, set this value to false. You must then
update your instances manually by using CreateDeployment to run the update_dependencies stack
command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
To ensure that your instances have the latest security updates, we strongly recommend using the default value of
true.
Boolean useEbsOptimizedInstances
Whether to use Amazon EBS-optimized instances.
LifecycleEventConfiguration lifecycleEventConfiguration
A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an
execution timeout and enable or disable Elastic Load Balancer connection draining.
String layerId
The layer ID.
String name
The stack name.
String region
The stack's AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints.
In the AWS CLI, this API maps to the --stack-region parameter. If the --stack-region
parameter and the AWS CLI common parameter --region are set to the same value, the stack uses a
regional endpoint. If the --stack-region parameter is not set, but the AWS CLI
--region parameter is, this also results in a stack with a regional endpoint. However, if the
--region parameter is set to us-east-1, and the --stack-region parameter
is set to one of the following, then the stack uses a legacy or classic region:
us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2
. In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are
supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose
the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for
new stacks. The AWS CLI common --region parameter always specifies a regional API endpoint; it
cannot be used to specify a classic AWS OpsWorks Stacks region.
String vpcId
The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
If your account supports EC2-Classic, the default value is no VPC.
If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone
or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter.
If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId.
For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.
SdkInternalMap<K,V> attributes
One or more user-defined key-value pairs to be added to the stack attributes.
String serviceRoleArn
The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
String defaultInstanceProfileArn
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
Microsoft Windows Server 2012 R2 with SQL Server Express,
Microsoft Windows Server 2012 R2 with SQL Server Standard, or
Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more
information, see Using Custom
AMIs.
The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
String hostnameTheme
The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for
the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the
current theme.
String defaultAvailabilityZone
The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a
value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the
VpcId parameter description.
String defaultSubnetId
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId
parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance.
If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For
information on default values and when this parameter is required, see the VpcId parameter
description.
String customJson
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
StackConfigurationManager configurationManager
The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on
Chef 11.10 stacks. For more information, see Create a New Stack.
Boolean useCustomCookbooks
Whether the stack uses custom cookbooks.
Boolean useOpsworksSecurityGroups
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated
with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom
security groups. UseOpsworksSecurityGroups has the following settings:
True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
Source customCookbooksSource
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
String defaultSshKeyName
A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
String defaultRootDeviceType
The default root device type. This value is the default for all instances in the stack, but you can override it
when you create an instance. The default option is instance-store. For more information, see Storage for
the Root Device.
String agentVersion
The default AWS OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent
versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
String stackId
The stack ID, which is an opaque string that you use to identify the stack when performing actions such as
DescribeStacks.
String iamUserArn
The user's IAM ARN; this can also be a federated user's ARN.
String sshUsername
The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name
includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be
changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from
the IAM user name.
String sshPublicKey
The user's public SSH key.
Boolean allowSelfManagement
Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.
String iamUserArn
The user's IAM ARN.
String appId
The app ID.
String layerId
The layer ID.
String stackId
The stack ID.
String iamUserArn
The user's IAM ARN. This can also be a federated user's ARN.
String deploymentId
The deployment ID.
String stackId
The stack ID.
String appId
The app ID.
String createdAt
Date when the deployment was created.
String completedAt
Date when the deployment completed.
Integer duration
The deployment duration.
String iamUserArn
The user's IAM ARN.
String comment
A user-defined comment.
DeploymentCommand command
Used to specify a stack or deployment command.
String status
The deployment status:
running
successful
failed
String customJson
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
SdkInternalList<T> instanceIds
The IDs of the target instances.
String name
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
execute_recipes: Execute one or more recipes. To specify the recipes, set an Args
parameter named recipes to the list of recipes to be executed. For example, to execute
phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}.
install_dependencies: Install the stack's dependencies.
update_custom_cookbooks: Update the stack's custom cookbooks.
update_dependencies: Update the stack's dependencies.
The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.
For apps, the following commands are available:
deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named
migrate. Set Args to {"migrate":["true"]} to migrate the database. The default setting
is {"migrate":["false"]}.
rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks
stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as
many as four versions.
start: Start the app's web or application server.
stop: Stop the app's web or application server.
restart: Restart the app's web or application server.
undeploy: Undeploy the app.
SdkInternalMap<K,V> args
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}
The update_dependencies command takes two arguments:
upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to
upgrade, such as Amazon Linux 2016.09. You must also set the allow_reboot argument to
true.
allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary,
after installing the updates. This argument can be set to either true or false. The
default value is false.
For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the following.
{ "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] }
String ecsClusterArn
The cluster's Amazon Resource Number (ARN).
String elasticIp
The Elastic IP address.
String instanceId
The instance ID.
String rdsDbInstanceArn
The Amazon RDS instance's ARN.
String volumeId
The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.
String stackId
The stack ID.
StackConfigurationManager configurationManager
The configuration manager.
SdkInternalList<T> agentVersions
The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.
String stackId
The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the
specified stack.
SdkInternalList<T> appIds
An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a
description of the specified apps. Otherwise, it returns a description of every app.
SdkInternalList<T> apps
An array of App objects that describe the specified apps.
String deploymentId
The deployment ID. If you include this parameter, DescribeCommands returns a description of the
commands associated with the specified deployment.
String instanceId
The instance ID. If you include this parameter, DescribeCommands returns a description of the
commands associated with the specified instance.
SdkInternalList<T> commandIds
An array of command IDs. If you include this parameter, DescribeCommands returns a description of
the specified commands. Otherwise, it returns a description of every command.
SdkInternalList<T> commands
An array of Command objects that describe each of the specified commands.
String stackId
The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.
String appId
The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.
SdkInternalList<T> deploymentIds
An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.
SdkInternalList<T> deployments
An array of Deployment objects that describe the deployments.
SdkInternalList<T> ecsClusterArns
A list of ARNs, one for each cluster to be described.
String stackId
A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the
stack.
String nextToken
If the previous paginated request did not return all of the remaining results, the response object's
NextToken parameter value is set to a token. To retrieve the next set of results, call
DescribeEcsClusters again and assign that token to the request object's NextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is
set to null.
Integer maxResults
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
a single call. If the number of available results exceeds this maximum, the response includes a
NextToken value that you can assign to the NextToken request parameter to get the next
set of results.
SdkInternalList<T> ecsClusters
A list of EcsCluster objects containing the cluster descriptions.
String nextToken
If a paginated request does not return all of the remaining results, this parameter is set to a token that you
can assign to the request object's NextToken parameter to retrieve the next set of results. If the
previous paginated request returned all of the remaining results, this parameter is set to null.
String instanceId
The instance ID. If you include this parameter, DescribeElasticIps returns a description of the
Elastic IP addresses associated with the specified instance.
String stackId
A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic
IP addresses that are registered with the specified stack.
SdkInternalList<T> ips
An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps
returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic
IP address.
SdkInternalList<T> elasticIps
An ElasticIps object that describes the specified Elastic IP addresses.
String stackId
A stack ID. The action describes the stack's Elastic Load Balancing instances.
SdkInternalList<T> layerIds
A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
SdkInternalList<T> elasticLoadBalancers
A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.
String stackId
A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances
associated with the specified stack.
String layerId
A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances
associated with the specified layer.
SdkInternalList<T> instanceIds
An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a
description of the specified instances. Otherwise, it returns a description of every instance.
SdkInternalList<T> instances
An array of Instance objects that describe the instances.
String stackId
The stack ID.
SdkInternalList<T> layerIds
An array of layer IDs that specify the layers to be described. If you omit this parameter,
DescribeLayers returns a description of every layer in the specified stack.
SdkInternalList<T> layers
An array of Layer objects that describe the layers.
SdkInternalList<T> layerIds
An array of layer IDs.
SdkInternalList<T> loadBasedAutoScalingConfigurations
An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.
SelfUserProfile userProfile
A UserProfile object that describes the user's SSH information.
SdkInternalList<T> operatingSystems
Contains information in response to a DescribeOperatingSystems request.
String iamUserArn
The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers.
String stackId
The stack ID.
SdkInternalList<T> permissions
An array of Permission objects that describe the stack permissions.
If the request object contains only a stack ID, the array contains a Permission object with
permissions for each of the stack IAM ARNs.
If the request object contains only an IAM ARN, the array contains a Permission object with
permissions for each of the user's stack IDs.
If the request contains a stack ID and an IAM ARN, the array contains a single Permission object
with permissions for the specified stack and IAM ARN.
String instanceId
The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID
arrays associated with the specified instance.
String stackId
The stack ID.
SdkInternalList<T> raidArrayIds
An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of
the specified arrays. Otherwise, it returns a description of every array.
SdkInternalList<T> raidArrays
A RaidArrays object that describes the specified RAID arrays.
String stackId
The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.
SdkInternalList<T> rdsDbInstanceArns
An array containing the ARNs of the instances to be described.
SdkInternalList<T> rdsDbInstances
An a array of RdsDbInstance objects that describe the instances.
String stackId
The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors
associated with the specified stack.
String instanceId
The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors
associated with the specified instance.
SdkInternalList<T> serviceErrorIds
An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions
of the specified errors. Otherwise, it returns a description of every error.
SdkInternalList<T> serviceErrors
An array of ServiceError objects that describe the specified service errors.
String stackId
The stack ID.
String agentInstallerUrl
The AWS OpsWorks Stacks agent installer's URL.
SdkInternalMap<K,V> parameters
An embedded object that contains the provisioning parameters.
SdkInternalList<T> stackIds
An array of stack IDs that specify the stacks to be described. If you omit this parameter,
DescribeStacks returns a description of every stack.
SdkInternalList<T> stacks
An array of Stack objects that describe the stacks.
String stackId
The stack ID.
StackSummary stackSummary
A StackSummary object that contains the results.
SdkInternalList<T> instanceIds
An array of instance IDs.
SdkInternalList<T> timeBasedAutoScalingConfigurations
An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the
specified instances.
SdkInternalList<T> iamUserArns
An array of IAM or federated user ARNs that identify the users to be described.
SdkInternalList<T> userProfiles
A Users object that describes the specified users.
String instanceId
The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes
associated with the specified instance.
String stackId
A stack ID. The action describes the stack's registered Amazon EBS volumes.
String raidArrayId
The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes
associated with the specified RAID array.
SdkInternalList<T> volumeIds
Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the
specified volumes. Otherwise, it returns a description of every volume.
SdkInternalList<T> volumes
An array of volume IDs.
String elasticIp
The Elastic IP address.
String snapshotId
The snapshot ID.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
Integer volumeSize
The volume size, in GiB. For more information, see EbsBlockDevice.
String volumeType
The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD)
volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and
standard for Magnetic volumes.
If you specify the io1 volume type, you must also specify a value for the Iops
attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default
volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).
Boolean deleteOnTermination
Whether the volume is deleted on instance termination.
String elasticLoadBalancerName
The Elastic Load Balancing instance's name.
String region
The instance's AWS region.
String dnsName
The instance's public DNS name.
String stackId
The ID of the stack that the instance is associated with.
String layerId
The ID of the layer that the instance is attached to.
String vpcId
The VPC ID.
SdkInternalList<T> availabilityZones
A list of Availability Zones.
SdkInternalList<T> subnetIds
A list of subnet IDs, if the stack is running in a VPC.
SdkInternalList<T> ec2InstanceIds
A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
String key
(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
String value
(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.
Boolean secure
(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an
environment variable's value, set Secure to true. DescribeApps then
returns *****FILTERED***** instead of the actual value. The default value for Secure is
false.
String layerId
The layer ID.
String instanceId
The instance's AWS OpsWorks Stacks ID.
Integer validForInMinutes
The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.
TemporaryCredential temporaryCredential
A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients,
such as the Microsoft Remote Desktop Connection.
String agentVersion
The agent version. This parameter is set to INHERIT if the instance inherits the default stack
setting or to a a version number for a fixed agent version.
String amiId
A custom AMI ID to be used to create the instance. For more information, see Instances
String architecture
The instance architecture: "i386" or "x86_64".
String arn
The instance's Amazon Resource Number (ARN).
String autoScalingType
For load-based or time-based instances, the type.
String availabilityZone
The instance Availability Zone. For more information, see Regions and Endpoints.
SdkInternalList<T> blockDeviceMappings
An array of BlockDeviceMapping objects that specify the instance's block device mappings.
String createdAt
The time that the instance was created.
Boolean ebsOptimized
Whether this is an Amazon EBS-optimized instance.
String ec2InstanceId
The ID of the associated Amazon EC2 instance.
String ecsClusterArn
For container instances, the Amazon ECS cluster's ARN.
String ecsContainerInstanceArn
For container instances, the instance's ARN.
String elasticIp
The instance Elastic IP address .
String hostname
The instance host name.
String infrastructureClass
For registered instances, the infrastructure class: ec2 or on-premises.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true. If this value is set to false, you must then update your instances manually by
using CreateDeployment to run the update_dependencies stack command or by manually running
yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest
security updates.
String instanceId
The instance ID.
String instanceProfileArn
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
String instanceType
The instance type, such as t2.micro.
String lastServiceErrorId
The ID of the last service error. For more information, call DescribeServiceErrors.
SdkInternalList<T> layerIds
An array containing the instance layer IDs.
String os
The instance's operating system.
String platform
The instance's platform.
String privateDns
The instance's private DNS name.
String privateIp
The instance's private IP address.
String publicDns
The instance public DNS name.
String publicIp
The instance public IP address.
String registeredBy
For registered instances, who performed the registration.
String reportedAgentVersion
The instance's reported AWS OpsWorks Stacks agent version.
ReportedOs reportedOs
For registered instances, the reported operating system.
String rootDeviceType
The instance's root device type. For more information, see Storage for the Root Device.
String rootDeviceVolumeId
The root device volume ID.
SdkInternalList<T> securityGroupIds
An array containing the instance security group IDs.
String sshHostDsaKeyFingerprint
The SSH key's Deep Security Agent (DSA) fingerprint.
String sshHostRsaKeyFingerprint
The SSH key's RSA fingerprint.
String sshKeyName
The instance's Amazon EC2 key-pair name.
String stackId
The stack ID.
String status
The instance status:
booting
connection_lost
online
pending
rebooting
requested
running_setup
setup_failed
shutting_down
start_failed
stop_failed
stopped
stopping
terminated
terminating
String subnetId
The instance's subnet ID; applicable only if the stack is running in a VPC.
String tenancy
The instance's tenancy option, such as dedicated or host.
String virtualizationType
The instance's virtualization type: paravirtual or hvm.
Integer assigning
The number of instances in the Assigning state.
Integer booting
The number of instances with booting status.
Integer connectionLost
The number of instances with connection_lost status.
Integer deregistering
The number of instances in the Deregistering state.
Integer online
The number of instances with online status.
Integer pending
The number of instances with pending status.
Integer rebooting
The number of instances with rebooting status.
Integer registered
The number of instances in the Registered state.
Integer registering
The number of instances in the Registering state.
Integer requested
The number of instances with requested status.
Integer runningSetup
The number of instances with running_setup status.
Integer setupFailed
The number of instances with setup_failed status.
Integer shuttingDown
The number of instances with shutting_down status.
Integer startFailed
The number of instances with start_failed status.
Integer stopFailed
The number of instances with stop_failed status.
Integer stopped
The number of instances with stopped status.
Integer stopping
The number of instances with stopping status.
Integer terminated
The number of instances with terminated status.
Integer terminating
The number of instances with terminating status.
Integer unassigning
The number of instances in the Unassigning state.
String arn
The Amazon Resource Number (ARN) of a layer.
String stackId
The layer stack ID.
String layerId
The layer ID.
String type
The layer type.
String name
The layer name.
String shortname
The layer short name.
SdkInternalMap<K,V> attributes
The layer attributes.
For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword
attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value
For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's
ARN.
CloudWatchLogsConfiguration cloudWatchLogsConfiguration
The Amazon CloudWatch Logs configuration settings for the layer.
String customInstanceProfileArn
The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String customJson
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
SdkInternalList<T> customSecurityGroupIds
An array containing the layer's custom security group IDs.
SdkInternalList<T> defaultSecurityGroupNames
An array containing the layer's security group names.
SdkInternalList<T> packages
An array of Package objects that describe the layer's packages.
SdkInternalList<T> volumeConfigurations
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Boolean enableAutoHealing
Whether auto healing is disabled for the layer.
Boolean autoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
Boolean autoAssignPublicIps
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
Recipes defaultRecipes
AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy,
undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each
event. You can also provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom
event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a
particular layer to be run in response to each of the five events.
To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe
name, which is the recipe's file name without the .rb extension. For example:
phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's
phpapp2 folder.
Recipes customRecipes
A LayerCustomRecipes object that specifies the layer's custom recipes.
String createdAt
Date when the layer was created.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true. If this value is set to false, you must then update your instances manually by
using CreateDeployment to run the update_dependencies stack command or manually running
yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest
security updates.
Boolean useEbsOptimizedInstances
Whether the layer uses Amazon EBS-optimized instances.
LifecycleEventConfiguration lifecycleEventConfiguration
A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
ShutdownEventConfiguration shutdown
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
String resourceArn
The stack or layer's Amazon Resource Number (ARN).
Integer maxResults
Do not use. A validation exception occurs if you add a MaxResults parameter to a
ListTagsRequest call.
String nextToken
Do not use. A validation exception occurs if you add a NextToken parameter to a
ListTagsRequest call.
SdkInternalMap<K,V> tags
A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.
String nextToken
If a paginated request does not return all of the remaining results, this parameter is set to a token that you
can assign to the request object's NextToken parameter to get the next set of results. If the
previous paginated request returned all of the remaining results, this parameter is set to null.
String layerId
The layer ID.
Boolean enable
Whether load-based auto scaling is enabled for the layer.
AutoScalingThresholds upScaling
An AutoScalingThresholds object that describes the upscaling configuration, which defines how and
when AWS OpsWorks Stacks increases the number of instances.
AutoScalingThresholds downScaling
An AutoScalingThresholds object that describes the downscaling configuration, which defines how and
when AWS OpsWorks Stacks reduces the number of instances.
String name
The name of the operating system, such as Amazon Linux 2018.03.
String id
The ID of a supported operating system, such as Amazon Linux 2018.03.
String type
The type of a supported operating system, either Linux or Windows.
SdkInternalList<T> configurationManagers
Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.
String reportedName
A short name for the operating system manufacturer.
String reportedVersion
The version of the operating system, including the release and edition, if applicable.
Boolean supported
Indicates that an operating system is not supported for new instances.
String stackId
A stack ID.
String iamUserArn
The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.
Boolean allowSsh
Whether the user can use SSH.
Boolean allowSudo
Whether the user can use sudo.
String level
The user's permission level, which must be the following:
deny
show
deploy
manage
iam_only
For more information on the permissions associated with these levels, see Managing User Permissions
String raidArrayId
The array ID.
String instanceId
The instance ID.
String name
The array name.
Integer raidLevel
The RAID level.
Integer numberOfDisks
The number of disks in the array.
Integer size
The array's size.
String device
The array's Linux device. For example /dev/mdadm0.
String mountPoint
The array's mount point.
String availabilityZone
The array's Availability Zone. For more information, see Regions and Endpoints.
String createdAt
When the RAID array was created.
String stackId
The stack ID.
String volumeType
The volume type, standard or PIOPS.
Integer iops
For PIOPS volumes, the IOPS per disk.
String rdsDbInstanceArn
The instance's ARN.
String dbInstanceIdentifier
The DB instance identifier.
String dbUser
The master user name.
String dbPassword
AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
String region
The instance's AWS region.
String address
The instance's address.
String engine
The instance's database engine.
String stackId
The ID of the stack with which the instance is registered.
Boolean missingOnRds
Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks
Stacks attempts to discover the instance only once. If this value is set to true, you must
deregister the instance, and then register it again.
String instanceId
The instance ID.
SdkInternalList<T> setup
An array of custom recipe names to be run following a setup event.
SdkInternalList<T> configure
An array of custom recipe names to be run following a configure event.
SdkInternalList<T> deploy
An array of custom recipe names to be run following a deploy event.
SdkInternalList<T> undeploy
An array of custom recipe names to be run following a undeploy event.
SdkInternalList<T> shutdown
An array of custom recipe names to be run following a shutdown event.
String ecsClusterArn
The cluster's ARN.
String elasticIp
The Elastic IP address.
String stackId
The ID of the stack that the instance is to be registered with.
String hostname
The instance's hostname.
String publicIp
The instance's public IP address.
String privateIp
The instance's private IP address.
String rsaPublicKey
The instances public RSA key. This key is used to encrypt communication between the instance and the service.
String rsaPublicKeyFingerprint
The instances public RSA key fingerprint.
InstanceIdentity instanceIdentity
An InstanceIdentity object that contains the instance's identity.
String instanceId
The registered instance's AWS OpsWorks Stacks ID.
String volumeId
The volume ID.
String layerId
The layer ID.
Boolean enable
Enables load-based auto scaling for the layer.
AutoScalingThresholds upScaling
An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds
these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.
AutoScalingThresholds downScaling
An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls
below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.
String stackId
The stack ID.
String iamUserArn
The user's IAM ARN. This can also be a federated user's ARN.
Boolean allowSsh
The user is allowed to use SSH to communicate with the instance.
Boolean allowSudo
The user is allowed to use sudo to elevate privileges.
String level
The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
deny
show
deploy
manage
iam_only
For more information about the permissions associated with these levels, see Managing User Permissions.
String instanceId
The instance ID.
WeeklyAutoScalingSchedule autoScalingSchedule
An AutoScalingSchedule with the instance schedule.
Integer executionTimeout
The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.
Boolean delayUntilElbConnectionsDrained
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
String type
The repository type.
String url
The source URL. The following is an example of an Amazon S3 source URL:
https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.
String username
This parameter depends on the repository type.
For Amazon S3 bundles, set Username to the appropriate IAM access key ID.
For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.
String password
When included in a request, the parameter depends on the repository type.
For Amazon S3 bundles, set Password to the appropriate IAM secret access key.
For HTTP bundles and Subversion repositories, set Password to the password.
For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
String sshKey
In requests, the repository's SSH key.
In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
String revision
The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
String stackId
The stack ID.
String name
The stack name.
String arn
The stack's ARN.
String region
The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
String vpcId
The VPC ID; applicable only if the stack is running in a VPC.
SdkInternalMap<K,V> attributes
The stack's attributes.
String serviceRoleArn
The stack AWS Identity and Access Management (IAM) role.
String defaultInstanceProfileArn
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's default operating system.
String hostnameTheme
The stack host name theme, with spaces replaced by underscores.
String defaultAvailabilityZone
The stack's default Availability Zone. For more information, see Regions and Endpoints.
String defaultSubnetId
The default subnet ID; applicable only if the stack is running in a VPC.
String customJson
A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
StackConfigurationManager configurationManager
The configuration manager.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For
more information, see Create a New Stack.
Boolean useCustomCookbooks
Whether the stack uses custom cookbooks.
Boolean useOpsworksSecurityGroups
Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.
Source customCookbooksSource
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
String defaultSshKeyName
A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
String createdAt
The date when the stack was created.
String defaultRootDeviceType
The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
String agentVersion
The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed
agent version.
String stackId
The stack ID.
String name
The stack name.
String arn
The stack's ARN.
Integer layersCount
The number of layers.
Integer appsCount
The number of apps.
InstancesCount instancesCount
An InstancesCount object with the number of instances in each status.
String instanceId
The instance ID.
String stackId
The stack ID.
String instanceId
The instance ID.
Boolean force
Specifies whether to force an instance to stop. If the instance's root device type is ebs, or
EBS-backed, adding the Force parameter to the StopInstances API call disassociates the
AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must
also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks
instance with a new one.
String stackId
The stack ID.
String resourceArn
The stack or layer's Amazon Resource Number (ARN).
SdkInternalMap<K,V> tags
A map that contains tag keys and tag values that are attached to a stack or layer.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 40 tags is allowed for any resource.
String username
The user name.
String password
The password.
Integer validForInMinutes
The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.
String instanceId
The instance's AWS OpsWorks Stacks ID.
String instanceId
The instance ID.
WeeklyAutoScalingSchedule autoScalingSchedule
A WeeklyAutoScalingSchedule object with the instance schedule.
String instanceId
The instance ID.
String volumeId
The volume ID.
String resourceArn
The stack or layer's Amazon Resource Number (ARN).
SdkInternalList<T> tagKeys
A list of the keys of tags to be removed from a stack or layer.
String appId
The app ID.
String name
The app name.
String description
A description of the app.
SdkInternalList<T> dataSources
The app's data sources.
String type
The app type.
Source appSource
A Source object that specifies the app repository.
SdkInternalList<T> domains
The app's virtual host settings, with multiple domains separated by commas. For example:
'www.example.com, example.com'
Boolean enableSsl
Whether SSL is enabled for the app.
SslConfiguration sslConfiguration
An SslConfiguration object with the SSL configuration.
SdkInternalMap<K,V> attributes
One or more user-defined key/value pairs to be added to the stack attributes.
SdkInternalList<T> environment
An array of EnvironmentVariable objects that specify environment variables to be associated with the
app. After you deploy the app, these variables are defined on the associated app server instances.For more
information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."
If you have specified one or more environment variables, you cannot modify the stack's Chef version.
String instanceId
The instance ID.
SdkInternalList<T> layerIds
The instance's layer IDs.
String instanceType
The instance type, such as t2.micro. For a list of supported instance types, open the stack in the
console, choose Instances, and choose + Instance. The Size list contains the currently
supported types. For more information, see Instance Families and Types.
The parameter values that you use to specify the various types are in the API Name column of the
Available Instance Types table.
String autoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
String hostname
The instance host name.
String os
The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
Microsoft Windows Server 2012 R2 with SQL Server Express,
Microsoft Windows Server 2012 R2 with SQL Server Standard, or
Microsoft Windows Server 2012 R2 with SQL Server Web.
For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom, you
must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported
operating systems, see Operating Systems. For
more information about how to use custom AMIs with OpsWorks, see Using Custom
AMIs.
You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.
String amiId
The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.
String sshKeyName
The instance's Amazon EC2 key name.
String architecture
The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true. To control when updates are installed, set this value to false. You must then
update your instances manually by using CreateDeployment to run the update_dependencies stack
command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest
security updates.
Boolean ebsOptimized
This property cannot be updated.
String agentVersion
The default AWS OpsWorks Stacks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.
The default setting is INHERIT. To specify an agent version, you must use the complete version
number, not the abbreviated number shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions.
AgentVersion cannot be set to Chef 12.2.
String layerId
The layer ID.
String name
The layer name, which is used by the console.
String shortname
For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.
The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference
SdkInternalMap<K,V> attributes
One or more user-defined key/value pairs to be added to the stack attributes.
CloudWatchLogsConfiguration cloudWatchLogsConfiguration
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
String customInstanceProfileArn
The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String customJson
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.
SdkInternalList<T> customSecurityGroupIds
An array containing the layer's custom security group IDs.
SdkInternalList<T> packages
An array of Package objects that describe the layer's packages.
SdkInternalList<T> volumeConfigurations
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Boolean enableAutoHealing
Whether to disable auto healing for the layer.
Boolean autoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
Boolean autoAssignPublicIps
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
Recipes customRecipes
A LayerCustomRecipes object that specifies the layer's custom recipes.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true. To control when updates are installed, set this value to false. You must then
update your instances manually by using CreateDeployment to run the update_dependencies stack
command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest
security updates.
Boolean useEbsOptimizedInstances
Whether to use Amazon EBS-optimized instances.
LifecycleEventConfiguration lifecycleEventConfiguration
String sshPublicKey
The user's SSH public key.
String stackId
The stack ID.
String name
The stack's new name.
SdkInternalMap<K,V> attributes
One or more user-defined key-value pairs to be added to the stack attributes.
String serviceRoleArn
Do not use this parameter. You cannot update a stack's service role.
String defaultInstanceProfileArn
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's operating system, which must be set to one of the following:
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
Ubuntu 12.04 LTS.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
Microsoft Windows Server 2012 R2 with SQL Server Express,
Microsoft Windows Server 2012 R2 with SQL Server Standard, or
Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more
information about how to use custom AMIs with OpsWorks, see Using Custom
AMIs.
The default option is the stack's current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
String hostnameTheme
The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names
for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the
current theme.
String defaultAvailabilityZone
The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a
value for DefaultSubnetId, the subnet must be in the same zone. For more information, see
CreateStack.
String defaultSubnetId
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId
parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance.
If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For
information on default values and when this parameter is required, see the VpcId parameter
description.
String customJson
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
StackConfigurationManager configurationManager
The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on
Chef 11.10 stacks. For more information, see Create a New Stack.
Boolean useCustomCookbooks
Whether the stack uses custom cookbooks.
Source customCookbooksSource
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
String defaultSshKeyName
A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS
OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log
in to the instance. For more information, see Using SSH to Communicate
with an Instance and Managing SSH Access.
You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
String defaultRootDeviceType
The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
Boolean useOpsworksSecurityGroups
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated
with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security
groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:
True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
String agentVersion
The default AWS OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent
versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is LATEST. To specify an agent version, you must use the complete version
number, not the abbreviated number shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
String iamUserArn
The user IAM ARN. This can also be a federated user's ARN.
String sshUsername
The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name
includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be
changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from
the IAM user name.
String sshPublicKey
The user's new SSH public key.
Boolean allowSelfManagement
Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
String iamUserArn
The user's IAM ARN.
String name
The user's name.
String sshUsername
The user's SSH user name.
String sshPublicKey
The user's SSH public key.
Boolean allowSelfManagement
Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
String volumeId
The volume ID.
String ec2VolumeId
The Amazon EC2 volume ID.
String name
The volume name.
String raidArrayId
The RAID array ID.
String instanceId
The instance ID.
String status
The value returned by DescribeVolumes.
Integer size
The volume size.
String device
The device name.
String mountPoint
The volume mount point. For example, "/mnt/disk1".
String region
The AWS region. For more information about AWS regions, see Regions and Endpoints.
String availabilityZone
The volume Availability Zone. For more information, see Regions and Endpoints.
String volumeType
The volume type. For more information, see Amazon EBS Volume Types.
standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
GiB.
io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
16384 GiB.
gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
size of 16384 GiB.
st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
minimum size of 500 GiB and a maximum size of 16384 GiB.
sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
GiB.
Integer iops
For PIOPS volumes, the IOPS per disk.
Boolean encrypted
Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
String mountPoint
The volume mount point. For example "/dev/sdh".
Integer raidLevel
The volume RAID level.
Integer numberOfDisks
The number of disks in the volume.
Integer size
The volume size.
String volumeType
The volume type. For more information, see Amazon EBS Volume Types.
standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
GiB.
io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
16384 GiB.
gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
size of 16384 GiB.
st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
minimum size of 500 GiB and a maximum size of 16384 GiB.
sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
GiB.
Integer iops
For PIOPS volumes, the IOPS per disk.
Boolean encrypted
Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
SdkInternalMap<K,V> monday
The schedule for Monday.
SdkInternalMap<K,V> tuesday
The schedule for Tuesday.
SdkInternalMap<K,V> wednesday
The schedule for Wednesday.
SdkInternalMap<K,V> thursday
The schedule for Thursday.
SdkInternalMap<K,V> friday
The schedule for Friday.
SdkInternalMap<K,V> saturday
The schedule for Saturday.
SdkInternalMap<K,V> sunday
The schedule for Sunday.
Copyright © 2021. All rights reserved.