Class Source

java.lang.Object
software.amazon.awssdk.services.opsworks.model.Source
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Source.Builder,Source>
@Generated("software.amazon.awssdk:codegen") public final class Source extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Source.Builder,Source>

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

See Also:

  • Method Details

    • type

      public final SourceType type()

      The repository type.

      If the service returns an enum value that is not available in the current SDK version, type will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The repository type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The repository type.

      If the service returns an enum value that is not available in the current SDK version, type will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The repository type.
      See Also:

    • url

      public final String url()

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

    • username

      public final String username()

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

    • password

      public final String password()

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

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

      Returns:
      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 https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

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

    • sshKey

      public final String sshKey()

      In requests, the repository's SSH key.

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

      Returns:
      In requests, the repository's SSH key.

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

    • revision

      public final String revision()

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

    • toBuilder

      public Source.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Source.Builder,Source>
      Returns:
      a builder for type T

    • builder

      public static Source.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Source.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.