AWS SDK for .NET Documentation
Amazon.OpsWorks.Model Namespace
AmazonAmazon.OpsWorks.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.OpsWorks.Model
Types
All TypesClasses
IconTypeDescription
App
A description of the app.

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. 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.


AssignVolumeResponse
Returns information about the AssignVolumeResult response and response metadata.

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.


AssociateElasticIpResponse
Returns information about the AssociateElasticIpResult response and response metadata.

AttachElasticLoadBalancerRequest
Container for the parameters to the AttachElasticLoadBalancer operation. Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.
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.

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.


AttachElasticLoadBalancerResponse
Returns information about the AttachElasticLoadBalancerResult response and response metadata.

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

ChefConfiguration
Describes the Chef configuration.

CloneStackRequest
Container for the parameters to the CloneStack operation. Creates a clone of a specified stack. For more information, see Clone a 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 CloneStackResult response and response metadata.

CloneStackResult
Contains the response to a
CopyC#
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
CopyC#
CreateApp
request.

CreateDeploymentRequest
Container for the parameters to the CreateDeployment operation. Deploys a stack or app.
  • App deployment generates a
    CopyC#
    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
    CopyC#
    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
CopyC#
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 CreateInstanceResult response and response metadata.

CreateInstanceResult
Contains the response to a
CopyC#
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
CopyC#
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
CopyC#
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
CopyC#
CreateUserProfile
request.

DataSource
Describes an app's data source.

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.


DeleteAppResponse
Returns information about the DeleteAppResult response and response metadata.

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


DeleteInstanceResponse
Returns information about the DeleteInstanceResult response and response metadata.

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.


DeleteLayerResponse
Returns information about the DeleteLayerResult response and response metadata.

DeleteStackRequest
Container for the parameters to the DeleteStack operation. Deletes a specified stack. You must first delete all instances, layers, and apps. 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.


DeleteStackResponse
Returns information about the DeleteStackResult response and response metadata.

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.


DeleteUserProfileResponse
Returns information about the DeleteUserProfileResult response and response metadata.

Deployment
Describes a deployment of a stack or app.

DeploymentCommand
Used to specify a deployment operation.

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.


DeregisterElasticIpResponse
Returns information about the DeregisterElasticIpResult response and response metadata.

DeregisterRdsDbInstanceRequest
Container for the parameters to the DeregisterRdsDbInstance operation. Deregisters an Amazon RDS instance.

DeregisterRdsDbInstanceResponse
Returns information about the DeregisterRdsDbInstanceResult response and response metadata.

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.


DeregisterVolumeResponse
Returns information about the DeregisterVolumeResult response and response metadata.

DescribeAppsRequest
Container for the parameters to the DescribeApps operation. Requests a description of a specified set of apps.
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.


DescribeAppsResponse
Returns information about the DescribeAppsResult response and response metadata.

DescribeAppsResult
Contains the response to a
CopyC#
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.

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.


DescribeCommandsResponse
Returns information about the DescribeCommandsResult response and response metadata.

DescribeCommandsResult
Contains the response to a
CopyC#
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.

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.


DescribeDeploymentsResponse
Returns information about the DescribeDeploymentsResult response and response metadata.

DescribeDeploymentsResult
Contains the response to a
CopyC#
DescribeDeployments
request.

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
CopyC#
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
CopyC#
DescribeElasticLoadBalancers
request.

DescribeInstancesRequest
Container for the parameters to the DescribeInstances operation. Requests a description of a set of 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.


DescribeInstancesResponse
Returns information about the DescribeInstancesResult response and response metadata.

DescribeInstancesResult
Contains the response to a
CopyC#
DescribeInstances
request.

DescribeLayersRequest
Container for the parameters to the DescribeLayers operation. Requests a description of one or more layers in a specified stack.
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.


DescribeLayersResponse
Returns information about the DescribeLayersResult response and response metadata.

DescribeLayersResult
Contains the response to a
CopyC#
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 DescribeLoadBasedAutoScalingResult response and response metadata.

DescribeLoadBasedAutoScalingResult
Contains the response to a
CopyC#
DescribeLoadBasedAutoScaling
request.

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


DescribeMyUserProfileResponse
Returns information about the DescribeMyUserProfileResult response and response metadata.

DescribeMyUserProfileResult
Contains the response to a
CopyC#
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
Returns information about the DescribePermissionsResult response and response metadata.

DescribePermissionsResult
Contains the response to a
CopyC#
DescribePermissions
request.

DescribeRaidArraysRequest
Container for the parameters to the DescribeRaidArrays operation. Describe an instance's RAID arrays.
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.


DescribeRaidArraysResponse
Returns information about the DescribeRaidArraysResult response and response metadata.

DescribeRaidArraysResult
Contains the response to a
CopyC#
DescribeRaidArrays
request.

DescribeRdsDbInstancesRequest
Container for the parameters to the DescribeRdsDbInstances operation. Describes Amazon RDS instances.

DescribeRdsDbInstancesResponse
Returns information about the DescribeRdsDbInstancesResult response and response metadata.

DescribeRdsDbInstancesResult
Contains the response to a
CopyC#
DescribeRdsDbInstances
request.

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
Returns information about the DescribeServiceErrorsResult response and response metadata.

DescribeServiceErrorsResult
Contains the response to a
CopyC#
DescribeServiceErrors
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 DescribeStacksResult response and response metadata.

DescribeStacksResult
Contains the response to a
CopyC#
DescribeStacks
request.

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
CopyC#
running_setup
or
CopyC#
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 DescribeStackSummaryResult response and response metadata.

DescribeStackSummaryResult
Contains the response to a
CopyC#
DescribeStackSummary
request.

DescribeTimeBasedAutoScalingRequest
Container for the parameters to the DescribeTimeBasedAutoScaling operation. Describes time-based auto scaling configurations for specified 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.


DescribeTimeBasedAutoScalingResponse
Returns information about the DescribeTimeBasedAutoScalingResult response and response metadata.

DescribeTimeBasedAutoScalingResult
Contains the response to a
CopyC#
DescribeTimeBasedAutoScaling
request.

DescribeUserProfilesRequest
Container for the parameters to the DescribeUserProfiles operation. Describe specified users.

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.


DescribeUserProfilesResponse
Returns information about the DescribeUserProfilesResult response and response metadata.

DescribeUserProfilesResult
Contains the response to a
CopyC#
DescribeUserProfiles
request.

DescribeVolumesRequest
Container for the parameters to the DescribeVolumes operation. Describes an instance's Amazon EBS volumes.
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.


DescribeVolumesResponse
Returns information about the DescribeVolumesResult response and response metadata.

DescribeVolumesResult
Contains the response to a
CopyC#
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.


DetachElasticLoadBalancerResponse
Returns information about the DetachElasticLoadBalancerResult response and response metadata.

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.


DisassociateElasticIpResponse
Returns information about the DisassociateElasticIpResult response and response metadata.

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 GetHostnameSuggestionResult response and response metadata.

GetHostnameSuggestionResult
Contains the response to a
CopyC#
GetHostnameSuggestion
request.

Instance
Describes an instance.

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.

RdsDbInstance
Describes an Amazon RDS instance.

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.


RebootInstanceResponse
Returns information about the RebootInstanceResult response and response metadata.

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.
CopyC#
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.


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 RegisterElasticIpResult response and response metadata.

RegisterElasticIpResult
Contains the response to a
CopyC#
RegisterElasticIp
request.

RegisterRdsDbInstanceRequest
Container for the parameters to the RegisterRdsDbInstance operation. Registers an Amazon RDS instance with a stack.

RegisterRdsDbInstanceResponse
Returns information about the RegisterRdsDbInstanceResult response and response metadata.

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 RegisterVolumeResult response and response metadata.

RegisterVolumeResult
Contains the response to a
CopyC#
RegisterVolume
request.

ResourceNotFoundException
OpsWorks exception

SelfUserProfile
Describes a user's SSH information.

ServiceError
Describes an AWS 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.
Note:

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.


SetLoadBasedAutoScalingResponse
Returns information about the SetLoadBasedAutoScalingResult response and response metadata.

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.


SetPermissionResponse
Returns information about the SetPermissionResult response and response metadata.

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.


SetTimeBasedAutoScalingResponse
Returns information about the SetTimeBasedAutoScalingResult response and response metadata.

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.


StartInstanceResponse
Returns information about the StartInstanceResult response and response metadata.

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.


StartStackResponse
Returns information about the StartStackResult response and response metadata.

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.


StopInstanceResponse
Returns information about the StopInstanceResult response and response metadata.

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.


StopStackResponse
Returns information about the StopStackResult response and response metadata.

TimeBasedAutoScalingConfiguration
Describes an instance's time-based auto scaling configuration.

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.


UnassignVolumeResponse
Returns information about the UnassignVolumeResult response and response metadata.

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.


UpdateAppResponse
Returns information about the UpdateAppResult response and response metadata.

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.


UpdateElasticIpResponse
Returns information about the UpdateElasticIpResult response and response metadata.

UpdateInstanceRequest
Container for the parameters to the UpdateInstance operation. 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.


UpdateInstanceResponse
Returns information about the UpdateInstanceResult response and response metadata.

UpdateLayerRequest
Container for the parameters to the UpdateLayer operation. 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.


UpdateLayerResponse
Returns information about the UpdateLayerResult response and response metadata.

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.


UpdateMyUserProfileResponse
Returns information about the UpdateMyUserProfileResult response and response metadata.

UpdateRdsDbInstanceRequest
Container for the parameters to the UpdateRdsDbInstance operation. Updates an Amazon RDS instance.

UpdateRdsDbInstanceResponse
Returns information about the UpdateRdsDbInstanceResult response and response metadata.

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.


UpdateStackResponse
Returns information about the UpdateStackResult response and response metadata.

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.


UpdateUserProfileResponse
Returns information about the UpdateUserProfileResult response and response metadata.

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.


UpdateVolumeResponse
Returns information about the UpdateVolumeResult response and response metadata.

UserProfile
Describes a user's SSH information.

ValidationException
OpsWorks exception

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 online or offline for the specified period, and must be set to "on" or "off"

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline 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.

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