Class ProvisionedProductAttribute

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

Information about a provisioned product.

See Also:

  • Method Details

    • name

      public final String name()

      The user-friendly name of the provisioned product.

      Returns:
      The user-friendly name of the provisioned product.

    • arn

      public final String arn()

      The ARN of the provisioned product.

      Returns:
      The ARN of the provisioned product.

    • type

      public final String type()

      The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

      Returns:
      The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

    • id

      public final String id()

      The identifier of the provisioned product.

      Returns:
      The identifier of the provisioned product.

    • status

      public final ProvisionedProductStatus status()

      The current status of the provisioned product.

      • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

      • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

      • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

      • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

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

      Returns:
      The current status of the provisioned product.

      • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

      • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

      • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

      • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the provisioned product.

      • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

      • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

      • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

      • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

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

      Returns:
      The current status of the provisioned product.

      • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

      • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

      • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

      • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

      See Also:

    • statusMessage

      public final String statusMessage()

      The current status message of the provisioned product.

      Returns:
      The current status message of the provisioned product.

    • createdTime

      public final Instant createdTime()

      The UTC time stamp of the creation time.

      Returns:
      The UTC time stamp of the creation time.

    • idempotencyToken

      public final String idempotencyToken()

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      Returns:
      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    • lastRecordId

      public final String lastRecordId()

      The record identifier of the last request performed on this provisioned product.

      Returns:
      The record identifier of the last request performed on this provisioned product.

    • lastProvisioningRecordId

      public final String lastProvisioningRecordId()

      The record identifier of the last request performed on this provisioned product of the following types:

      • ProvisionProduct

      • UpdateProvisionedProduct

      • ExecuteProvisionedProductPlan

      • TerminateProvisionedProduct

      Returns:
      The record identifier of the last request performed on this provisioned product of the following types:

      • ProvisionProduct

      • UpdateProvisionedProduct

      • ExecuteProvisionedProductPlan

      • TerminateProvisionedProduct

    • lastSuccessfulProvisioningRecordId

      public final String lastSuccessfulProvisioningRecordId()

      The record identifier of the last successful request performed on this provisioned product of the following types:

      • ProvisionProduct

      • UpdateProvisionedProduct

      • ExecuteProvisionedProductPlan

      • TerminateProvisionedProduct

      Returns:
      The record identifier of the last successful request performed on this provisioned product of the following types:

      • ProvisionProduct

      • UpdateProvisionedProduct

      • ExecuteProvisionedProductPlan

      • TerminateProvisionedProduct

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      One or more tags.

      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 hasTags() method.

      Returns:
      One or more tags.

    • physicalId

      public final String physicalId()

      The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

      Returns:
      The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

    • productId

      public final String productId()

      The product identifier.

      Returns:
      The product identifier.

    • productName

      public final String productName()

      The name of the product.

      Returns:
      The name of the product.

    • provisioningArtifactId

      public final String provisioningArtifactId()

      The identifier of the provisioning artifact.

      Returns:
      The identifier of the provisioning artifact.

    • provisioningArtifactName

      public final String provisioningArtifactName()

      The name of the provisioning artifact.

      Returns:
      The name of the provisioning artifact.

    • userArn

      public final String userArn()

      The Amazon Resource Name (ARN) of the user.

      Returns:
      The Amazon Resource Name (ARN) of the user.

    • userArnSession

      public final String userArnSession()

      The ARN of the user in the session. This ARN might contain a session ID.

      Returns:
      The ARN of the user in the session. This ARN might contain a session ID.

    • toBuilder

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

    • builder

      public static ProvisionedProductAttribute.Builder builder()

    • serializableBuilderClass

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