C# (CSharp) Amazon.OpsWorks.Model Namespace

Nested Namespaces

Amazon.OpsWorks.Model.Internal

Сlasses

Name Description
App

A description of the app.

AssignInstanceRequest Container for the parameters to the AssignInstance operation. 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.

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.

AssignVolumeRequest Container for the parameters to the AssignVolume operation. 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.

AssociateElasticIpRequest Container for the parameters to the AssociateElasticIp operation. 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.

AttachElasticLoadBalancerRequest Container for the parameters to the AttachElasticLoadBalancer operation.

Attaches an Elastic Load Balancing instance to a specified layer.

NOTE:You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

AutoScalingThresholds

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks starts or stops load-based instances.

CloneStackRequest Container for the parameters to the CloneStack operation. 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 on user permissions, see Managing User Permissions.

CloneStackResponse Returns information about the CloneStack response and response metadata.
CloneStackResult Contains the response to a CloneStack request.
Command

Describes a command.

CreateAppRequest Container for the parameters to the CreateApp operation. 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.

CreateAppResponse Returns information about the CreateAppResult response and response metadata.
CreateAppResult

Contains the response to a CreateApp request.

CreateDeploymentRequest Container for the parameters to the CreateDeployment operation.

Deploys a stack or app.

  • App deployment generates a deploy event, which runs the associated recipes and passes them a JSON stack configuration object that includes information about the app.
  • Stack deployment runs the deploy recipes but does not raise an event.

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 .

CreateDeploymentResponse Returns information about the CreateDeploymentResult response and response metadata.
CreateDeploymentResult

Contains the response to a CreateDeployment request.

CreateInstanceRequest Container for the parameters to the CreateInstance operation.

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 .

CreateInstanceResponse Returns information about the CreateInstance response and response metadata.
CreateInstanceResult

Contains the response to a CreateInstance request.

CreateLayerRequest Container for the parameters to the CreateLayer operation.

Creates a layer. For more information, see How to Create a Layer .

NOTE:You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

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 .

CreateLayerResponse Returns information about the CreateLayerResult response and response metadata.
CreateLayerResult

Contains the response to a CreateLayer request.

CreateStackRequest Container for the parameters to the CreateStack operation.

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 on user permissions, see Managing User Permissions .

CreateStackResponse Returns information about the CreateStackResult response and response metadata.
CreateStackResult

Contains the response to a CreateStack request.

CreateUserProfileRequest Container for the parameters to the CreateUserProfile operation. 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 on user permissions, see Managing User Permissions.

CreateUserProfileResponse Returns information about the CreateUserProfileResult response and response metadata.
CreateUserProfileResult

Contains the response to a CreateUserProfile request.

DeleteAppRequest Container for the parameters to the DeleteApp operation. 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.

DeleteInstanceRequest Container for the parameters to the DeleteInstance operation. 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.

DeleteLayerRequest Container for the parameters to the DeleteLayer operation.

Deletes a specified layer. You must first stop and then delete all associated 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 .

DeleteStackRequest Container for the parameters to the DeleteStack operation. 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.

DeleteUserProfileRequest Container for the parameters to the DeleteUserProfile operation. 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 on user permissions, see Managing User Permissions.

Deployment

Describes a deployment of a stack or app.

DeploymentCommand Used to specify a stack or deployment command.
DeregisterEcsClusterRequest Container for the parameters to the DeregisterEcsCluster operation. 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.

DeregisterElasticIpRequest Container for the parameters to the DeregisterElasticIp operation. 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.

DeregisterInstanceRequest Container for the parameters to the DeregisterInstance operation. 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 can not be used with instances that were created with AWS OpsWorks.

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.

DeregisterRdsDbInstanceRequest Container for the parameters to the DeregisterRdsDbInstance operation. 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.

DeregisterVolumeRequest Container for the parameters to the DeregisterVolume operation.

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 .

DescribeAppsRequest Container for the parameters to the DescribeApps operation. Requests a description of a specified set of apps.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

DescribeAppsResponse Returns information about the DescribeAppsResult response and response metadata.
DescribeAppsResult

Contains the response to a DescribeApps request.

DescribeCommandsRequest Container for the parameters to the DescribeCommands operation.

Describes the results of specified commands.

NOTE:You must specify at least one of the parameters.

DescribeCommandsResponse Returns information about the DescribeCommands response and response metadata.
DescribeCommandsResult Contains the response to a DescribeCommands request.
DescribeDeploymentsRequest Container for the parameters to the DescribeDeployments operation.

Requests a description of a specified set of deployments.

NOTE:You must specify at least one of the parameters.

DescribeDeploymentsResponse Returns information about the DescribeDeploymentsResult response and response metadata.
DescribeDeploymentsResult Contains the response to a DescribeDeployments request.
DescribeEcsClustersRequest Container for the parameters to the DescribeEcsClusters operation. 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 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 on user permissions, see Managing User Permissions.

DescribeElasticIpsRequest Container for the parameters to the DescribeElasticIps operation.

Describes Elastic IP addresses .

NOTE:You must specify at least one of the 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 on user permissions, see Managing User Permissions .

DescribeElasticIpsResponse Returns information about the DescribeElasticIpsResult response and response metadata.
DescribeElasticIpsResult

Contains the response to a DescribeElasticIps request.

DescribeElasticLoadBalancersRequest Container for the parameters to the DescribeElasticLoadBalancers operation.

Describes a stack's Elastic Load Balancing instances.

NOTE:You must specify at least one of the 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 on user permissions, see Managing User Permissions .

DescribeElasticLoadBalancersResponse Returns information about the DescribeElasticLoadBalancersResult response and response metadata.
DescribeElasticLoadBalancersResult

Contains the response to a DescribeElasticLoadBalancers request.

DescribeInstancesRequest Container for the parameters to the DescribeInstances operation.

Requests a description of a set of instances associated with a specified ID or IDs.

DescribeInstancesResponse Returns information about the DescribeInstances response and response metadata.
DescribeInstancesResult

Contains the response to a DescribeInstances request.

DescribeLayersRequest Container for the parameters to the DescribeLayers operation. Requests a description of one or more layers in a specified stack.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

DescribeLayersResponse Returns information about the DescribeLayers response and response metadata.
DescribeLayersResult Contains the response to a DescribeLayers request.
DescribeLoadBasedAutoScalingRequest Container for the parameters to the DescribeLoadBasedAutoScaling operation.

Describes load-based auto scaling configurations for specified layers.

NOTE:You must specify at least one of the 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 on user permissions, see Managing User Permissions .

DescribeLoadBasedAutoScalingResponse Returns information about the DescribeLoadBasedAutoScaling response and response metadata.
DescribeLoadBasedAutoScalingResult Contains the response to a DescribeLoadBasedAutoScaling request.
DescribeMyUserProfileResponse Returns information about the DescribeMyUserProfile response and response metadata.
DescribeMyUserProfileResult Contains the response to a DescribeMyUserProfile request.
DescribePermissionsRequest Container for the parameters to the DescribePermissions operation.

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 .

DescribePermissionsResponse Contains the response to a DescribePermissions request.
DescribePermissionsResult

Contains the response to a DescribePermissions request.

DescribeRaidArraysRequest Container for the parameters to the DescribeRaidArrays operation. Describe an instance's RAID arrays.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

DescribeRaidArraysResponse Returns information about the DescribeRaidArraysResult response and response metadata.
DescribeRaidArraysResult

Contains the response to a DescribeRaidArrays request.

DescribeRdsDbInstancesRequest Container for the parameters to the DescribeRdsDbInstances operation. 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 on user permissions, see Managing User Permissions.

DescribeServiceErrorsRequest Container for the parameters to the DescribeServiceErrors operation.

Describes AWS OpsWorks 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 on user permissions, see Managing User Permissions .

DescribeServiceErrorsResponse Contains the response to a DescribeServiceErrors request.
DescribeServiceErrorsResult

Contains the response to a DescribeServiceErrors request.

DescribeStackProvisioningParametersRequest Container for the parameters to the DescribeStackProvisioningParameters operation. 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 on user permissions, see Managing User Permissions.

DescribeStackSummaryRequest Container for the parameters to the DescribeStackSummary operation.

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 on user permissions, see Managing User Permissions .

DescribeStackSummaryResponse Returns information about the DescribeStackSummary response and response metadata.
DescribeStackSummaryResult Contains the response to a DescribeStackSummary request.
DescribeStacksRequest Container for the parameters to the DescribeStacks operation. 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 on user permissions, see Managing User Permissions.

DescribeStacksResponse Returns information about the DescribeStacks response and response metadata.
DescribeStacksResult

Contains the response to a DescribeStacks request.

DescribeTimeBasedAutoScalingRequest Container for the parameters to the DescribeTimeBasedAutoScaling operation. Describes time-based auto scaling configurations for specified instances.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

DescribeTimeBasedAutoScalingResponse Contains the response to a DescribeTimeBasedAutoScaling request.
DescribeTimeBasedAutoScalingResult Contains the response to a DescribeTimeBasedAutoScaling request.
DescribeUserProfilesRequest Container for the parameters to the DescribeUserProfiles operation.

Describe specified users.

DescribeUserProfilesResponse Returns information about the DescribeUserProfilesResult response and response metadata.
DescribeUserProfilesResult Contains the response to a DescribeUserProfiles request.
DescribeVolumesRequest Container for the parameters to the DescribeVolumes operation. Describes an instance's Amazon EBS volumes.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

DescribeVolumesResponse Contains the response to a DescribeVolumes request.
DescribeVolumesResult

Contains the response to a DescribeVolumes request.

DetachElasticLoadBalancerRequest Container for the parameters to the DetachElasticLoadBalancer operation. 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.

DisassociateElasticIpRequest Container for the parameters to the DisassociateElasticIp operation.

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 .

ElasticIp Describes an Elastic IP address.
ElasticLoadBalancer

Describes an Elastic Load Balancing instance.

GetHostnameSuggestionRequest Container for the parameters to the GetHostnameSuggestion operation. 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.

GetHostnameSuggestionResponse Returns information about the GetHostnameSuggestion response and response metadata.
GetHostnameSuggestionResult Contains the response to a GetHostnameSuggestion request.
GrantAccessRequest Container for the parameters to the GrantAccess operation.

This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

Instance Describes an instance.
InstanceIdentity Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.
InstancesCount Describes how many instances a stack has for each status.
Layer Describes a layer.
LoadBasedAutoScalingConfiguration

Describes a layer's load-based auto scaling configuration.

Permission Describes stack or user permissions.
RaidArray

Describes an instance's RAID array.

RebootInstanceRequest Container for the parameters to the RebootInstance operation. 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.

Recipes AWS OpsWorks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

RegisterEcsClusterRequest Container for the parameters to the RegisterEcsCluster operation. 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.

RegisterElasticIpRequest Container for the parameters to the RegisterElasticIp operation. 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.

RegisterElasticIpResponse Returns information about the RegisterElasticIp response and response metadata.
RegisterElasticIpResult Contains the response to a RegisterElasticIp request.
RegisterInstanceRequest Container for the parameters to the RegisterInstance operation. Registers instances with a specified stack that were created outside of AWS OpsWorks.

We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the 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 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.

RegisterRdsDbInstanceRequest Container for the parameters to the RegisterRdsDbInstance operation. 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.

RegisterVolumeRequest Container for the parameters to the RegisterVolume operation. 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.

RegisterVolumeResponse Returns information about the RegisterVolume response and response metadata.
RegisterVolumeResult Contains the response to a RegisterVolume request.
ResourceNotFoundException
SelfUserProfile

Describes a user's SSH information.

ServiceError

Describes an OpsWorks service error.

SetLoadBasedAutoScalingRequest Container for the parameters to the SetLoadBasedAutoScaling operation. Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

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.

SetPermissionRequest Container for the parameters to the SetPermission operation. 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.

SetTimeBasedAutoScalingRequest Container for the parameters to the SetTimeBasedAutoScaling operation.

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 .

ShutdownEventConfiguration The Shutdown event configuration.
Source

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks .

SslConfiguration

Describes an app's SSL configuration.

Stack

Describes a stack.

StackConfigurationManager

Describes the configuration manager.

StackSummary

Summarizes the number of layers, instances, and apps in a stack.

StartInstanceRequest Container for the parameters to the StartInstance operation.

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 .

StartStackRequest Container for the parameters to the StartStack operation. 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.

StopInstanceRequest Container for the parameters to the StopInstance operation.

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 .

StopStackRequest Container for the parameters to the StopStack operation.

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 .

TimeBasedAutoScalingConfiguration Describes an instance's time-based auto scaling configuration.
UnassignInstanceRequest Container for the parameters to the UnassignInstance operation. Unassigns a registered instance from all of it's layers. 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.

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.

UnassignVolumeRequest Container for the parameters to the UnassignVolume operation. 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.

UpdateAppRequest Container for the parameters to the UpdateApp operation. 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.

UpdateElasticIpRequest Container for the parameters to the UpdateElasticIp operation. 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.

UpdateInstanceRequest Container for the parameters to the UpdateInstance operation.

Updates a specified instance.

UpdateLayerRequest Container for the parameters to the UpdateLayer operation.

Updates a specified layer.

UpdateMyUserProfileRequest Container for the parameters to the UpdateMyUserProfile operation. 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 on user permissions, see Managing User Permissions.

UpdateRdsDbInstanceRequest Container for the parameters to the UpdateRdsDbInstance operation. 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.

UpdateStackRequest Container for the parameters to the UpdateStack operation.

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 .

UpdateUserProfileRequest Container for the parameters to the UpdateUserProfile operation. 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 on user permissions, see Managing User Permissions.

UpdateVolumeRequest Container for the parameters to the UpdateVolume operation. 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.

UserProfile

Describes a user's SSH information.

ValidationException
Volume Describes an instance's Amazon EBS volume.
VolumeConfiguration Describes an Amazon EBS volume configuration.
WeeklyAutoScalingSchedule

Describes a time-based instance's Auto Scaling schedule. The schedule consists of a set of key-value pairs.

  • The key is the time period (a UTC hour) and must be an integer from 0 - 23.
  • The value indicates whether the instance should be on line or off line for the specified period, and must be set to "on" or "off"

The default setting for all time periods is off line, so you use the following parameters primarily to specify the on line periods. You don't have to explicitly specify off line periods unless you want to change an on line period to an off line period.

The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.

{ "12":"on", "13":"on", "14":"on", "15":"on" }