AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::OpsWorks::Stack 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Password" : String, "Revision" : String, "SshKey" : String, "Type" : String, "Url" : String, "Username" : String }

YAML

Password: String Revision: String SshKey: String Type: String Url: String Username: String

Properties

Password

When included in a request, the parameter depends on the repository type.

  • For Amazon S3 bundles, set Password to the appropriate IAM secret access key.

  • For HTTP bundles and Subversion repositories, set Password to the password.

For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

Required: No

Type: String

Update requires: No interruption

Revision

The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

Required: No

Type: String

Update requires: No interruption

SshKey

The repository's SSH key. For more information, see Using Git Repository SSH Keys in the AWS OpsWorks User Guide. To pass in an SSH key as a parameter, see the following example:

"Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : [ "\n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ...

Required: No

Type: String

Update requires: No interruption

Type

The repository type.

Required: No

Type: String

Allowed Values: archive | git | s3 | svn

Update requires: No interruption

Url

The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.

Required: No

Type: String

Update requires: No interruption

Username

This parameter depends on the repository type.

  • For Amazon S3 bundles, set Username to the appropriate IAM access key ID.

  • For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

Required: No

Type: String

Update requires: No interruption

On this page: