Class: AWSCDK::OpsWorks::CfnApp::SourceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ops_works/cfn_app.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) —

    In requests, 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.



754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'ops_works/cfn_app.rb', line 754

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:



780
781
782
 
# File 'ops_works/cfn_app.rb', line 780

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:



787
788
789
 
# File 'ops_works/cfn_app.rb', line 787

def revision
  @revision
end

#ssh_key ⇒ String? (readonly)

In requests, the repository's SSH key.

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

Returns:

  • (String, nil)

See Also:



794
795
796
 
# File 'ops_works/cfn_app.rb', line 794

def ssh_key
  @ssh_key
end

#type ⇒ String? (readonly)

The repository type.

Returns:

  • (String, nil)

See Also:



799
800
801
 
# File 'ops_works/cfn_app.rb', line 799

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:



806
807
808
 
# File 'ops_works/cfn_app.rb', line 806

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:



814
815
816
 
# File 'ops_works/cfn_app.rb', line 814

def username
  @username
end

Class Method Details

.jsii_properties ⇒ Object 



816
817
818
819
820
821
822
823
824
825
 
# File 'ops_works/cfn_app.rb', line 816

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

Instance Method Details

#to_jsii ⇒ Object 



827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'ops_works/cfn_app.rb', line 827

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