Crate rusoto_opsworks
source · [−]Expand description
Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
-
opsworks.us-east-1.amazonaws.com
-
opsworks.us-east-2.amazonaws.com
-
opsworks.us-west-1.amazonaws.com
-
opsworks.us-west-2.amazonaws.com
-
opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)
-
opsworks.eu-west-1.amazonaws.com
-
opsworks.eu-west-2.amazonaws.com
-
opsworks.eu-west-3.amazonaws.com
-
opsworks.eu-central-1.amazonaws.com
-
opsworks.ap-northeast-1.amazonaws.com
-
opsworks.ap-northeast-2.amazonaws.com
-
opsworks.ap-south-1.amazonaws.com
-
opsworks.ap-southeast-1.amazonaws.com
-
opsworks.ap-southeast-2.amazonaws.com
-
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
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
Describes an agent version.
A description of the app.
Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.
Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.
Describes the Chef configuration.
Contains the response to a CloneStack request.
Describes the Amazon CloudWatch logs configuration for a layer.
Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
Describes a command.
Contains the response to a CreateApp request.
Contains the response to a CreateDeployment request.
Contains the response to a CreateInstance request.
Contains the response to a CreateLayer request.
Contains the response to a CreateStack request.
Contains the response to a CreateUserProfile request.
Describes an app's data source.
Describes a deployment of a stack or app.
Used to specify a stack or deployment command.
Contains the response to a DescribeAgentVersions request.
Contains the response to a DescribeApps request.
Contains the response to a DescribeCommands request.
Contains the response to a DescribeDeployments request.
Contains the response to a DescribeEcsClusters request.
Contains the response to a DescribeElasticIps request.
Contains the response to a DescribeElasticLoadBalancers request.
Contains the response to a DescribeInstances request.
Contains the response to a DescribeLayers request.
Contains the response to a DescribeLoadBasedAutoScaling request.
Contains the response to a DescribeMyUserProfile request.
The response to a DescribeOperatingSystems request.
Contains the response to a DescribePermissions request.
Contains the response to a DescribeRaidArrays request.
Contains the response to a DescribeRdsDbInstances request.
Contains the response to a DescribeServiceErrors request.
Contains the response to a DescribeStackProvisioningParameters request.
Contains the response to a DescribeStackSummary request.
Contains the response to a DescribeStacks request.
Contains the response to a DescribeTimeBasedAutoScaling request.
Contains the response to a DescribeUserProfiles request.
Contains the response to a DescribeVolumes request.
Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.
Describes a registered Amazon ECS cluster.
Describes an Elastic IP address.
Describes an Elastic Load Balancing instance.
Represents an app's environment variable.
Contains the response to a GetHostnameSuggestion request.
Contains the response to a GrantAccess request.
Describes an instance.
Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.
Describes how many instances a stack has for each status.
Describes a layer.
Specifies the lifecycle event configuration
Contains the response to a ListTags request.
Describes a layer's load-based auto scaling configuration.
Describes supported operating systems in AWS OpsWorks Stacks.
A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.
A client for the AWS OpsWorks API.
Describes stack or user permissions.
Describes an instance's RAID array.
Describes an Amazon RDS instance.
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.
Contains the response to a RegisterEcsCluster request.
Contains the response to a RegisterElasticIp request.
Contains the response to a RegisterInstanceResult request.
Contains the response to a RegisterVolume request.
A registered instance's reported operating system.
Describes a user's SSH information.
Describes an AWS OpsWorks Stacks service error.
The Shutdown event configuration.
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
Describes an app's SSL configuration.
Describes a stack.
Describes the configuration manager.
Summarizes the number of layers, instances, and apps in a stack.
Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.
Describes an instance's time-based auto scaling configuration.
Describes a user's SSH information.
Describes an instance's Amazon EBS volume.
Describes an Amazon EBS volume configuration.
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
Errors returned by AssignInstance
Errors returned by AssignVolume
Errors returned by AssociateElasticIp
Errors returned by AttachElasticLoadBalancer
Errors returned by CloneStack
Errors returned by CreateApp
Errors returned by CreateDeployment
Errors returned by CreateInstance
Errors returned by CreateLayer
Errors returned by CreateStack
Errors returned by CreateUserProfile
Errors returned by DeleteApp
Errors returned by DeleteInstance
Errors returned by DeleteLayer
Errors returned by DeleteStack
Errors returned by DeleteUserProfile
Errors returned by DeregisterEcsCluster
Errors returned by DeregisterElasticIp
Errors returned by DeregisterInstance
Errors returned by DeregisterRdsDbInstance
Errors returned by DeregisterVolume
Errors returned by DescribeAgentVersions
Errors returned by DescribeApps
Errors returned by DescribeCommands
Errors returned by DescribeDeployments
Errors returned by DescribeEcsClusters
Errors returned by DescribeElasticIps
Errors returned by DescribeElasticLoadBalancers
Errors returned by DescribeInstances
Errors returned by DescribeLayers
Errors returned by DescribeLoadBasedAutoScaling
Errors returned by DescribeMyUserProfile
Errors returned by DescribeOperatingSystems
Errors returned by DescribePermissions
Errors returned by DescribeRaidArrays
Errors returned by DescribeRdsDbInstances
Errors returned by DescribeServiceErrors
Errors returned by DescribeStackProvisioningParameters
Errors returned by DescribeStackSummary
Errors returned by DescribeStacks
Errors returned by DescribeTimeBasedAutoScaling
Errors returned by DescribeUserProfiles
Errors returned by DescribeVolumes
Errors returned by DetachElasticLoadBalancer
Errors returned by DisassociateElasticIp
Errors returned by GetHostnameSuggestion
Errors returned by GrantAccess
Errors returned by ListTags
Errors returned by RebootInstance
Errors returned by RegisterEcsCluster
Errors returned by RegisterElasticIp
Errors returned by RegisterInstance
Errors returned by RegisterRdsDbInstance
Errors returned by RegisterVolume
Errors returned by SetLoadBasedAutoScaling
Errors returned by SetPermission
Errors returned by SetTimeBasedAutoScaling
Errors returned by StartInstance
Errors returned by StartStack
Errors returned by StopInstance
Errors returned by StopStack
Errors returned by TagResource
Errors returned by UnassignInstance
Errors returned by UnassignVolume
Errors returned by UntagResource
Errors returned by UpdateApp
Errors returned by UpdateElasticIp
Errors returned by UpdateInstance
Errors returned by UpdateLayer
Errors returned by UpdateMyUserProfile
Errors returned by UpdateRdsDbInstance
Errors returned by UpdateStack
Errors returned by UpdateUserProfile
Errors returned by UpdateVolume
Traits
Trait representing the capabilities of the AWS OpsWorks API. AWS OpsWorks clients implement this trait.