Class ProvisioningArtifactProperties

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

Information about a provisioning artifact (also known as a version) for a product.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

      Returns:
      The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

    • description

      public final String description()

      The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

      Returns:
      The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

    • hasInfo

      public final boolean hasInfo()
      For responses, this returns true if the service returned a value for the Info property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • info

      public final Map<String,String> info()

      Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

      The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:

      "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

      ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInfo() method.

      Returns:
      Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

      The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:

      "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

      ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

    • type

      public final ProvisioningArtifactType type()

      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

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

      Returns:
      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

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

      Returns:
      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

      See Also:

    • disableTemplateValidation

      public final Boolean disableTemplateValidation()

      If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.

      Service Catalog does not support template validation for the TERRAFORM_OS product type.

      Returns:
      If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.

      Service Catalog does not support template validation for the TERRAFORM_OS product type.

    • toBuilder

      public ProvisioningArtifactProperties.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<ProvisioningArtifactProperties.Builder,ProvisioningArtifactProperties>
      Returns:
      a builder for type T

    • builder

      public static ProvisioningArtifactProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ProvisioningArtifactProperties.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.