Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS OpsWorks Resource Types Reference » AWS::OpsWorks::Stack » AWS OpsWorks Source Type

AWS OpsWorks Source Type

Describes the information required to retrieve a cookbook or app from a repository for the AWS::OpsWorks::Stack or AWS::OpsWorks::App resource types.

For more information and valid values, see Source in the AWS OpsWorks Stacks API Reference.

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

This parameter depends on the repository type. For Amazon S3 bundles, set Password to the appropriate IAM secret access key. For HTTP bundles, Git repositories, and Subversion repositories, set Password to the appropriate password.

Required: No

Type: String

Revision

The application's version. With AWS OpsWorks, you can 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

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

Type

The repository type.

Required: No

Type: String

Url

The source URL.

Required: No

Type: String

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 appropriate user name.

Required: No

Type: String

On this page: