Class: AWS.OpsWorks
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.OpsWorks
- Identifier:
- opsworks
- API Version:
- 2013-02-18
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
-
opsworks.us-east-1.amazonaws.com
-
opsworks.us-east-2.amazonaws.com
-
opsworks.us-west-1.amazonaws.com
-
opsworks.us-west-2.amazonaws.com
-
opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)
-
opsworks.eu-west-1.amazonaws.com
-
opsworks.eu-west-2.amazonaws.com
-
opsworks.eu-west-3.amazonaws.com
-
opsworks.eu-central-1.amazonaws.com
-
opsworks.ap-northeast-1.amazonaws.com
-
opsworks.ap-northeast-2.amazonaws.com
-
opsworks.ap-south-1.amazonaws.com
-
opsworks.ap-southeast-1.amazonaws.com
-
opsworks.ap-southeast-2.amazonaws.com
-
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager
parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
Sending a Request Using OpsWorks
var opsworks = new AWS.OpsWorks();
opsworks.assignInstance(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the OpsWorks object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var opsworks = new AWS.OpsWorks({apiVersion: '2013-02-18'});
You can also set the API version globally in AWS.config.apiVersions
using
the opsworks service identifier:
AWS.config.apiVersions = {
opsworks: '2013-02-18',
// other service API versions
};
var opsworks = new AWS.OpsWorks();
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
appExists, deploymentSuccessful, instanceOnline, instanceRegistered, instanceStopped, instanceTerminated
Constructor Summary
-
new AWS.OpsWorks(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary
-
assignInstance(params = {}, callback) ⇒ AWS.Request
Assign a registered instance to a layer.
-
assignVolume(params = {}, callback) ⇒ AWS.Request
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
-
associateElasticIp(params = {}, callback) ⇒ AWS.Request
Associates one of the stack's registered Elastic IP addresses with a specified instance.
-
attachElasticLoadBalancer(params = {}, callback) ⇒ AWS.Request
Attaches an Elastic Load Balancing load balancer to a specified layer.
-
cloneStack(params = {}, callback) ⇒ AWS.Request
Creates a clone of a specified stack.
-
createApp(params = {}, callback) ⇒ AWS.Request
Creates an app for a specified stack.
-
createDeployment(params = {}, callback) ⇒ AWS.Request
Runs deployment or stack commands.
-
createInstance(params = {}, callback) ⇒ AWS.Request
Creates an instance in a specified stack.
-
createLayer(params = {}, callback) ⇒ AWS.Request
Creates a layer.
-
createStack(params = {}, callback) ⇒ AWS.Request
Creates a new stack.
-
createUserProfile(params = {}, callback) ⇒ AWS.Request
Creates a new user profile.
-
deleteApp(params = {}, callback) ⇒ AWS.Request
Deletes a specified app.
-
deleteInstance(params = {}, callback) ⇒ AWS.Request
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
-
deleteLayer(params = {}, callback) ⇒ AWS.Request
Deletes a specified layer.
-
deleteStack(params = {}, callback) ⇒ AWS.Request
Deletes a specified stack.
-
deleteUserProfile(params = {}, callback) ⇒ AWS.Request
Deletes a user profile.
-
deregisterEcsCluster(params = {}, callback) ⇒ AWS.Request
Deregisters a specified Amazon ECS cluster from a stack.
-
deregisterElasticIp(params = {}, callback) ⇒ AWS.Request
Deregisters a specified Elastic IP address.
-
deregisterInstance(params = {}, callback) ⇒ AWS.Request
Deregister a registered Amazon EC2 or on-premises instance.
-
deregisterRdsDbInstance(params = {}, callback) ⇒ AWS.Request
Deregisters an Amazon RDS instance.
-
deregisterVolume(params = {}, callback) ⇒ AWS.Request
Deregisters an Amazon EBS volume.
-
describeAgentVersions(params = {}, callback) ⇒ AWS.Request
Describes the available AWS OpsWorks Stacks agent versions.
-
describeApps(params = {}, callback) ⇒ AWS.Request
Requests a description of a specified set of apps.
-
describeCommands(params = {}, callback) ⇒ AWS.Request
Describes the results of specified commands.
-
describeDeployments(params = {}, callback) ⇒ AWS.Request
Requests a description of a specified set of deployments.
-
describeEcsClusters(params = {}, callback) ⇒ AWS.Request
Describes Amazon ECS clusters that are registered with a stack.
-
describeElasticIps(params = {}, callback) ⇒ AWS.Request
Describes Elastic IP addresses.
-
describeElasticLoadBalancers(params = {}, callback) ⇒ AWS.Request
Describes a stack's Elastic Load Balancing instances.
-
describeInstances(params = {}, callback) ⇒ AWS.Request
Requests a description of a set of instances.
-
describeLayers(params = {}, callback) ⇒ AWS.Request
Requests a description of one or more layers in a specified stack.
-
describeLoadBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Describes load-based auto scaling configurations for specified layers.
-
describeMyUserProfile(params = {}, callback) ⇒ AWS.Request
Describes a user's SSH information.
-
describeOperatingSystems(params = {}, callback) ⇒ AWS.Request
Describes the operating systems that are supported by AWS OpsWorks Stacks.
-
describePermissions(params = {}, callback) ⇒ AWS.Request
Describes the permissions for a specified stack.
-
describeRaidArrays(params = {}, callback) ⇒ AWS.Request
Describe an instance's RAID arrays.
-
describeRdsDbInstances(params = {}, callback) ⇒ AWS.Request
Describes Amazon RDS instances.
-
describeServiceErrors(params = {}, callback) ⇒ AWS.Request
Describes AWS OpsWorks Stacks service errors.
-
describeStackProvisioningParameters(params = {}, callback) ⇒ AWS.Request
Requests a description of a stack's provisioning parameters.
-
describeStacks(params = {}, callback) ⇒ AWS.Request
Requests a description of one or more stacks.
-
describeStackSummary(params = {}, callback) ⇒ AWS.Request
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.
-
describeTimeBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Describes time-based auto scaling configurations for specified instances.
-
describeUserProfiles(params = {}, callback) ⇒ AWS.Request
Describe specified users.
-
describeVolumes(params = {}, callback) ⇒ AWS.Request
Describes an instance's Amazon EBS volumes.
-
detachElasticLoadBalancer(params = {}, callback) ⇒ AWS.Request
Detaches a specified Elastic Load Balancing instance from its layer.
-
disassociateElasticIp(params = {}, callback) ⇒ AWS.Request
Disassociates an Elastic IP address from its instance.
-
getHostnameSuggestion(params = {}, callback) ⇒ AWS.Request
Gets a generated host name for the specified layer, based on the current host name theme.
-
grantAccess(params = {}, callback) ⇒ AWS.Request
Note: This action can be used only with Windows stacks.
-
listTags(params = {}, callback) ⇒ AWS.Request
Returns a list of tags that are applied to the specified stack or layer.
-
rebootInstance(params = {}, callback) ⇒ AWS.Request
Reboots a specified instance.
-
registerEcsCluster(params = {}, callback) ⇒ AWS.Request
Registers a specified Amazon ECS cluster with a stack.
-
registerElasticIp(params = {}, callback) ⇒ AWS.Request
Registers an Elastic IP address with a specified stack.
-
registerInstance(params = {}, callback) ⇒ AWS.Request
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
-
registerRdsDbInstance(params = {}, callback) ⇒ AWS.Request
Registers an Amazon RDS instance with a stack.
-
registerVolume(params = {}, callback) ⇒ AWS.Request
Registers an Amazon EBS volume with a specified stack.
-
setLoadBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Specify the load-based auto scaling configuration for a specified layer.
-
setPermission(params = {}, callback) ⇒ AWS.Request
Specifies a user's permissions.
-
setTimeBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Specify the time-based auto scaling configuration for a specified instance.
-
startInstance(params = {}, callback) ⇒ AWS.Request
Starts a specified instance.
-
startStack(params = {}, callback) ⇒ AWS.Request
Starts a stack's instances.
-
stopInstance(params = {}, callback) ⇒ AWS.Request
Stops a specified instance.
-
stopStack(params = {}, callback) ⇒ AWS.Request
Stops a specified stack.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
-
unassignInstance(params = {}, callback) ⇒ AWS.Request
Unassigns a registered instance from all layers that are using the instance.
-
unassignVolume(params = {}, callback) ⇒ AWS.Request
Unassigns an assigned Amazon EBS volume.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a specified stack or layer.
-
updateApp(params = {}, callback) ⇒ AWS.Request
Updates a specified app.
-
updateElasticIp(params = {}, callback) ⇒ AWS.Request
Updates a registered Elastic IP address's name.
-
updateInstance(params = {}, callback) ⇒ AWS.Request
Updates a specified instance.
-
updateLayer(params = {}, callback) ⇒ AWS.Request
Updates a specified layer.
-
updateMyUserProfile(params = {}, callback) ⇒ AWS.Request
Updates a user's SSH public key.
-
updateRdsDbInstance(params = {}, callback) ⇒ AWS.Request
Updates an Amazon RDS instance.
-
updateStack(params = {}, callback) ⇒ AWS.Request
Updates a specified stack.
-
updateUserProfile(params = {}, callback) ⇒ AWS.Request
Updates a specified user profile.
-
updateVolume(params = {}, callback) ⇒ AWS.Request
Updates an Amazon EBS volume's name or mount point.
-
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given OpsWorks resource.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService
Constructor Details
Property Details
Method Details
assignInstance(params = {}, callback) ⇒ AWS.Request
Assign a registered instance to a layer.
-
You can assign registered on-premises instances to any layer type.
-
You can assign registered Amazon EC2 instances only to custom layers.
-
You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignVolume(params = {}, callback) ⇒ AWS.Request
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume
. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
associateElasticIp(params = {}, callback) ⇒ AWS.Request
Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
attachElasticLoadBalancer(params = {}, callback) ⇒ AWS.Request
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
cloneStack(params = {}, callback) ⇒ AWS.Request
Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
createApp(params = {}, callback) ⇒ AWS.Request
Creates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createDeployment(params = {}, callback) ⇒ AWS.Request
Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createInstance(params = {}, callback) ⇒ AWS.Request
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createLayer(params = {}, callback) ⇒ AWS.Request
Creates a layer. For more information, see How to Create a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createStack(params = {}, callback) ⇒ AWS.Request
Creates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
createUserProfile(params = {}, callback) ⇒ AWS.Request
Creates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
deleteApp(params = {}, callback) ⇒ AWS.Request
Deletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteInstance(params = {}, callback) ⇒ AWS.Request
Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteLayer(params = {}, callback) ⇒ AWS.Request
Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteStack(params = {}, callback) ⇒ AWS.Request
Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteUserProfile(params = {}, callback) ⇒ AWS.Request
Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
deregisterEcsCluster(params = {}, callback) ⇒ AWS.Request
Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterElasticIp(params = {}, callback) ⇒ AWS.Request
Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterInstance(params = {}, callback) ⇒ AWS.Request
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterRdsDbInstance(params = {}, callback) ⇒ AWS.Request
Deregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterVolume(params = {}, callback) ⇒ AWS.Request
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeAgentVersions(params = {}, callback) ⇒ AWS.Request
Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions
returns a list of available agent versions for the specified stack or configuration manager.
describeApps(params = {}, callback) ⇒ AWS.Request
Requests a description of a specified set of apps.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeCommands(params = {}, callback) ⇒ AWS.Request
Describes the results of specified commands.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeDeployments(params = {}, callback) ⇒ AWS.Request
Requests a description of a specified set of deployments.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeEcsClusters(params = {}, callback) ⇒ AWS.Request
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults
and NextToken
parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeElasticIps(params = {}, callback) ⇒ AWS.Request
Describes Elastic IP addresses.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeElasticLoadBalancers(params = {}, callback) ⇒ AWS.Request
Describes a stack's Elastic Load Balancing instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeInstances(params = {}, callback) ⇒ AWS.Request
Requests a description of a set of instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeLayers(params = {}, callback) ⇒ AWS.Request
Requests a description of one or more layers in a specified stack.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeLoadBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Describes load-based auto scaling configurations for specified layers.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeMyUserProfile(params = {}, callback) ⇒ AWS.Request
Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeOperatingSystems(params = {}, callback) ⇒ AWS.Request
Describes the operating systems that are supported by AWS OpsWorks Stacks.
describePermissions(params = {}, callback) ⇒ AWS.Request
Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeRaidArrays(params = {}, callback) ⇒ AWS.Request
Describe an instance's RAID arrays.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeRdsDbInstances(params = {}, callback) ⇒ AWS.Request
Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrors(params = {}, callback) ⇒ AWS.Request
Describes AWS OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeStackProvisioningParameters(params = {}, callback) ⇒ AWS.Request
Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeStacks(params = {}, callback) ⇒ AWS.Request
Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeStackSummary(params = {}, callback) ⇒ AWS.Request
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup
or online
.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeTimeBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Describes time-based auto scaling configurations for specified instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeUserProfiles(params = {}, callback) ⇒ AWS.Request
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeVolumes(params = {}, callback) ⇒ AWS.Request
Describes an instance's Amazon EBS volumes.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
detachElasticLoadBalancer(params = {}, callback) ⇒ AWS.Request
Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
disassociateElasticIp(params = {}, callback) ⇒ AWS.Request
Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
getHostnameSuggestion(params = {}, callback) ⇒ AWS.Request
Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
grantAccess(params = {}, callback) ⇒ AWS.Request
Grants RDP access to a Windows instance for a specified time period.
listTags(params = {}, callback) ⇒ AWS.Request
Returns a list of tags that are applied to the specified stack or layer.
rebootInstance(params = {}, callback) ⇒ AWS.Request
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerEcsCluster(params = {}, callback) ⇒ AWS.Request
Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerElasticIp(params = {}, callback) ⇒ AWS.Request
Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerInstance(params = {}, callback) ⇒ AWS.Request
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
RegisterInstance
handles only the second step. You should instead use the AWS CLI register
command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack. Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerRdsDbInstance(params = {}, callback) ⇒ AWS.Request
Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerVolume(params = {}, callback) ⇒ AWS.Request
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setLoadBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setPermission(params = {}, callback) ⇒ AWS.Request
Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setTimeBasedAutoScaling(params = {}, callback) ⇒ AWS.Request
Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startInstance(params = {}, callback) ⇒ AWS.Request
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startStack(params = {}, callback) ⇒ AWS.Request
Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopInstance(params = {}, callback) ⇒ AWS.Request
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopStack(params = {}, callback) ⇒ AWS.Request
Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
tagResource(params = {}, callback) ⇒ AWS.Request
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
unassignInstance(params = {}, callback) ⇒ AWS.Request
Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
unassignVolume(params = {}, callback) ⇒ AWS.Request
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateApp(params = {}, callback) ⇒ AWS.Request
Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateElasticIp(params = {}, callback) ⇒ AWS.Request
Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateInstance(params = {}, callback) ⇒ AWS.Request
Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateLayer(params = {}, callback) ⇒ AWS.Request
Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateMyUserProfile(params = {}, callback) ⇒ AWS.Request
Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
updateRdsDbInstance(params = {}, callback) ⇒ AWS.Request
Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateStack(params = {}, callback) ⇒ AWS.Request
Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateUserProfile(params = {}, callback) ⇒ AWS.Request
Updates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
updateVolume(params = {}, callback) ⇒ AWS.Request
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given OpsWorks resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.
Waiter Resource Details
opsworks.waitFor('appExists', params = {}, [callback]) ⇒ AWS.Request
Waits for the appExists
state by periodically calling the underlying
OpsWorks.describeApps() operation every 1 seconds
(at most 40 times).
opsworks.waitFor('deploymentSuccessful', params = {}, [callback]) ⇒ AWS.Request
Waits for the deploymentSuccessful
state by periodically calling the underlying
OpsWorks.describeDeployments() operation every 15 seconds
(at most 40 times).
opsworks.waitFor('instanceOnline', params = {}, [callback]) ⇒ AWS.Request
Waits for the instanceOnline
state by periodically calling the underlying
OpsWorks.describeInstances() operation every 15 seconds
(at most 40 times).
opsworks.waitFor('instanceRegistered', params = {}, [callback]) ⇒ AWS.Request
Waits for the instanceRegistered
state by periodically calling the underlying
OpsWorks.describeInstances() operation every 15 seconds
(at most 40 times).
opsworks.waitFor('instanceStopped', params = {}, [callback]) ⇒ AWS.Request
Waits for the instanceStopped
state by periodically calling the underlying
OpsWorks.describeInstances() operation every 15 seconds
(at most 40 times).
opsworks.waitFor('instanceTerminated', params = {}, [callback]) ⇒ AWS.Request
Waits for the instanceTerminated
state by periodically calling the underlying
OpsWorks.describeInstances() operation every 15 seconds
(at most 40 times).