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

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::Source

Includes:

Structure

Defined in:

lib/aws-sdk-opsworks/types.rb

Overview

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

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #password ⇒ String

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

• #revision ⇒ String

  The application’s version.

• #ssh_key ⇒ String

  In requests, the repository’s SSH key.

• #type ⇒ String

  The repository type.

• #url ⇒ String

  The source URL.

• #username ⇒ String

  This parameter depends on the repository type.

Instance Attribute Details

#password ⇒ String

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 [docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html][1].

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

[1]: docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 4839

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

#revision ⇒ String

The application’s version. 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)

# File 'lib/aws-sdk-opsworks/types.rb', line 4839

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

#ssh_key ⇒ String

In requests, the repository’s SSH key.

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

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 4839

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

#type ⇒ String

The repository type.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 4839

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

#url ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 4839

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

#username ⇒ String

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)

# File 'lib/aws-sdk-opsworks/types.rb', line 4839

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