options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.
- :layer_ids - required - (Array<) The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

Returns:

(Core::Response)

#assign_volume(options = {}) ⇒ `Core::Response`

Calls the AssignVolume API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :volume_id - required - (String) The volume ID.
- :instance_id - (String) The instance ID.

Returns:

(Core::Response)

#associate_elastic_ip(options = {}) ⇒ `Core::Response`

Calls the AssociateElasticIp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :elastic_ip - required - (String) The Elastic IP address.
- :instance_id - (String) The instance ID.

Returns:

(Core::Response)

#attach_elastic_load_balancer(options = {}) ⇒ `Core::Response`

Calls the AttachElasticLoadBalancer API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :elastic_load_balancer_name - required - (String) The Elastic Load Balancing instance's name.
- :layer_id - required - (String) The ID of the layer that the Elastic Load Balancing instance is to be attached to.

Returns:

(Core::Response)

#clone_stack(options = {}) ⇒ `Core::Response`

Calls the CloneStack API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :source_stack_id - required - (String) The source stack ID.
- :name - (String) The cloned stack name.
- :region - (String) The cloned stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
- :vpc_id - (String) 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 infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
- :attributes - (Hash<<String,String>) A list of stack attributes and values as key/value pairs to be added to the cloned stack.
- :service_role_arn - required - (String) The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks 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 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.
- :default_instance_profile_arn - (String) 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.
- :default_os - (String) 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 2015.03, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. Microsoft Windows Server 2012 R2 Base. A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs. The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks 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.
- :hostname_theme - (String) 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 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.
- :default_availability_zone - (String) 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.
- :default_subnet_id - (String) 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.
- :custom_json - (String) 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 and must escape characters such as '"': "\"value1\", \"key2\": \"value2\",..." For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
- :configuration_manager - (Hash) The configuration manager. When you clone a Linux stack we recommend that you use the configuration manager to specify the Chef version: 0.9, 11.4, or 11.10. The default value is currently 11.10.
  - :name - (String) The name. This parameter must be set to "Chef".
  - :version - (String) The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
- :chef_configuration - (Hash) 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.
  - :manage_berkshelf - (Boolean) Whether to enable Berkshelf.
  - :berkshelf_version - (String) The Berkshelf version.
- :use_custom_cookbooks - (Boolean) Whether to use custom cookbooks.
- :use_opsworks_security_groups - (Boolean) Whether to associate the AWS OpsWorks built-in security groups with the stack's layers. AWS OpsWorks 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 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 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.
- :custom_cookbooks_source - (Hash)
  - :type - (String) The repository type. Valid values include:
    - git
    - svn
    - archive
    - s3
  - :url - (String) The source URL.
  - :username - (String) 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.
  - :password - (String) 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 . In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :ssh_key - (String) In requests, the repository's SSH key. In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :revision - (String) The application's version. AWS OpsWorks 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.
- :default_ssh_key_name - (String) 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.
- :clone_permissions - (Boolean) Whether to clone the source stack's permissions.
- :clone_app_ids - (Array<) A list of source stack app IDs to be included in the cloned stack.
- :default_root_device_type - (String) 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. Valid values include:
  - ebs
  - instance-store
- :agent_version - (String) The default AWS OpsWorks agent version. You have the following options: Auto-update - Set this parameter to LATEST. AWS OpsWorks 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 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. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :stack_id - (String)

#create_app(options = {}) ⇒ `Core::Response`

Calls the CreateApp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.
- :shortname - (String) The app's short name.
- :name - required - (String) The app name.
- :description - (String) A description of the app.
- :data_sources - (Array<
  ) The app's data source.
  - :type - (String) The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.
  - :arn - (String) The data source's ARN.
  - :database_name - (String) The database name.
- :type - required - (String) The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks 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. Valid values include:
  - java
  - rails
  - php
  - nodejs
  - static
  - other
- :app_source - (Hash) A Source object that specifies the app repository.
  - :type - (String) The repository type. Valid values include:
    - git
    - svn
    - archive
    - s3
  - :url - (String) The source URL.
  - :username - (String) 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.
  - :password - (String) 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 . In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :ssh_key - (String) In requests, the repository's SSH key. In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :revision - (String) The application's version. AWS OpsWorks 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.
- :domains - (Array<) The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
- :enable_ssl - (Boolean) Whether to enable SSL for the app.
- :ssl_configuration - (Hash) An SslConfiguration object with the SSL configuration.
  - :certificate - required - (String) The contents of the certificate's domain.crt file.
  - :private_key - required - (String) The private key; the contents of the certificate's domain.kex file.
  - :chain - (String) Optional. Can be used to specify an intermediate certificate authority key or client authentication.
- :attributes - (Hash<<String,String>) One or more user-defined key/value pairs to be added to the stack attributes.
- :environment - (Array<
  ) 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 10 KB (10240 Bytes). 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 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.
  - :key - required - (String) (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.
  - :value - required - (String) (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.
  - :secure - (Boolean) (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 .

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :app_id - (String)

#create_deployment(options = {}) ⇒ `Core::Response`

Calls the CreateDeployment API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.
- :app_id - (String) The app ID. This parameter is required for app deployments, but not for other deployment commands.
- :instance_ids - (Array<) The instance IDs for the deployment targets.
- :command - required - (Hash) A DeploymentCommand object that specifies the deployment command and any associated arguments.
  - :name - required - (String) 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 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. Valid values include:
    - install_dependencies
    - update_dependencies
    - update_custom_cookbooks
    - execute_recipes
    - configure
    - setup
    - deploy
    - rollback
    - start
    - stop
    - restart
    - undeploy
  - :args - (Hash<<String,Array<>) The arguments of those commands that take arguments. It should be set to a JSON object with the following format: : ["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 2014.09. You must also set the allow_reboot argument to true . allow_reboot - Specifies whether to allow AWS OpsWorks 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 2014.09, set Args to the following. { "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":[" true "] }
- :comment - (String) A user-defined comment.
- :custom_json - (String) 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 and must escape characters such as '"': "\"value1\", \"key2\": \"value2\",..." For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :deployment_id - (String)

#create_instance(options = {}) ⇒ `Core::Response`

Calls the CreateInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.
- :layer_ids - required - (Array<) An array that contains the instance's layer IDs.
- :instance_type - required - (String) 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.
- :auto_scaling_type - (String) For load-based or time-based instances, the type. Windows stacks can use only time-based instances. Valid values include:
  - load
  - timer
- :hostname - (String) The instance host name.
- :os - (String) 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 2015.03, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. Microsoft Windows Server 2012 R2 Base. A custom AMI: Custom. For more information on the supported operating systems, see AWS OpsWorks 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. For more information on the supported operating systems, see Operating SystemsFor more information on how to use custom AMIs with AWS OpsWorks, see Using Custom AMIs.
- :ami_id - (String) 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.
- :ssh_key_name - (String) The instance's Amazon EC2 key-pair name.
- :availability_zone - (String) The instance Availability Zone. For more information, see Regions and Endpoints.
- :virtualization_type - (String) The instance's virtualization type, paravirtual or hvm.
- :subnet_id - (String) 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 to launch the instance in a different subnet.
- :architecture - (String) 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. Valid values include:
  - x86_64
  - i386
- :root_device_type - (String) The instance root device type. For more information, see Storage for the Root Device. Valid values include:
  - ebs
  - instance-store
- :block_device_mappings - (Array<
  ) An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping.
  - :device_name - (String) 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 will provide the correct device name.
  - :no_device - (String) Suppresses the specified device included in the AMI's block device mapping.
  - :virtual_name - (String) The virtual device name. For more information, see BlockDeviceMapping.
  - :ebs - (Hash) An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
    
    :snapshot_id - (String) The snapshot ID.
    
    :iops - (Integer) The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
    
    :volume_size - (Integer) The volume size, in GiB. For more information, see EbsBlockDevice.
    
    :volume_type - (String) The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes. Valid values include:
    
    gp2
    
    io1
    
    standard
    
    :delete_on_termination - (Boolean) Whether the volume is deleted on instance termination.
- :install_updates_on_boot - (Boolean) 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.
- :ebs_optimized - (Boolean) Whether to create an Amazon EBS-optimized instance.
- :agent_version - (String) The default AWS OpsWorks 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 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :instance_id - (String)

#create_layer(options = {}) ⇒ `Core::Response`

Calls the CreateLayer API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The layer stack ID.
- :type - required - (String) 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. Valid values include:
  - java-app
  - lb
  - web
  - php-app
  - rails-app
  - nodejs-app
  - memcached
  - db-master
  - monitoring-master
  - custom
- :name - required - (String) The layer name, which is used by the console.
- :shortname - required - (String) For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks 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. For more information, see the Layer Reference
- :attributes - (Hash<<String,String>) One or more user-defined key/value pairs to be added to the stack attributes.
- :custom_instance_profile_arn - (String) The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
- :custom_security_group_ids - (Array<) An array containing the layer custom security group IDs.
- :packages - (Array<) An array of Package objects that describe the layer packages.
- :volume_configurations - (Array<
  ) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
  - :mount_point - required - (String) The volume mount point. For example "/dev/sdh".
  - :raid_level - (Integer) The volume RAID level.
  - :number_of_disks - required - (Integer) The number of disks in the volume.
  - :size - required - (Integer) The volume size.
  - :volume_type - (String) The volume type: standard - Magnetic io1 - Provisioned IOPS (SSD) gp2 - General Purpose (SSD)
  - :iops - (Integer) For PIOPS volumes, the IOPS per disk.
- :enable_auto_healing - (Boolean) Whether to disable auto healing for the layer.
- :auto_assign_elastic_ips - (Boolean) Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
- :auto_assign_public_ips - (Boolean) 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.
- :custom_recipes - (Hash) A LayerCustomRecipes object that specifies the layer custom recipes.
  - :setup - (Array<) An array of custom recipe names to be run following a setup event.
  - :configure - (Array<) An array of custom recipe names to be run following a configure event.
  - :deploy - (Array<) An array of custom recipe names to be run following a deploy event.
  - :undeploy - (Array<) An array of custom recipe names to be run following a undeploy event.
  - :shutdown - (Array<) An array of custom recipe names to be run following a shutdown event.
- :install_updates_on_boot - (Boolean) 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.
- :use_ebs_optimized_instances - (Boolean) Whether to use Amazon EBS-optimized instances.
- :lifecycle_event_configuration - (Hash) 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.
  - :shutdown - (Hash) A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
    - :execution_timeout - (Integer) The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
    - :delay_until_elb_connections_drained - (Boolean) Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :layer_id - (String)

#create_stack(options = {}) ⇒ `Core::Response`

Calls the CreateStack API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :name - required - (String) The stack name.
- :region - required - (String) The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
- :vpc_id - (String) 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 infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
- :attributes - (Hash<<String,String>) One or more user-defined key-value pairs to be added to the stack attributes.
- :service_role_arn - required - (String) The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks 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.
- :default_instance_profile_arn - required - (String) 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.
- :default_os - (String) 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 2015.03, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. Microsoft Windows Server 2012 R2 Base. 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 on the supported operating systems, see AWS OpsWorks Operating Systems.
- :hostname_theme - (String) 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 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.
- :default_availability_zone - (String) 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.
- :default_subnet_id - (String) 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.
- :custom_json - (String) 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 escape characters such as '"': "\"value1\", \"key2\": \"value2\",..." For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- :configuration_manager - (Hash) The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 0.9, 11.4, or 11.10. The default value is currently 11.4.
  - :name - (String) The name. This parameter must be set to "Chef".
  - :version - (String) The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
- :chef_configuration - (Hash) 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.
  - :manage_berkshelf - (Boolean) Whether to enable Berkshelf.
  - :berkshelf_version - (String) The Berkshelf version.
- :use_custom_cookbooks - (Boolean) Whether the stack uses custom cookbooks.
- :use_opsworks_security_groups - (Boolean) Whether to associate the AWS OpsWorks built-in security groups with the stack's layers. AWS OpsWorks 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 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 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.
- :custom_cookbooks_source - (Hash)
  - :type - (String) The repository type. Valid values include:
    - git
    - svn
    - archive
    - s3
  - :url - (String) The source URL.
  - :username - (String) 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.
  - :password - (String) 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 . In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :ssh_key - (String) In requests, the repository's SSH key. In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :revision - (String) The application's version. AWS OpsWorks 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.
- :default_ssh_key_name - (String) 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.
- :default_root_device_type - (String) 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. Valid values include:
  - ebs
  - instance-store
- :agent_version - (String) The default AWS OpsWorks agent version. You have the following options: Auto-update - Set this parameter to LATEST. AWS OpsWorks 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 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. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :stack_id - (String)

#create_user_profile(options = {}) ⇒ `Core::Response`

Calls the CreateUserProfile API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :iam_user_arn - required - (String) The user's IAM ARN.
- :ssh_username - (String) 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 removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
- :ssh_public_key - (String) The user's public SSH key.
- :allow_self_management - (Boolean) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :iam_user_arn - (String)

#delete_app(options = {}) ⇒ `Core::Response`

Calls the DeleteApp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :app_id - required - (String) The app ID.

Returns:

(Core::Response)

#delete_instance(options = {}) ⇒ `Core::Response`

Calls the DeleteInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.
- :delete_elastic_ip - (Boolean) Whether to delete the instance Elastic IP address.
- :delete_volumes - (Boolean) Whether to delete the instance's Amazon EBS volumes.

Returns:

(Core::Response)

#delete_layer(options = {}) ⇒ `Core::Response`

Calls the DeleteLayer API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :layer_id - required - (String) The layer ID.

Returns:

(Core::Response)

#delete_stack(options = {}) ⇒ `Core::Response`

Calls the DeleteStack API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.

Returns:

(Core::Response)

#delete_user_profile(options = {}) ⇒ `Core::Response`

Calls the DeleteUserProfile API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :iam_user_arn - required - (String) The user's IAM ARN.

Returns:

(Core::Response)

#deregister_elastic_ip(options = {}) ⇒ `Core::Response`

Calls the DeregisterElasticIp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :elastic_ip - required - (String) The Elastic IP address.

Returns:

(Core::Response)

#deregister_instance(options = {}) ⇒ `Core::Response`

Calls the DeregisterInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.

Returns:

(Core::Response)

#deregister_rds_db_instance(options = {}) ⇒ `Core::Response`

Calls the DeregisterRdsDbInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :rds_db_instance_arn - required - (String) The Amazon RDS instance's ARN.

Returns:

(Core::Response)

#deregister_volume(options = {}) ⇒ `Core::Response`

Calls the DeregisterVolume API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :volume_id - required - (String) The AWS OpsWorks volume ID, which is the GUID that AWS OpsWorks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.

Returns:

(Core::Response)

#describe_agent_versions(options = {}) ⇒ `Core::Response`

Calls the DescribeAgentVersions API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - (String) The stack ID.
- :configuration_manager - (Hash) The configuration manager.
  - :name - (String) The name. This parameter must be set to "Chef".
  - :version - (String) The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :agent_versions - (Array
  )
  - :version - (String)
  - :configuration_manager - (Hash)
    
    :name - (String)
    
    :version - (String)

#describe_apps(options = {}) ⇒ `Core::Response`

Calls the DescribeApps API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - (String) The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.
- :app_ids - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :apps - (Array
  )
  - :app_id - (String)
  - :stack_id - (String)
  - :shortname - (String)
  - :name - (String)
  - :description - (String)
  - :data_sources - (Array)
    
    :type - (String)
    
    :arn - (String)
    
    :database_name - (String)
  - :type - (String)
  - :app_source - (Hash)
    
    :type - (String)
    
    :url - (String)
    
    :username - (String)
    
    :password - (String)
    
    :ssh_key - (String)
    
    :revision - (String)
  - :domains - (Array)
  - :enable_ssl - (Boolean)
  - :ssl_configuration - (Hash)
    
    :certificate - (String)
    
    :private_key - (String)
    
    :chain - (String)
  - :attributes - (Hash<String,String>)
  - :created_at - (String)
  - :environment - (Array)
    
    :key - (String)
    
    :value - (String)
    
    :secure - (Boolean)

#describe_commands(options = {}) ⇒ `Core::Response`

Calls the DescribeCommands API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :deployment_id - (String) The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.
- :instance_id - (String) The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.
- :command_ids - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :commands - (Array
  )
  - :command_id - (String)
  - :instance_id - (String)
  - :deployment_id - (String)
  - :created_at - (String)
  - :acknowledged_at - (String)
  - :completed_at - (String)
  - :status - (String)
  - :exit_code - (Integer)
  - :log_url - (String)
  - :type - (String)

#describe_deployments(options = {}) ⇒ `Core::Response`

Calls the DescribeDeployments API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - (String) The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.
- :app_id - (String) The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.
- :deployment_ids - (Array<) An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :deployments - (Array
  )
  - :deployment_id - (String)
  - :stack_id - (String)
  - :app_id - (String)
  - :created_at - (String)
  - :completed_at - (String)
  - :duration - (Integer)
  - :iam_user_arn - (String)
  - :comment - (String)
  - :command - (Hash)
    
    :name - (String)
    
    :args - (Hash<String,Hash>)
    
    :value - (Array)
  - :status - (String)
  - :custom_json - (String)
  - :instance_ids - (Array)

#describe_elastic_ips(options = {}) ⇒ `Core::Response`

Calls the DescribeElasticIps API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - (String) The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.
- :stack_id - (String) A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.
- :ips - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :elastic_ips - (Array
  )
  - :ip - (String)
  - :name - (String)
  - :domain - (String)
  - :region - (String)
  - :instance_id - (String)

#describe_elastic_load_balancers(options = {}) ⇒ `Core::Response`

Calls the DescribeElasticLoadBalancers API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - (String) A stack ID. The action describes the stack's Elastic Load Balancing instances.
- :layer_ids - (Array<) A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :elastic_load_balancers - (Array
  )
  - :elastic_load_balancer_name - (String)
  - :region - (String)
  - :dns_name - (String)
  - :stack_id - (String)
  - :layer_id - (String)
  - :vpc_id - (String)
  - :availability_zones - (Array)
  - :subnet_ids - (Array)
  - :ec_2_instance_ids - (Array)

#describe_instances(options = {}) ⇒ `Core::Response`

Calls the DescribeInstances API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - (String) A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.
- :layer_id - (String) A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.
- :instance_ids - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :instances - (Array
  )
  - :agent_version - (String)
  - :ami_id - (String)
  - :architecture - (String)
  - :auto_scaling_type - (String)
  - :availability_zone - (String)
  - :block_device_mappings - (Array)
    
    :device_name - (String)
    
    :no_device - (String)
    
    :virtual_name - (String)
    
    :ebs - (Hash)
    
    :snapshot_id - (String)
    
    :iops - (Integer)
    
    :volume_size - (Integer)
    
    :volume_type - (String)
    
    :delete_on_termination - (Boolean)
  - :created_at - (String)
  - :ebs_optimized - (Boolean)
  - :ec2_instance_id - (String)
  - :elastic_ip - (String)
  - :hostname - (String)
  - :infrastructure_class - (String)
  - :install_updates_on_boot - (Boolean)
  - :instance_id - (String)
  - :instance_profile_arn - (String)
  - :instance_type - (String)
  - :last_service_error_id - (String)
  - :layer_ids - (Array)
  - :os - (String)
  - :platform - (String)
  - :private_dns - (String)
  - :private_ip - (String)
  - :public_dns - (String)
  - :public_ip - (String)
  - :registered_by - (String)
  - :reported_agent_version - (String)
  - :reported_os - (Hash)
    
    :family - (String)
    
    :name - (String)
    
    :version - (String)
  - :root_device_type - (String)
  - :root_device_volume_id - (String)
  - :security_group_ids - (Array)
  - :ssh_host_dsa_key_fingerprint - (String)
  - :ssh_host_rsa_key_fingerprint - (String)
  - :ssh_key_name - (String)
  - :stack_id - (String)
  - :status - (String)
  - :subnet_id - (String)
  - :virtualization_type - (String)

#describe_layers(options = {}) ⇒ `Core::Response`

Calls the DescribeLayers API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - (String) The stack ID.
- :layer_ids - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :layers - (Array
  )
  - :stack_id - (String)
  - :layer_id - (String)
  - :type - (String)
  - :name - (String)
  - :shortname - (String)
  - :attributes - (Hash<String,String>)
  - :custom_instance_profile_arn - (String)
  - :custom_security_group_ids - (Array)
  - :default_security_group_names - (Array)
  - :packages - (Array)
  - :volume_configurations - (Array)
    
    :mount_point - (String)
    
    :raid_level - (Integer)
    
    :number_of_disks - (Integer)
    
    :size - (Integer)
    
    :volume_type - (String)
    
    :iops - (Integer)
  - :enable_auto_healing - (Boolean)
  - :auto_assign_elastic_ips - (Boolean)
  - :auto_assign_public_ips - (Boolean)
  - :default_recipes - (Hash)
    
    :setup - (Array)
    
    :configure - (Array)
    
    :deploy - (Array)
    
    :undeploy - (Array)
    
    :shutdown - (Array)
  - :custom_recipes - (Hash)
    
    :setup - (Array)
    
    :configure - (Array)
    
    :deploy - (Array)
    
    :undeploy - (Array)
    
    :shutdown - (Array)
  - :created_at - (String)
  - :install_updates_on_boot - (Boolean)
  - :use_ebs_optimized_instances - (Boolean)
  - :lifecycle_event_configuration - (Hash)
    
    :shutdown - (Hash)
    
    :execution_timeout - (Integer)
    
    :delay_until_elb_connections_drained - (Boolean)

#describe_load_based_auto_scaling(options = {}) ⇒ `Core::Response`

Calls the DescribeLoadBasedAutoScaling API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :layer_ids - required - (Array<) An array of layer IDs.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :load_based_auto_scaling_configurations - (Array
  )
  - :layer_id - (String)
  - :enable - (Boolean)
  - :up_scaling - (Hash)
    
    :instance_count - (Integer)
    
    :thresholds_wait_time - (Integer)
    
    :ignore_metrics_time - (Integer)
    
    :cpu_threshold - (Numeric)
    
    :memory_threshold - (Numeric)
    
    :load_threshold - (Numeric)
    
    :alarms - (Array)
  - :down_scaling - (Hash)
    
    :instance_count - (Integer)
    
    :thresholds_wait_time - (Integer)
    
    :ignore_metrics_time - (Integer)
    
    :cpu_threshold - (Numeric)
    
    :memory_threshold - (Numeric)
    
    :load_threshold - (Numeric)
    
    :alarms - (Array)

#describe_my_user_profile(options = {}) ⇒ `Core::Response`

Calls the DescribeMyUserProfile API operation.

Parameters:

options (Hash) (defaults to: {})

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :user_profile - (Hash)
  - :iam_user_arn - (String)
  - :name - (String)
  - :ssh_username - (String)
  - :ssh_public_key - (String)

#describe_permissions(options = {}) ⇒ `Core::Response`

Calls the DescribePermissions API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :iam_user_arn - (String) The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.
- :stack_id - (String) The stack ID.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :permissions - (Array
  )
  - :stack_id - (String)
  - :iam_user_arn - (String)
  - :allow_ssh - (Boolean)
  - :allow_sudo - (Boolean)
  - :level - (String)

#describe_raid_arrays(options = {}) ⇒ `Core::Response`

Calls the DescribeRaidArrays API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - (String) The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.
- :stack_id - (String) The stack ID.
- :raid_array_ids - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :raid_arrays - (Array
  )
  - :raid_array_id - (String)
  - :instance_id - (String)
  - :name - (String)
  - :raid_level - (Integer)
  - :number_of_disks - (Integer)
  - :size - (Integer)
  - :device - (String)
  - :mount_point - (String)
  - :availability_zone - (String)
  - :created_at - (String)
  - :stack_id - (String)
  - :volume_type - (String)
  - :iops - (Integer)

#describe_rds_db_instances(options = {}) ⇒ `Core::Response`

Calls the DescribeRdsDbInstances API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.
- :rds_db_instance_arns - (Array<) An array containing the ARNs of the instances to be described.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :rds_db_instances - (Array
  )
  - :rds_db_instance_arn - (String)
  - :db_instance_identifier - (String)
  - :db_user - (String)
  - :db_password - (String)
  - :region - (String)
  - :address - (String)
  - :engine - (String)
  - :stack_id - (String)
  - :missing_on_rds - (Boolean)

#describe_service_errors(options = {}) ⇒ `Core::Response`

Calls the DescribeServiceErrors API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - (String) The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.
- :instance_id - (String) The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.
- :service_error_ids - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :service_errors - (Array
  )
  - :service_error_id - (String)
  - :stack_id - (String)
  - :instance_id - (String)
  - :type - (String)
  - :message - (String)
  - :created_at - (String)

#describe_stack_provisioning_parameters(options = {}) ⇒ `Core::Response`

Calls the DescribeStackProvisioningParameters API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :agent_installer_url - (String)
- :parameters - (Hash<String,String>)

#describe_stack_summary(options = {}) ⇒ `Core::Response`

Calls the DescribeStackSummary API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :stack_summary - (Hash)
  - :stack_id - (String)
  - :name - (String)
  - :arn - (String)
  - :layers_count - (Integer)
  - :apps_count - (Integer)
  - :instances_count - (Hash)
    - :assigning - (Integer)
    - :booting - (Integer)
    - :connection_lost - (Integer)
    - :deregistering - (Integer)
    - :online - (Integer)
    - :pending - (Integer)
    - :rebooting - (Integer)
    - :registered - (Integer)
    - :registering - (Integer)
    - :requested - (Integer)
    - :running_setup - (Integer)
    - :setup_failed - (Integer)
    - :shutting_down - (Integer)
    - :start_failed - (Integer)
    - :stopped - (Integer)
    - :stopping - (Integer)
    - :terminated - (Integer)
    - :terminating - (Integer)
    - :unassigning - (Integer)

#describe_stacks(options = {}) ⇒ `Core::Response`

Calls the DescribeStacks API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_ids - (Array<) An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :stacks - (Array
  )
  - :stack_id - (String)
  - :name - (String)
  - :arn - (String)
  - :region - (String)
  - :vpc_id - (String)
  - :attributes - (Hash<String,String>)
  - :service_role_arn - (String)
  - :default_instance_profile_arn - (String)
  - :default_os - (String)
  - :hostname_theme - (String)
  - :default_availability_zone - (String)
  - :default_subnet_id - (String)
  - :custom_json - (String)
  - :configuration_manager - (Hash)
    
    :name - (String)
    
    :version - (String)
  - :chef_configuration - (Hash)
    
    :manage_berkshelf - (Boolean)
    
    :berkshelf_version - (String)
  - :use_custom_cookbooks - (Boolean)
  - :use_opsworks_security_groups - (Boolean)
  - :custom_cookbooks_source - (Hash)
    
    :type - (String)
    
    :url - (String)
    
    :username - (String)
    
    :password - (String)
    
    :ssh_key - (String)
    
    :revision - (String)
  - :default_ssh_key_name - (String)
  - :created_at - (String)
  - :default_root_device_type - (String)
  - :agent_version - (String)

#describe_time_based_auto_scaling(options = {}) ⇒ `Core::Response`

Calls the DescribeTimeBasedAutoScaling API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_ids - required - (Array<) An array of instance IDs.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :time_based_auto_scaling_configurations - (Array
  )
  - :instance_id - (String)
  - :auto_scaling_schedule - (Hash)
    
    :monday - (Hash<String,String>)
    
    :tuesday - (Hash<String,String>)
    
    :wednesday - (Hash<String,String>)
    
    :thursday - (Hash<String,String>)
    
    :friday - (Hash<String,String>)
    
    :saturday - (Hash<String,String>)
    
    :sunday - (Hash<String,String>)

#describe_user_profiles(options = {}) ⇒ `Core::Response`

Calls the DescribeUserProfiles API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :iam_user_arns - (Array<) An array of IAM user ARNs that identify the users to be described.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :user_profiles - (Array
  )
  - :iam_user_arn - (String)
  - :name - (String)
  - :ssh_username - (String)
  - :ssh_public_key - (String)
  - :allow_self_management - (Boolean)

#describe_volumes(options = {}) ⇒ `Core::Response`

Calls the DescribeVolumes API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - (String) The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.
- :stack_id - (String) A stack ID. The action describes the stack's registered Amazon EBS volumes.
- :raid_array_id - (String) The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.
- :volume_ids - (Array<) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :volumes - (Array
  )
  - :volume_id - (String)
  - :ec2_volume_id - (String)
  - :name - (String)
  - :raid_array_id - (String)
  - :instance_id - (String)
  - :status - (String)
  - :size - (Integer)
  - :device - (String)
  - :mount_point - (String)
  - :region - (String)
  - :availability_zone - (String)
  - :volume_type - (String)
  - :iops - (Integer)

#detach_elastic_load_balancer(options = {}) ⇒ `Core::Response`

Calls the DetachElasticLoadBalancer API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :elastic_load_balancer_name - required - (String) The Elastic Load Balancing instance's name.
- :layer_id - required - (String) The ID of the layer that the Elastic Load Balancing instance is attached to.

Returns:

(Core::Response)

#disassociate_elastic_ip(options = {}) ⇒ `Core::Response`

Calls the DisassociateElasticIp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :elastic_ip - required - (String) The Elastic IP address.

Returns:

(Core::Response)

#get_hostname_suggestion(options = {}) ⇒ `Core::Response`

Calls the GetHostnameSuggestion API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :layer_id - required - (String) The layer ID.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :layer_id - (String)
- :hostname - (String)

#grant_access(options = {}) ⇒ `Core::Response`

Calls the GrantAccess API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance's AWS OpsWorks ID.
- :valid_for_in_minutes - (Integer) 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.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :temporary_credential - (Hash)
  - :username - (String)
  - :password - (String)
  - :valid_for_in_minutes - (Integer)
  - :instance_id - (String)

#reboot_instance(options = {}) ⇒ `Core::Response`

Calls the RebootInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.

Returns:

(Core::Response)

#register_elastic_ip(options = {}) ⇒ `Core::Response`

Calls the RegisterElasticIp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :elastic_ip - required - (String) The Elastic IP address.
- :stack_id - required - (String) The stack ID.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :elastic_ip - (String)

#register_instance(options = {}) ⇒ `Core::Response`

Calls the RegisterInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The ID of the stack that the instance is to be registered with.
- :hostname - (String) The instance's hostname.
- :public_ip - (String) The instance's public IP address.
- :private_ip - (String) The instance's private IP address.
- :rsa_public_key - (String) The instances public RSA key. This key is used to encrypt communication between the instance and the service.
- :rsa_public_key_fingerprint - (String) The instances public RSA key fingerprint.
- :instance_identity - (Hash) An InstanceIdentity object that contains the instance's identity.
  - :document - (String) A JSON document that contains the metadata.
  - :signature - (String) A signature that can be used to verify the document's accuracy and authenticity.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :instance_id - (String)

#register_rds_db_instance(options = {}) ⇒ `Core::Response`

Calls the RegisterRdsDbInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.
- :rds_db_instance_arn - required - (String) The Amazon RDS instance's ARN.
- :db_user - required - (String) The database's master user name.
- :db_password - required - (String) The database password.

Returns:

(Core::Response)

#register_volume(options = {}) ⇒ `Core::Response`

Calls the RegisterVolume API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :ec2_volume_id - (String) The Amazon EBS volume ID.
- :stack_id - required - (String) The stack ID.

Returns:

(Core::Response) —
The #data method of the response object returns a hash with the following structure:
- :volume_id - (String)

#set_load_based_auto_scaling(options = {}) ⇒ `Core::Response`

Calls the SetLoadBasedAutoScaling API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :layer_id - required - (String) The layer ID.
- :enable - (Boolean) Enables load-based auto scaling for the layer.
- :up_scaling - (Hash) An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.
  - :instance_count - (Integer) The number of instances to add or remove when the load exceeds a threshold.
  - :thresholds_wait_time - (Integer) The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
  - :ignore_metrics_time - (Integer) The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks 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 to suppress scaling events long enough to get the new instances online.
  - :cpu_threshold - (Float) The CPU utilization threshold, as a percent of the available CPU.
  - :memory_threshold - (Float) The memory utilization threshold, as a percent of the available memory.
  - :load_threshold - (Float) The load threshold. For more information about how load is computed, see Load (computing).
  - :alarms - (Array<) 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 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 to Act on Your Behalf.
- :down_scaling - (Hash) An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.
  - :instance_count - (Integer) The number of instances to add or remove when the load exceeds a threshold.
  - :thresholds_wait_time - (Integer) The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
  - :ignore_metrics_time - (Integer) The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks 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 to suppress scaling events long enough to get the new instances online.
  - :cpu_threshold - (Float) The CPU utilization threshold, as a percent of the available CPU.
  - :memory_threshold - (Float) The memory utilization threshold, as a percent of the available memory.
  - :load_threshold - (Float) The load threshold. For more information about how load is computed, see Load (computing).
  - :alarms - (Array<) 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 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 to Act on Your Behalf.

Returns:

(Core::Response)

#set_permission(options = {}) ⇒ `Core::Response`

Calls the SetPermission API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.
- :iam_user_arn - required - (String) The user's IAM ARN.
- :allow_ssh - (Boolean) The user is allowed to use SSH to communicate with the instance.
- :allow_sudo - (Boolean) The user is allowed to use sudo to elevate privileges.
- :level - (String) 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 on the permissions associated with these levels, see Managing User Permissions.

Returns:

(Core::Response)

#set_time_based_auto_scaling(options = {}) ⇒ `Core::Response`

Calls the SetTimeBasedAutoScaling API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.
- :auto_scaling_schedule - (Hash) An AutoScalingSchedule with the instance schedule.
  - :monday - (Hash<<String,String>) The schedule for Monday.
  - :tuesday - (Hash<<String,String>) The schedule for Tuesday.
  - :wednesday - (Hash<<String,String>) The schedule for Wednesday.
  - :thursday - (Hash<<String,String>) The schedule for Thursday.
  - :friday - (Hash<<String,String>) The schedule for Friday.
  - :saturday - (Hash<<String,String>) The schedule for Saturday.
  - :sunday - (Hash<<String,String>) The schedule for Sunday.

Returns:

(Core::Response)

#start_instance(options = {}) ⇒ `Core::Response`

Calls the StartInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.

Returns:

(Core::Response)

#start_stack(options = {}) ⇒ `Core::Response`

Calls the StartStack API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.

Returns:

(Core::Response)

#stop_instance(options = {}) ⇒ `Core::Response`

Calls the StopInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.

Returns:

(Core::Response)

#stop_stack(options = {}) ⇒ `Core::Response`

Calls the StopStack API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.

Returns:

(Core::Response)

#unassign_instance(options = {}) ⇒ `Core::Response`

Calls the UnassignInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.

Returns:

(Core::Response)

#unassign_volume(options = {}) ⇒ `Core::Response`

Calls the UnassignVolume API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :volume_id - required - (String) The volume ID.

Returns:

(Core::Response)

#update_app(options = {}) ⇒ `Core::Response`

Calls the UpdateApp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :app_id - required - (String) The app ID.
- :name - (String) The app name.
- :description - (String) A description of the app.
- :data_sources - (Array<
  ) The app's data sources.
  - :type - (String) The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.
  - :arn - (String) The data source's ARN.
  - :database_name - (String) The database name.
- :type - (String) The app type. Valid values include:
  - java
  - rails
  - php
  - nodejs
  - static
  - other
- :app_source - (Hash) A Source object that specifies the app repository.
  - :type - (String) The repository type. Valid values include:
    - git
    - svn
    - archive
    - s3
  - :url - (String) The source URL.
  - :username - (String) 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.
  - :password - (String) 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 . In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :ssh_key - (String) In requests, the repository's SSH key. In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :revision - (String) The application's version. AWS OpsWorks 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.
- :domains - (Array<) The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
- :enable_ssl - (Boolean) Whether SSL is enabled for the app.
- :ssl_configuration - (Hash) An SslConfiguration object with the SSL configuration.
  - :certificate - required - (String) The contents of the certificate's domain.crt file.
  - :private_key - required - (String) The private key; the contents of the certificate's domain.kex file.
  - :chain - (String) Optional. Can be used to specify an intermediate certificate authority key or client authentication.
- :attributes - (Hash<<String,String>) One or more user-defined key/value pairs to be added to the stack attributes.
- :environment - (Array<
  ) 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 10 KB (10240 Bytes). 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 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.
  - :key - required - (String) (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.
  - :value - required - (String) (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.
  - :secure - (Boolean) (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 .

Returns:

(Core::Response)

#update_elastic_ip(options = {}) ⇒ `Core::Response`

Calls the UpdateElasticIp API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :elastic_ip - required - (String) The address.
- :name - (String) The new name.

Returns:

(Core::Response)

#update_instance(options = {}) ⇒ `Core::Response`

Calls the UpdateInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :instance_id - required - (String) The instance ID.
- :layer_ids - (Array<) The instance's layer IDs.
- :instance_type - (String) 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.
- :auto_scaling_type - (String) For load-based or time-based instances, the type. Windows stacks can use only time-based instances. Valid values include:
  - load
  - timer
- :hostname - (String) The instance host name.
- :os - (String) 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 2015.03, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. Microsoft Windows Server 2012 R2 Base. A custom AMI: Custom. For more information on the supported operating systems, see AWS OpsWorks 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 on the supported operating systems, see Operating Systems. For more information on 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.
- :ami_id - (String) A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances If you specify a custom AMI, you must set Os to Custom.
- :ssh_key_name - (String) The instance's Amazon EC2 key name.
- :architecture - (String) 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. Valid values include:
  - x86_64
  - i386
- :install_updates_on_boot - (Boolean) 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.
- :ebs_optimized - (Boolean) This property cannot be updated.
- :agent_version - (String) The default AWS OpsWorks 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 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.

Returns:

(Core::Response)

#update_layer(options = {}) ⇒ `Core::Response`

Calls the UpdateLayer API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :layer_id - required - (String) The layer ID.
- :name - (String) The layer name, which is used by the console.
- :shortname - (String) For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorksand 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. For more information, see the Layer Reference
- :attributes - (Hash<<String,String>) One or more user-defined key/value pairs to be added to the stack attributes.
- :custom_instance_profile_arn - (String) 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.
- :custom_security_group_ids - (Array<) An array containing the layer's custom security group IDs.
- :packages - (Array<) An array of Package objects that describe the layer's packages.
- :volume_configurations - (Array<
  ) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
  - :mount_point - required - (String) The volume mount point. For example "/dev/sdh".
  - :raid_level - (Integer) The volume RAID level.
  - :number_of_disks - required - (Integer) The number of disks in the volume.
  - :size - required - (Integer) The volume size.
  - :volume_type - (String) The volume type: standard - Magnetic io1 - Provisioned IOPS (SSD) gp2 - General Purpose (SSD)
  - :iops - (Integer) For PIOPS volumes, the IOPS per disk.
- :enable_auto_healing - (Boolean) Whether to disable auto healing for the layer.
- :auto_assign_elastic_ips - (Boolean) Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
- :auto_assign_public_ips - (Boolean) 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.
- :custom_recipes - (Hash) A LayerCustomRecipes object that specifies the layer's custom recipes.
  - :setup - (Array<) An array of custom recipe names to be run following a setup event.
  - :configure - (Array<) An array of custom recipe names to be run following a configure event.
  - :deploy - (Array<) An array of custom recipe names to be run following a deploy event.
  - :undeploy - (Array<) An array of custom recipe names to be run following a undeploy event.
  - :shutdown - (Array<) An array of custom recipe names to be run following a shutdown event.
- :install_updates_on_boot - (Boolean) 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.
- :use_ebs_optimized_instances - (Boolean) Whether to use Amazon EBS-optimized instances.
- :lifecycle_event_configuration - (Hash)
  - :shutdown - (Hash) A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
    - :execution_timeout - (Integer) The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
    - :delay_until_elb_connections_drained - (Boolean) Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

Returns:

(Core::Response)

#update_my_user_profile(options = {}) ⇒ `Core::Response`

Calls the UpdateMyUserProfile API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :ssh_public_key - (String) The user's SSH public key.

Returns:

(Core::Response)

#update_rds_db_instance(options = {}) ⇒ `Core::Response`

Calls the UpdateRdsDbInstance API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :rds_db_instance_arn - required - (String) The Amazon RDS instance's ARN.
- :db_user - (String) The master user name.
- :db_password - (String) The database password.

Returns:

(Core::Response)

#update_stack(options = {}) ⇒ `Core::Response`

Calls the UpdateStack API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :stack_id - required - (String) The stack ID.
- :name - (String) The stack's new name.
- :attributes - (Hash<<String,String>) One or more user-defined key-value pairs to be added to the stack attributes.
- :service_role_arn - (String) The stack IAM role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the ARN for an existing IAM role. For more information about IAM ARNs, see Using Identifiers. There is no default value. You must set this parameter to a valid service role ARN or the action will fail. You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.
- :default_instance_profile_arn - (String) 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.
- :default_os - (String) 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 2015.03, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. Microsoft Windows Server 2012 R2 Base. A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs. The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
- :hostname_theme - (String) 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 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.
- :default_availability_zone - (String) 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.
- :default_subnet_id - (String) 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.
- :custom_json - (String) 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 and escape characters such as '"': "\"value1\", \"key2\": \"value2\",..." For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- :configuration_manager - (Hash) The configuration manager. When you clone a stack, we recommend that you use the configuration manager to specify the Chef version: 0.9, 11.4, or 11.10. The default value is currently 11.4.
  - :name - (String) The name. This parameter must be set to "Chef".
  - :version - (String) The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
- :chef_configuration - (Hash) 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.
  - :manage_berkshelf - (Boolean) Whether to enable Berkshelf.
  - :berkshelf_version - (String) The Berkshelf version.
- :use_custom_cookbooks - (Boolean) Whether the stack uses custom cookbooks.
- :custom_cookbooks_source - (Hash)
  - :type - (String) The repository type. Valid values include:
    - git
    - svn
    - archive
    - s3
  - :url - (String) The source URL.
  - :username - (String) 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.
  - :password - (String) 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 . In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :ssh_key - (String) In requests, the repository's SSH key. In responses, AWS OpsWorks returns FILTERED instead of the actual value.
  - :revision - (String) The application's version. AWS OpsWorks 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.
- :default_ssh_key_name - (String) 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.
- :default_root_device_type - (String) 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. Valid values include:
  - ebs
  - instance-store
- :use_opsworks_security_groups - (Boolean) Whether to associate the AWS OpsWorks built-in security groups with the stack's layers. AWS OpsWorks 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 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 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.
- :agent_version - (String) The default AWS OpsWorks agent version. You have the following options: Auto-update - Set this parameter to LATEST. AWS OpsWorks 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 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. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

Returns:

(Core::Response)

#update_user_profile(options = {}) ⇒ `Core::Response`

Calls the UpdateUserProfile API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :iam_user_arn - required - (String) The user IAM ARN.
- :ssh_username - (String) 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 removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
- :ssh_public_key - (String) The user's new SSH public key.
- :allow_self_management - (Boolean) Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

Returns:

(Core::Response)

#update_volume(options = {}) ⇒ `Core::Response`

Calls the UpdateVolume API operation.

Parameters:

options (Hash) (defaults to: {}) —
- :volume_id - required - (String) The volume ID.
- :name - (String) The new name.
- :mount_point - (String) The new mount point.

Returns:

(Core::Response)

Class: AWS::OpsWorks::Client::V20130218

Constant Summary

Constant Summary

Constants inherited from AWS::OpsWorks::Client

Instance Attribute Summary

Attributes inherited from Core::Client

Instance Method Summary collapse

Methods inherited from Core::Client

Constructor Details

Instance Method Details

#assign_instance(options = {}) ⇒ Core::Response

#assign_volume(options = {}) ⇒ Core::Response

#associate_elastic_ip(options = {}) ⇒ Core::Response

#attach_elastic_load_balancer(options = {}) ⇒ Core::Response

#clone_stack(options = {}) ⇒ Core::Response

#create_app(options = {}) ⇒ Core::Response

#create_deployment(options = {}) ⇒ Core::Response

#create_instance(options = {}) ⇒ Core::Response

#create_layer(options = {}) ⇒ Core::Response

#create_stack(options = {}) ⇒ Core::Response

#create_user_profile(options = {}) ⇒ Core::Response

#delete_app(options = {}) ⇒ Core::Response

#delete_instance(options = {}) ⇒ Core::Response

#delete_layer(options = {}) ⇒ Core::Response

#delete_stack(options = {}) ⇒ Core::Response

#delete_user_profile(options = {}) ⇒ Core::Response

#deregister_elastic_ip(options = {}) ⇒ Core::Response

#deregister_instance(options = {}) ⇒ Core::Response

#deregister_rds_db_instance(options = {}) ⇒ Core::Response

#deregister_volume(options = {}) ⇒ Core::Response

#describe_agent_versions(options = {}) ⇒ Core::Response

#describe_apps(options = {}) ⇒ Core::Response

#describe_commands(options = {}) ⇒ Core::Response

#describe_deployments(options = {}) ⇒ Core::Response

#describe_elastic_ips(options = {}) ⇒ Core::Response

#describe_elastic_load_balancers(options = {}) ⇒ Core::Response

#describe_instances(options = {}) ⇒ Core::Response

#describe_layers(options = {}) ⇒ Core::Response

#describe_load_based_auto_scaling(options = {}) ⇒ Core::Response

#describe_my_user_profile(options = {}) ⇒ Core::Response

#describe_permissions(options = {}) ⇒ Core::Response

#describe_raid_arrays(options = {}) ⇒ Core::Response

#describe_rds_db_instances(options = {}) ⇒ Core::Response

#describe_service_errors(options = {}) ⇒ Core::Response

#describe_stack_provisioning_parameters(options = {}) ⇒ Core::Response

#describe_stack_summary(options = {}) ⇒ Core::Response

#describe_stacks(options = {}) ⇒ Core::Response

#describe_time_based_auto_scaling(options = {}) ⇒ Core::Response

#describe_user_profiles(options = {}) ⇒ Core::Response

#describe_volumes(options = {}) ⇒ Core::Response

#detach_elastic_load_balancer(options = {}) ⇒ Core::Response

#disassociate_elastic_ip(options = {}) ⇒ Core::Response

#get_hostname_suggestion(options = {}) ⇒ Core::Response

#grant_access(options = {}) ⇒ Core::Response

#reboot_instance(options = {}) ⇒ Core::Response

#register_elastic_ip(options = {}) ⇒ Core::Response

#register_instance(options = {}) ⇒ Core::Response

#register_rds_db_instance(options = {}) ⇒ Core::Response

#register_volume(options = {}) ⇒ Core::Response

#set_load_based_auto_scaling(options = {}) ⇒ Core::Response

#set_permission(options = {}) ⇒ Core::Response

#set_time_based_auto_scaling(options = {}) ⇒ Core::Response

#start_instance(options = {}) ⇒ Core::Response

#start_stack(options = {}) ⇒ Core::Response

#stop_instance(options = {}) ⇒ Core::Response

#stop_stack(options = {}) ⇒ Core::Response

#unassign_instance(options = {}) ⇒ Core::Response

#unassign_volume(options = {}) ⇒ Core::Response

#update_app(options = {}) ⇒ Core::Response

#update_elastic_ip(options = {}) ⇒ Core::Response

#update_instance(options = {}) ⇒ Core::Response

#update_layer(options = {}) ⇒ Core::Response

#update_my_user_profile(options = {}) ⇒ Core::Response

#update_rds_db_instance(options = {}) ⇒ Core::Response

#update_stack(options = {}) ⇒ Core::Response

#update_user_profile(options = {}) ⇒ Core::Response

#update_volume(options = {}) ⇒ Core::Response

#assign_instance(options = {}) ⇒ `Core::Response`

#assign_volume(options = {}) ⇒ `Core::Response`

#associate_elastic_ip(options = {}) ⇒ `Core::Response`

#attach_elastic_load_balancer(options = {}) ⇒ `Core::Response`

#clone_stack(options = {}) ⇒ `Core::Response`

#create_app(options = {}) ⇒ `Core::Response`

#create_deployment(options = {}) ⇒ `Core::Response`

#create_instance(options = {}) ⇒ `Core::Response`

#create_layer(options = {}) ⇒ `Core::Response`

#create_stack(options = {}) ⇒ `Core::Response`

#create_user_profile(options = {}) ⇒ `Core::Response`

#delete_app(options = {}) ⇒ `Core::Response`

#delete_instance(options = {}) ⇒ `Core::Response`

#delete_layer(options = {}) ⇒ `Core::Response`

#delete_stack(options = {}) ⇒ `Core::Response`

#delete_user_profile(options = {}) ⇒ `Core::Response`

#deregister_elastic_ip(options = {}) ⇒ `Core::Response`

#deregister_instance(options = {}) ⇒ `Core::Response`

#deregister_rds_db_instance(options = {}) ⇒ `Core::Response`

#deregister_volume(options = {}) ⇒ `Core::Response`

#describe_agent_versions(options = {}) ⇒ `Core::Response`

#describe_apps(options = {}) ⇒ `Core::Response`

#describe_commands(options = {}) ⇒ `Core::Response`

#describe_deployments(options = {}) ⇒ `Core::Response`

#describe_elastic_ips(options = {}) ⇒ `Core::Response`

#describe_elastic_load_balancers(options = {}) ⇒ `Core::Response`

#describe_instances(options = {}) ⇒ `Core::Response`

#describe_layers(options = {}) ⇒ `Core::Response`

#describe_load_based_auto_scaling(options = {}) ⇒ `Core::Response`

#describe_my_user_profile(options = {}) ⇒ `Core::Response`

#describe_permissions(options = {}) ⇒ `Core::Response`

#describe_raid_arrays(options = {}) ⇒ `Core::Response`

#describe_rds_db_instances(options = {}) ⇒ `Core::Response`

#describe_service_errors(options = {}) ⇒ `Core::Response`

#describe_stack_provisioning_parameters(options = {}) ⇒ `Core::Response`

#describe_stack_summary(options = {}) ⇒ `Core::Response`

#describe_stacks(options = {}) ⇒ `Core::Response`

#describe_time_based_auto_scaling(options = {}) ⇒ `Core::Response`

#describe_user_profiles(options = {}) ⇒ `Core::Response`

#describe_volumes(options = {}) ⇒ `Core::Response`

#detach_elastic_load_balancer(options = {}) ⇒ `Core::Response`

#disassociate_elastic_ip(options = {}) ⇒ `Core::Response`

#get_hostname_suggestion(options = {}) ⇒ `Core::Response`

#grant_access(options = {}) ⇒ `Core::Response`

#reboot_instance(options = {}) ⇒ `Core::Response`

#register_elastic_ip(options = {}) ⇒ `Core::Response`

#register_instance(options = {}) ⇒ `Core::Response`

#register_rds_db_instance(options = {}) ⇒ `Core::Response`

#register_volume(options = {}) ⇒ `Core::Response`

#set_load_based_auto_scaling(options = {}) ⇒ `Core::Response`

#set_permission(options = {}) ⇒ `Core::Response`

#set_time_based_auto_scaling(options = {}) ⇒ `Core::Response`

#start_instance(options = {}) ⇒ `Core::Response`

#start_stack(options = {}) ⇒ `Core::Response`

#stop_instance(options = {}) ⇒ `Core::Response`

#stop_stack(options = {}) ⇒ `Core::Response`

#unassign_instance(options = {}) ⇒ `Core::Response`

#unassign_volume(options = {}) ⇒ `Core::Response`

#update_app(options = {}) ⇒ `Core::Response`

#update_elastic_ip(options = {}) ⇒ `Core::Response`

#update_instance(options = {}) ⇒ `Core::Response`

#update_layer(options = {}) ⇒ `Core::Response`

#update_my_user_profile(options = {}) ⇒ `Core::Response`

#update_rds_db_instance(options = {}) ⇒ `Core::Response`

#update_stack(options = {}) ⇒ `Core::Response`

#update_user_profile(options = {}) ⇒ `Core::Response`

#update_volume(options = {}) ⇒ `Core::Response`