You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Types::Source

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

When making an API call, you may pass Source data as a hash:

{
  type: "git", # accepts git, svn, archive, s3
  url: "String",
  username: "String",
  password: "String",
  ssh_key: "String",
  revision: "String",
}

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

Instance Attribute Summary collapse

Instance Attribute Details

#passwordString

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 http://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.

Returns:

  • (String)


5411
5412
5413
5414
5415
5416
5417
5418
5419
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5411

class Source < Struct.new(
  :type,
  :url,
  :username,
  :password,
  :ssh_key,
  :revision)
  include Aws::Structure
end

#revisionString

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.

Returns:

  • (String)


5411
5412
5413
5414
5415
5416
5417
5418
5419
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5411

class Source < Struct.new(
  :type,
  :url,
  :username,
  :password,
  :ssh_key,
  :revision)
  include Aws::Structure
end

#ssh_keyString

In requests, the repository's SSH key.

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

Returns:

  • (String)


5411
5412
5413
5414
5415
5416
5417
5418
5419
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5411

class Source < Struct.new(
  :type,
  :url,
  :username,
  :password,
  :ssh_key,
  :revision)
  include Aws::Structure
end

#typeString

The repository type.

Returns:

  • (String)


5411
5412
5413
5414
5415
5416
5417
5418
5419
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5411

class Source < Struct.new(
  :type,
  :url,
  :username,
  :password,
  :ssh_key,
  :revision)
  include Aws::Structure
end

#urlString

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.

Returns:

  • (String)


5411
5412
5413
5414
5415
5416
5417
5418
5419
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5411

class Source < Struct.new(
  :type,
  :url,
  :username,
  :password,
  :ssh_key,
  :revision)
  include Aws::Structure
end

#usernameString

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.

Returns:

  • (String)


5411
5412
5413
5414
5415
5416
5417
5418
5419
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5411

class Source < Struct.new(
  :type,
  :url,
  :username,
  :password,
  :ssh_key,
  :revision)
  include Aws::Structure
end