AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AgentVersion

Describes an agent version.

Class App

A description of the app.

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

Class AssignInstanceResponse

This is the response object from the AssignInstance operation.

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

Class AssignVolumeResponse

This is the response object from the AssignVolume operation.

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

Class AssociateElasticIpResponse

This is the response object from the AssociateElasticIp operation.

Class AttachElasticLoadBalancerRequest

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

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.

Class AttachElasticLoadBalancerResponse

This is the response object from the AttachElasticLoadBalancer operation.

Class AutoScalingThresholds

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

Class BlockDeviceMapping

Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

Class ChefConfiguration

Describes the Chef configuration.

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

Class CloneStackResponse

Contains the response to a CloneStack request.

Class CloudWatchLogsConfiguration

Describes the Amazon CloudWatch logs configuration for a layer.

Class CloudWatchLogsLogStream

Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.

Class Command

Describes a command.

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

Class CreateAppResponse

Contains the response to a CreateApp request.

Class CreateDeploymentRequest

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

Class CreateDeploymentResponse

Contains the response to a CreateDeployment request.

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

Class CreateInstanceResponse

Contains the response to a CreateInstance request.

Class CreateLayerRequest

Container for the parameters to the CreateLayer operation. Creates a layer. For more information, see How to Create a Layer.

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.

Class CreateLayerResponse

Contains the response to a CreateLayer request.

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

Class CreateStackResponse

Contains the response to a CreateStack request.

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

Class CreateUserProfileResponse

Contains the response to a CreateUserProfile request.

Class DataSource

Describes an app's data source.

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

Class DeleteAppResponse

This is the response object from the DeleteApp operation.

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

Class DeleteInstanceResponse

This is the response object from the DeleteInstance operation.

Class DeleteLayerRequest

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

Class DeleteLayerResponse

This is the response object from the DeleteLayer operation.

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

Class DeleteStackResponse

This is the response object from the DeleteStack operation.

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

Class DeleteUserProfileResponse

This is the response object from the DeleteUserProfile operation.

Class Deployment

Describes a deployment of a stack or app.

Class DeploymentCommand

Used to specify a stack or deployment command.

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

Class DeregisterEcsClusterResponse

This is the response object from the DeregisterEcsCluster operation.

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

Class DeregisterElasticIpResponse

This is the response object from the DeregisterElasticIp operation.

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

Class DeregisterInstanceResponse

This is the response object from the DeregisterInstance operation.

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

Class DeregisterRdsDbInstanceResponse

This is the response object from the DeregisterRdsDbInstance operation.

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

Class DeregisterVolumeResponse

This is the response object from the DeregisterVolume operation.

Class DescribeAgentVersionsRequest

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

Class DescribeAgentVersionsResponse

Contains the response to a DescribeAgentVersions request.

Class DescribeAppsRequest

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

This call accepts only one resource-identifying parameter.

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.

Class DescribeAppsResponse

Contains the response to a DescribeApps request.

Class DescribeCommandsRequest

Container for the parameters to the DescribeCommands operation. Describes the results of specified commands.

This call accepts only one resource-identifying parameter.

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.

Class DescribeCommandsResponse

Contains the response to a DescribeCommands request.

Class DescribeDeploymentsRequest

Container for the parameters to the DescribeDeployments operation. Requests a description of a specified set of deployments.

This call accepts only one resource-identifying parameter.

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.

Class DescribeDeploymentsResponse

Contains the response to a DescribeDeployments request.

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

This call accepts only one resource-identifying parameter.

Class DescribeEcsClustersResponse

Contains the response to a DescribeEcsClusters request.

Class DescribeElasticIpsRequest

Container for the parameters to the DescribeElasticIps operation. Describes Elastic IP addresses.

This call accepts only one resource-identifying parameter.

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.

Class DescribeElasticIpsResponse

Contains the response to a DescribeElasticIps request.

Class DescribeElasticLoadBalancersRequest

Container for the parameters to the DescribeElasticLoadBalancers operation. Describes a stack's Elastic Load Balancing instances.

This call accepts only one resource-identifying parameter.

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.

Class DescribeElasticLoadBalancersResponse

Contains the response to a DescribeElasticLoadBalancers request.

Class DescribeInstancesRequest

Container for the parameters to the DescribeInstances operation. Requests a description of a set of instances.

This call accepts only one resource-identifying parameter.

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.

Class DescribeInstancesResponse

Contains the response to a DescribeInstances request.

Class DescribeLayersRequest

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

This call accepts only one resource-identifying parameter.

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.

Class DescribeLayersResponse

Contains the response to a DescribeLayers request.

Class DescribeLoadBasedAutoScalingRequest

Container for the parameters to the DescribeLoadBasedAutoScaling operation. Describes load-based auto scaling configurations for specified layers.

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.

Class DescribeLoadBasedAutoScalingResponse

Contains the response to a DescribeLoadBasedAutoScaling request.

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

Class DescribeMyUserProfileResponse

Contains the response to a DescribeMyUserProfile request.

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

Class DescribePermissionsResponse

Contains the response to a DescribePermissions request.

Class DescribeRaidArraysRequest

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

This call accepts only one resource-identifying parameter.

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.

Class DescribeRaidArraysResponse

Contains the response to a DescribeRaidArrays request.

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

This call accepts only one resource-identifying parameter.

Class DescribeRdsDbInstancesResponse

Contains the response to a DescribeRdsDbInstances request.

Class DescribeServiceErrorsRequest

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

This call accepts only one resource-identifying parameter.

Class DescribeServiceErrorsResponse

Contains the response to a DescribeServiceErrors request.

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

Class DescribeStackProvisioningParametersResponse

Contains the response to a DescribeStackProvisioningParameters request.

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

Class DescribeStacksResponse

Contains the response to a DescribeStacks request.

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

Class DescribeStackSummaryResponse

Contains the response to a DescribeStackSummary request.

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

Class DescribeTimeBasedAutoScalingResponse

Contains the response to a DescribeTimeBasedAutoScaling request.

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

Class DescribeUserProfilesResponse

Contains the response to a DescribeUserProfiles request.

Class DescribeVolumesRequest

Container for the parameters to the DescribeVolumes operation. Describes an instance's Amazon EBS volumes.

This call accepts only one resource-identifying parameter.

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.

Class DescribeVolumesResponse

Contains the response to a DescribeVolumes request.

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

Class DetachElasticLoadBalancerResponse

This is the response object from the DetachElasticLoadBalancer operation.

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

Class DisassociateElasticIpResponse

This is the response object from the DisassociateElasticIp operation.

Class EbsBlockDevice

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.

Class EcsCluster

Describes a registered Amazon ECS cluster.

Class ElasticIp

Describes an Elastic IP address.

Class ElasticLoadBalancer

Describes an Elastic Load Balancing instance.

Class EnvironmentVariable

Represents an app's environment variable.

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

Class GetHostnameSuggestionResponse

Contains the response to a GetHostnameSuggestion request.

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

Class GrantAccessResponse

Contains the response to a GrantAccess request.

Class Instance

Describes an instance.

Class InstanceIdentity

Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.

Class InstancesCount

Describes how many instances a stack has for each status.

Class Layer

Describes a layer.

Class LifecycleEventConfiguration

Specifies the lifecycle event configuration

Class ListTagsRequest

Container for the parameters to the ListTags operation. Returns a list of tags that are applied to the specified stack or layer.

Class ListTagsResponse

Contains the response to a ListTags request.

Class LoadBasedAutoScalingConfiguration

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

Class Permission

Describes stack or user permissions.

Class RaidArray

Describes an instance's RAID array.

Class RdsDbInstance

Describes an Amazon RDS instance.

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

Class RebootInstanceResponse

This is the response object from the RebootInstance operation.

Class Recipes

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks 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 Stacks 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.

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

Class RegisterEcsClusterResponse

Contains the response to a RegisterEcsCluster request.

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

Class RegisterElasticIpResponse

Contains the response to a RegisterElasticIp request.

Class RegisterInstanceRequest

Container for the parameters to the RegisterInstance operation. Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.

We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks 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 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.

Class RegisterInstanceResponse

Contains the response to a RegisterInstanceResult request.

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

Class RegisterRdsDbInstanceResponse

This is the response object from the RegisterRdsDbInstance operation.

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

Class RegisterVolumeResponse

Contains the response to a RegisterVolume request.

Class ReportedOs

A registered instance's reported operating system.

Class ResourceNotFoundException

OpsWorks exception

Class SelfUserProfile

Describes a user's SSH information.

Class ServiceError

Describes an AWS OpsWorks Stacks service error.

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

Class SetLoadBasedAutoScalingResponse

This is the response object from the SetLoadBasedAutoScaling operation.

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

Class SetPermissionResponse

This is the response object from the SetPermission operation.

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

Class SetTimeBasedAutoScalingResponse

This is the response object from the SetTimeBasedAutoScaling operation.

Class ShutdownEventConfiguration

The Shutdown event configuration.

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

Class SslConfiguration

Describes an app's SSL configuration.

Class Stack

Describes a stack.

Class StackConfigurationManager

Describes the configuration manager.

Class StackSummary

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

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

Class StartInstanceResponse

This is the response object from the StartInstance operation.

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

Class StartStackResponse

This is the response object from the StartStack operation.

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

Class StopInstanceResponse

This is the response object from the StopInstance operation.

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

Class StopStackResponse

This is the response object from the StopStack operation.

Class TagResourceRequest

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

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TemporaryCredential

Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.

Class TimeBasedAutoScalingConfiguration

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

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

Class UnassignInstanceResponse

This is the response object from the UnassignInstance operation.

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

Class UnassignVolumeResponse

This is the response object from the UnassignVolume operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes tags from a specified stack or layer.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

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

Class UpdateAppResponse

This is the response object from the UpdateApp operation.

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

Class UpdateElasticIpResponse

This is the response object from the UpdateElasticIp operation.

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

Class UpdateInstanceResponse

This is the response object from the UpdateInstance operation.

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

Class UpdateLayerResponse

This is the response object from the UpdateLayer operation.

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

Class UpdateMyUserProfileResponse

This is the response object from the UpdateMyUserProfile operation.

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

Class UpdateRdsDbInstanceResponse

This is the response object from the UpdateRdsDbInstance operation.

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

Class UpdateStackResponse

This is the response object from the UpdateStack operation.

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

Class UpdateUserProfileResponse

This is the response object from the UpdateUserProfile operation.

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

Class UpdateVolumeResponse

This is the response object from the UpdateVolume operation.

Class UserProfile

Describes a user's SSH information.

Class ValidationException

OpsWorks exception

Class Volume

Describes an instance's Amazon EBS volume.

Class VolumeConfiguration

Describes an Amazon EBS volume configuration.

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

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