API version 2013-02-18 of the Amazon OpsWorks SDK configuration.

Indicates that a request was not valid.

Indicates that a resource was not found.

Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Polls DescribeDeployments every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Polls DescribeApps every 1 seconds until a successful state is reached. An error is returned after 40 failed checks.

Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

See: newDescribeRdsDbInstances smart constructor.

Create a value of DescribeRdsDbInstances with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rdsDbInstanceArns:DescribeRdsDbInstances', describeRdsDbInstances_rdsDbInstanceArns - An array containing the ARNs of the instances to be described.

$sel:stackId:DescribeRdsDbInstances', describeRdsDbInstances_stackId - The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

Contains the response to a DescribeRdsDbInstances request.

See: newDescribeRdsDbInstancesResponse smart constructor.

Create a value of DescribeRdsDbInstancesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rdsDbInstances:DescribeRdsDbInstancesResponse', describeRdsDbInstancesResponse_rdsDbInstances - An a array of RdsDbInstance objects that describe the instances.

$sel:httpStatus:DescribeRdsDbInstancesResponse', describeRdsDbInstancesResponse_httpStatus - The response's http status code.

See: newDeleteStack smart constructor.

Create a value of DeleteStack with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:stackId:DeleteStack', deleteStack_stackId - The stack ID.

See: newDeleteStackResponse smart constructor.

Create a value of DeleteStackResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

See: newUpdateStack smart constructor.

Create a value of UpdateStack with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultInstanceProfileArn:UpdateStack', updateStack_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.

$sel:serviceRoleArn:UpdateStack', updateStack_serviceRoleArn - Do not use this parameter. You cannot update a stack's service role.

$sel:defaultRootDeviceType:UpdateStack', updateStack_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.

$sel:chefConfiguration:UpdateStack', updateStack_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.

$sel:agentVersion:UpdateStack', updateStack_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.

$sel:defaultSshKeyName:UpdateStack', updateStack_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.

$sel:customJson:UpdateStack', updateStack_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.

$sel:customCookbooksSource:UpdateStack', updateStack_customCookbooksSource - Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

$sel:defaultAvailabilityZone:UpdateStack', updateStack_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.

$sel:attributes:UpdateStack', updateStack_attributes - One or more user-defined key-value pairs to be added to the stack attributes.

$sel:name:UpdateStack', updateStack_name - The stack's new name.

$sel:defaultOs:UpdateStack', updateStack_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.

$sel:useOpsworksSecurityGroups:UpdateStack', updateStack_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.

$sel:useCustomCookbooks:UpdateStack', updateStack_useCustomCookbooks - Whether the stack uses custom cookbooks.

$sel:defaultSubnetId:UpdateStack', updateStack_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.

$sel:configurationManager:UpdateStack', updateStack_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.

$sel:hostnameTheme:UpdateStack', updateStack_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.

$sel:stackId:UpdateStack', updateStack_stackId - The stack ID.

See: newUpdateStackResponse smart constructor.

Create a value of UpdateStackResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

See: newCreateLayer smart constructor.

Create a value of CreateLayer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customInstanceProfileArn:CreateLayer', createLayer_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.

$sel:customSecurityGroupIds:CreateLayer', createLayer_customSecurityGroupIds - An array containing the layer custom security group IDs.

$sel:installUpdatesOnBoot:CreateLayer', createLayer_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.

$sel:cloudWatchLogsConfiguration:CreateLayer', createLayer_cloudWatchLogsConfiguration - Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

$sel:lifecycleEventConfiguration:CreateLayer', createLayer_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.

$sel:customRecipes:CreateLayer', createLayer_customRecipes - A LayerCustomRecipes object that specifies the layer custom recipes.

$sel:customJson:CreateLayer', createLayer_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.

$sel:volumeConfigurations:CreateLayer', createLayer_volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

$sel:enableAutoHealing:CreateLayer', createLayer_enableAutoHealing - Whether to disable auto healing for the layer.

$sel:packages:CreateLayer', createLayer_packages - An array of Package objects that describes the layer packages.

$sel:attributes:CreateLayer', createLayer_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.

$sel:autoAssignPublicIps:CreateLayer', createLayer_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.

$sel:useEbsOptimizedInstances:CreateLayer', createLayer_useEbsOptimizedInstances - Whether to use Amazon EBS-optimized instances.

$sel:autoAssignElasticIps:CreateLayer', createLayer_autoAssignElasticIps - Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

$sel:stackId:CreateLayer', createLayer_stackId - The layer stack ID.

$sel:type':CreateLayer', createLayer_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.

$sel:name:CreateLayer', createLayer_name - The layer name, which is used by the console.

$sel:shortname:CreateLayer', createLayer_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.

Contains the response to a CreateLayer request.

See: newCreateLayerResponse smart constructor.

Create a value of CreateLayerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:layerId:CreateLayerResponse', createLayerResponse_layerId - The layer ID.

$sel:httpStatus:CreateLayerResponse', createLayerResponse_httpStatus - The response's http status code.

See: newSetLoadBasedAutoScaling smart constructor.