Class: AWSCDK::OpsWorks::CfnStack::SourceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ops_works/cfn_stack.rb

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(password: nil, revision: nil, ssh_key: nil, type: nil, url: nil, username: nil) ⇒ SourceProperty

Returns a new instance of SourceProperty.

Parameters:

  • password (String, nil) (defaults to: nil) —

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

  • revision (String, nil) (defaults to: nil) —

    The application's version.

  • ssh_key (String, nil) (defaults to: nil) —

    The repository's SSH key.

  • type (String, nil) (defaults to: nil) —

    The repository type.

  • url (String, nil) (defaults to: nil) —

    The source URL.

  • username (String, nil) (defaults to: nil) —

    This parameter depends on the repository type.



981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'ops_works/cfn_stack.rb', line 981

def initialize(password: nil, revision: nil, ssh_key: nil, type: nil, url: nil, username: nil)
  @password = password
  Jsii::Type.check_type(@password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password") unless @password.nil?
  @revision = revision
  Jsii::Type.check_type(@revision, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "revision") unless @revision.nil?
  @ssh_key = ssh_key
  Jsii::Type.check_type(@ssh_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sshKey") unless @ssh_key.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
  @url = url
  Jsii::Type.check_type(@url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "url") unless @url.nil?
  @username = username
  Jsii::Type.check_type(@username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "username") unless @username.nil?
end

Instance Attribute Details

#password ⇒ String? (readonly)

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 .

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

Returns:

  • (String, nil)

See Also:



1007
1008
1009
 
# File 'ops_works/cfn_stack.rb', line 1007

def password
  @password
end

#revision ⇒ String? (readonly)

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, nil)

See Also:



1014
1015
1016
 
# File 'ops_works/cfn_stack.rb', line 1014

def revision
  @revision
end

#ssh_key ⇒ String? (readonly)

The repository's SSH key.

For more information, see Using Git Repository SSH Keys in the 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"} } ...

Returns:

  • (String, nil)

See Also:



1023
1024
1025
 
# File 'ops_works/cfn_stack.rb', line 1023

def ssh_key
  @ssh_key
end

#type ⇒ String? (readonly)

The repository type.

Returns:

  • (String, nil)

See Also:



1028
1029
1030
 
# File 'ops_works/cfn_stack.rb', line 1028

def type
  @type
end

#url ⇒ String? (readonly)

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, nil)

See Also:



1035
1036
1037
 
# File 'ops_works/cfn_stack.rb', line 1035

def url
  @url
end

#username ⇒ String? (readonly)

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, nil)

See Also:



1043
1044
1045
 
# File 'ops_works/cfn_stack.rb', line 1043

def username
  @username
end

Class Method Details

.jsii_properties ⇒ Object 



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'ops_works/cfn_stack.rb', line 1045

def self.jsii_properties
  {
    :password => "password",
    :revision => "revision",
    :ssh_key => "sshKey",
    :type => "type",
    :url => "url",
    :username => "username",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'ops_works/cfn_stack.rb', line 1056

def to_jsii
  result = {}
  result.merge!({
    "password" => @password,
    "revision" => @revision,
    "sshKey" => @ssh_key,
    "type" => @type,
    "url" => @url,
    "username" => @username,
  })
  result.compact
end