Package software.amazon.awssdk.services.cloudformation.model

Class StackResource

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

The StackResource data type.

See Also:

  • Method Details

    • stackName

      public final String stackName()

      The name associated with the stack.

      Returns:
      The name associated with the stack.

    • stackId

      public final String stackId()

      Unique identifier of the stack.

      Returns:
      Unique identifier of the stack.

    • logicalResourceId

      public final String logicalResourceId()

      The logical name of the resource specified in the template.

      Returns:
      The logical name of the resource specified in the template.

    • physicalResourceId

      public final String physicalResourceId()

      The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

      Returns:
      The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    • resourceType

      public final String resourceType()

      Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

      Returns:
      Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

    • timestamp

      public final Instant timestamp()

      Time the status was updated.

      Returns:
      Time the status was updated.

    • resourceStatus

      public final ResourceStatus resourceStatus()

      Current status of the resource.

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

      Returns:
      Current status of the resource.
      See Also:

    • resourceStatusAsString

      public final String resourceStatusAsString()

      Current status of the resource.

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

      Returns:
      Current status of the resource.
      See Also:

    • resourceStatusReason

      public final String resourceStatusReason()

      Success/failure message associated with the resource.

      Returns:
      Success/failure message associated with the resource.

    • description

      public final String description()

      User defined description associated with the resource.

      Returns:
      User defined description associated with the resource.

    • driftInformation

      public final StackResourceDriftInformation driftInformation()

      Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

      Returns:
      Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

    • moduleInfo

      public final ModuleInfo moduleInfo()

      Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

      Returns:
      Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

    • toBuilder

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

    • builder

      public static StackResource.Builder builder()

    • serializableBuilderClass

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