Crate rusoto_opsworks

AWS OpsWorks

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.

AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

• AWS CLI

• AWS SDK for Java

• AWS SDK for .NET

• AWS SDK for PHP 2

• AWS SDK for Ruby

• AWS SDK for Node.js

• AWS SDK for Python(Boto)

Endpoints

AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.

• opsworks.us-east-1.amazonaws.com

• opsworks.us-east-2.amazonaws.com

• opsworks.us-west-1.amazonaws.com

• opsworks.us-west-2.amazonaws.com

• opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)

• opsworks.eu-west-1.amazonaws.com

• opsworks.eu-west-2.amazonaws.com

• opsworks.eu-west-3.amazonaws.com

• opsworks.eu-central-1.amazonaws.com

• opsworks.ap-northeast-1.amazonaws.com

• opsworks.ap-northeast-2.amazonaws.com

• opsworks.ap-south-1.amazonaws.com

• opsworks.ap-southeast-1.amazonaws.com

• opsworks.ap-southeast-2.amazonaws.com

• opsworks.sa-east-1.amazonaws.com

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

If you’re using the service, you’re probably looking for OpsWorksClient and OpsWorks.

Structs

AgentVersion

Describes an agent version.

App

A description of the app.

AssignInstanceRequest

AssignVolumeRequest

AssociateElasticIpRequest

AttachElasticLoadBalancerRequest

AutoScalingThresholds

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

BlockDeviceMapping

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

ChefConfiguration

Describes the Chef configuration.

CloneStackRequest

CloneStackResult

Contains the response to a CloneStack request.

CloudWatchLogsConfiguration

Describes the Amazon CloudWatch logs configuration for a layer.

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.

Command

Describes a command.

CreateAppRequest

CreateAppResult

Contains the response to a CreateApp request.

CreateDeploymentRequest

CreateDeploymentResult

Contains the response to a CreateDeployment request.

CreateInstanceRequest

CreateInstanceResult

Contains the response to a CreateInstance request.

CreateLayerRequest

CreateLayerResult

Contains the response to a CreateLayer request.

CreateStackRequest

CreateStackResult

Contains the response to a CreateStack request.

CreateUserProfileRequest

CreateUserProfileResult

Contains the response to a CreateUserProfile request.

DataSource

Describes an app's data source.

DeleteAppRequest

DeleteInstanceRequest

DeleteLayerRequest

DeleteStackRequest

DeleteUserProfileRequest

Deployment

Describes a deployment of a stack or app.

DeploymentCommand

Used to specify a stack or deployment command.

DeregisterEcsClusterRequest

DeregisterElasticIpRequest

DeregisterInstanceRequest

DeregisterRdsDbInstanceRequest

DeregisterVolumeRequest

DescribeAgentVersionsRequest

DescribeAgentVersionsResult

Contains the response to a DescribeAgentVersions request.

DescribeAppsRequest

DescribeAppsResult

Contains the response to a DescribeApps request.

DescribeCommandsRequest

DescribeCommandsResult

Contains the response to a DescribeCommands request.

DescribeDeploymentsRequest

DescribeDeploymentsResult

Contains the response to a DescribeDeployments request.

DescribeEcsClustersRequest

DescribeEcsClustersResult

Contains the response to a DescribeEcsClusters request.

DescribeElasticIpsRequest

DescribeElasticIpsResult

Contains the response to a DescribeElasticIps request.

DescribeElasticLoadBalancersRequest

DescribeElasticLoadBalancersResult

Contains the response to a DescribeElasticLoadBalancers request.

DescribeInstancesRequest

DescribeInstancesResult

Contains the response to a DescribeInstances request.

DescribeLayersRequest

DescribeLayersResult

Contains the response to a DescribeLayers request.

DescribeLoadBasedAutoScalingRequest

DescribeLoadBasedAutoScalingResult

Contains the response to a DescribeLoadBasedAutoScaling request.

DescribeMyUserProfileResult

Contains the response to a DescribeMyUserProfile request.

DescribeOperatingSystemsResponse

The response to a DescribeOperatingSystems request.

DescribePermissionsRequest

DescribePermissionsResult

Contains the response to a DescribePermissions request.

DescribeRaidArraysRequest

DescribeRaidArraysResult

Contains the response to a DescribeRaidArrays request.

DescribeRdsDbInstancesRequest

DescribeRdsDbInstancesResult

Contains the response to a DescribeRdsDbInstances request.

DescribeServiceErrorsRequest

DescribeServiceErrorsResult

Contains the response to a DescribeServiceErrors request.

DescribeStackProvisioningParametersRequest

DescribeStackProvisioningParametersResult

Contains the response to a DescribeStackProvisioningParameters request.

DescribeStackSummaryRequest

DescribeStackSummaryResult

Contains the response to a DescribeStackSummary request.

DescribeStacksRequest

DescribeStacksResult

Contains the response to a DescribeStacks request.

DescribeTimeBasedAutoScalingRequest

DescribeTimeBasedAutoScalingResult

Contains the response to a DescribeTimeBasedAutoScaling request.

DescribeUserProfilesRequest

DescribeUserProfilesResult

Contains the response to a DescribeUserProfiles request.

DescribeVolumesRequest

DescribeVolumesResult

Contains the response to a DescribeVolumes request.

DetachElasticLoadBalancerRequest

DisassociateElasticIpRequest

EbsBlockDevice

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

EcsCluster

Describes a registered Amazon ECS cluster.

ElasticIp

Describes an Elastic IP address.

ElasticLoadBalancer

Describes an Elastic Load Balancing instance.

EnvironmentVariable

Represents an app's environment variable.

GetHostnameSuggestionRequest

GetHostnameSuggestionResult

Contains the response to a GetHostnameSuggestion request.

GrantAccessRequest

GrantAccessResult

Contains the response to a GrantAccess request.

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.

LifecycleEventConfiguration

Specifies the lifecycle event configuration

ListTagsRequest

ListTagsResult

Contains the response to a ListTags request.

LoadBasedAutoScalingConfiguration

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

OperatingSystem

Describes supported operating systems in AWS OpsWorks Stacks.

OperatingSystemConfigurationManager

A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.

OpsWorksClient

A client for the AWS OpsWorks API.

Permission

Describes stack or user permissions.

RaidArray

Describes an instance's RAID array.

RdsDbInstance

Describes an Amazon RDS instance.

RebootInstanceRequest

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.

RegisterEcsClusterRequest

RegisterEcsClusterResult

Contains the response to a RegisterEcsCluster request.

RegisterElasticIpRequest

RegisterElasticIpResult

Contains the response to a RegisterElasticIp request.

RegisterInstanceRequest

RegisterInstanceResult

Contains the response to a RegisterInstanceResult request.

RegisterRdsDbInstanceRequest

RegisterVolumeRequest

RegisterVolumeResult

Contains the response to a RegisterVolume request.

ReportedOs

A registered instance's reported operating system.

SelfUserProfile

Describes a user's SSH information.

ServiceError

Describes an AWS OpsWorks Stacks service error.

SetLoadBasedAutoScalingRequest

SetPermissionRequest

SetTimeBasedAutoScalingRequest

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

StartStackRequest

StopInstanceRequest

StopStackRequest

TagResourceRequest

TemporaryCredential

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

TimeBasedAutoScalingConfiguration

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

UnassignInstanceRequest

UnassignVolumeRequest

UntagResourceRequest

UpdateAppRequest

UpdateElasticIpRequest

UpdateInstanceRequest

UpdateLayerRequest

UpdateMyUserProfileRequest

UpdateRdsDbInstanceRequest

UpdateStackRequest

UpdateUserProfileRequest

UpdateVolumeRequest

UserProfile

Describes a user's SSH information.

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.

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

Enums

AssignInstanceError

Errors returned by AssignInstance

AssignVolumeError

Errors returned by AssignVolume

AssociateElasticIpError

Errors returned by AssociateElasticIp

AttachElasticLoadBalancerError

Errors returned by AttachElasticLoadBalancer

CloneStackError

Errors returned by CloneStack

CreateAppError

Errors returned by CreateApp

CreateDeploymentError

Errors returned by CreateDeployment

CreateInstanceError

Errors returned by CreateInstance

CreateLayerError

Errors returned by CreateLayer

CreateStackError

Errors returned by CreateStack

CreateUserProfileError

Errors returned by CreateUserProfile

DeleteAppError

Errors returned by DeleteApp

DeleteInstanceError

Errors returned by DeleteInstance

DeleteLayerError

Errors returned by DeleteLayer

DeleteStackError

Errors returned by DeleteStack

DeleteUserProfileError

Errors returned by DeleteUserProfile

DeregisterEcsClusterError

Errors returned by DeregisterEcsCluster

DeregisterElasticIpError

Errors returned by DeregisterElasticIp

DeregisterInstanceError

Errors returned by DeregisterInstance

DeregisterRdsDbInstanceError

Errors returned by DeregisterRdsDbInstance

DeregisterVolumeError

Errors returned by DeregisterVolume

DescribeAgentVersionsError

Errors returned by DescribeAgentVersions

DescribeAppsError

Errors returned by DescribeApps

DescribeCommandsError

Errors returned by DescribeCommands

DescribeDeploymentsError

Errors returned by DescribeDeployments

DescribeEcsClustersError

Errors returned by DescribeEcsClusters

DescribeElasticIpsError

Errors returned by DescribeElasticIps

DescribeElasticLoadBalancersError

Errors returned by DescribeElasticLoadBalancers

DescribeInstancesError

Errors returned by DescribeInstances

DescribeLayersError

Errors returned by DescribeLayers

DescribeLoadBasedAutoScalingError

Errors returned by DescribeLoadBasedAutoScaling

DescribeMyUserProfileError

Errors returned by DescribeMyUserProfile

DescribeOperatingSystemsError

Errors returned by DescribeOperatingSystems

DescribePermissionsError

Errors returned by DescribePermissions

DescribeRaidArraysError

Errors returned by DescribeRaidArrays

DescribeRdsDbInstancesError

Errors returned by DescribeRdsDbInstances

DescribeServiceErrorsError

Errors returned by DescribeServiceErrors

DescribeStackProvisioningParametersError

Errors returned by DescribeStackProvisioningParameters

DescribeStackSummaryError

Errors returned by DescribeStackSummary

DescribeStacksError

Errors returned by DescribeStacks

DescribeTimeBasedAutoScalingError

Errors returned by DescribeTimeBasedAutoScaling

DescribeUserProfilesError

Errors returned by DescribeUserProfiles

DescribeVolumesError

Errors returned by DescribeVolumes

DetachElasticLoadBalancerError

Errors returned by DetachElasticLoadBalancer

DisassociateElasticIpError

Errors returned by DisassociateElasticIp

GetHostnameSuggestionError

Errors returned by GetHostnameSuggestion

GrantAccessError

Errors returned by GrantAccess

ListTagsError

Errors returned by ListTags

RebootInstanceError

Errors returned by RebootInstance

RegisterEcsClusterError

Errors returned by RegisterEcsCluster

RegisterElasticIpError

Errors returned by RegisterElasticIp

RegisterInstanceError

Errors returned by RegisterInstance

RegisterRdsDbInstanceError

Errors returned by RegisterRdsDbInstance

RegisterVolumeError

Errors returned by RegisterVolume

SetLoadBasedAutoScalingError

Errors returned by SetLoadBasedAutoScaling

SetPermissionError

Errors returned by SetPermission

SetTimeBasedAutoScalingError

Errors returned by SetTimeBasedAutoScaling

StartInstanceError

Errors returned by StartInstance

StartStackError

Errors returned by StartStack

StopInstanceError

Errors returned by StopInstance

StopStackError

Errors returned by StopStack

TagResourceError

Errors returned by TagResource

UnassignInstanceError

Errors returned by UnassignInstance

UnassignVolumeError

Errors returned by UnassignVolume

UntagResourceError

Errors returned by UntagResource

UpdateAppError

Errors returned by UpdateApp

UpdateElasticIpError

Errors returned by UpdateElasticIp

UpdateInstanceError

Errors returned by UpdateInstance

UpdateLayerError

Errors returned by UpdateLayer

UpdateMyUserProfileError

Errors returned by UpdateMyUserProfile

UpdateRdsDbInstanceError

Errors returned by UpdateRdsDbInstance

UpdateStackError

Errors returned by UpdateStack

UpdateUserProfileError

Errors returned by UpdateUserProfile

UpdateVolumeError

Errors returned by UpdateVolume

Traits

OpsWorks

Trait representing the capabilities of the AWS OpsWorks API. AWS OpsWorks clients implement this trait.