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

Class StackEvent

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

The StackEvent data type.

See Also:

  • Method Details

    • stackId

      public final String stackId()

      The unique ID name of the instance of the stack.

      Returns:
      The unique ID name of the instance of the stack.

    • eventId

      public final String eventId()

      The unique ID of this event.

      Returns:
      The unique ID of this event.

    • stackName

      public final String stackName()

      The name associated with a stack.

      Returns:
      The name associated with a 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 associated with the physical instance of the resource.

      Returns:
      The name or unique identifier associated with the physical instance of the resource.

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

    • resourceProperties

      public final String resourceProperties()

      BLOB of the properties used to create the resource.

      Returns:
      BLOB of the properties used to create the resource.

    • clientRequestToken

      public final String clientRequestToken()

      The token passed to the operation that generated this event.

      All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

      In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

      Returns:
      The token passed to the operation that generated this event.

      All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

      In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

    • hookType

      public final String hookType()

      The name of the hook.

      Returns:
      The name of the hook.

    • hookStatus

      public final HookStatus hookStatus()

      Provides the status of the change set hook.

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

      Returns:
      Provides the status of the change set hook.
      See Also:

    • hookStatusAsString

      public final String hookStatusAsString()

      Provides the status of the change set hook.

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

      Returns:
      Provides the status of the change set hook.
      See Also:

    • hookStatusReason

      public final String hookStatusReason()

      Provides the reason for the hook status.

      Returns:
      Provides the reason for the hook status.

    • hookInvocationPoint

      public final HookInvocationPoint hookInvocationPoint()

      Invocation points are points in provisioning logic where hooks are initiated.

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

      Returns:
      Invocation points are points in provisioning logic where hooks are initiated.
      See Also:

    • hookInvocationPointAsString

      public final String hookInvocationPointAsString()

      Invocation points are points in provisioning logic where hooks are initiated.

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

      Returns:
      Invocation points are points in provisioning logic where hooks are initiated.
      See Also:

    • hookFailureMode

      public final HookFailureMode hookFailureMode()

      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

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

      Returns:
      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

      See Also:

    • hookFailureModeAsString

      public final String hookFailureModeAsString()

      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

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

      Returns:
      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

      See Also:

    • detailedStatus

      public final DetailedStatus detailedStatus()

      An optional field containing information about the detailed status of the stack event.

      • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

      • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

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

      Returns:
      An optional field containing information about the detailed status of the stack event.

      • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

      • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

      See Also:

    • detailedStatusAsString

      public final String detailedStatusAsString()

      An optional field containing information about the detailed status of the stack event.

      • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

      • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

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

      Returns:
      An optional field containing information about the detailed status of the stack event.

      • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

      • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

      See Also:

    • toBuilder

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

    • builder

      public static StackEvent.Builder builder()

    • serializableBuilderClass

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