Package software.amazon.awscdk.services.opsworks

Interface CfnStack.SourceProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnStack.SourceProperty.Jsii$Proxy
Enclosing class:
CfnStack
@Stability(Stable) public static interface CfnStack.SourceProperty extends software.amazon.jsii.JsiiSerializable
Contains the information required to retrieve an app or cookbook from a repository.

For more information, see Creating Apps or Custom Recipes and Cookbooks .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opsworks.*;
 SourceProperty sourceProperty = SourceProperty.builder()
         .password("password")
         .revision("revision")
         .sshKey("sshKey")
         .type("type")
         .url("url")
         .username("username")
         .build();

  • Method Details

    • getPassword

      @Stability(Stable) @Nullable default String getPassword()
      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, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

    • getRevision

      @Stability(Stable) @Nullable default String getRevision()
      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.

    • getSshKey

      @Stability(Stable) @Nullable default String getSshKey()
      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"} } ...

    • getType

      @Stability(Stable) @Nullable default String getType()
      The repository type.

    • getUrl

      @Stability(Stable) @Nullable default String getUrl()
      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 .

    • getUsername

      @Stability(Stable) @Nullable default String getUsername()
      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.

    • builder

      @Stability(Stable) static CfnStack.SourceProperty.Builder builder()
      Returns:
      a CfnStack.SourceProperty.Builder of CfnStack.SourceProperty