Class AwsCloudFormationStackDetails

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

Nests a stack as a resource in a top-level template. Nested stacks are stacks created as resources for another stack.

See Also:

  • Method Details

    • hasCapabilities

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

    • capabilities

      public final List<String> capabilities()

      The capabilities allowed in the stack.

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

      Returns:
      The capabilities allowed in the stack.

    • creationTime

      public final String creationTime()

      The time at which the stack was created.

      Returns:
      The time at which the stack was created.

    • description

      public final String description()

      A user-defined description associated with the stack.

      Returns:
      A user-defined description associated with the stack.

    • disableRollback

      public final Boolean disableRollback()

      Boolean to enable or disable rollback on stack creation failures.

      Returns:
      Boolean to enable or disable rollback on stack creation failures.

    • driftInformation

      public final AwsCloudFormationStackDriftInformationDetails driftInformation()

      Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.

      Returns:
      Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.

    • enableTerminationProtection

      public final Boolean enableTerminationProtection()

      Whether termination protection is enabled for the stack.

      Returns:
      Whether termination protection is enabled for the stack.

    • lastUpdatedTime

      public final String lastUpdatedTime()

      The time the nested stack was last updated. This field will only be returned if the stack has been updated at least once.

      Returns:
      The time the nested stack was last updated. This field will only be returned if the stack has been updated at least once.

    • hasNotificationArns

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

    • notificationArns

      public final List<String> notificationArns()

      The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.

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

      Returns:
      The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.

    • hasOutputs

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

    • outputs

      public final List<AwsCloudFormationStackOutputsDetails> outputs()

      A list of output structures.

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

      Returns:
      A list of output structures.

    • roleArn

      public final String roleArn()

      The ARN of an IAM role that's associated with the stack.

      Returns:
      The ARN of an IAM role that's associated with the stack.

    • stackId

      public final String stackId()

      Unique identifier of the stack.

      Returns:
      Unique identifier of the stack.

    • stackName

      public final String stackName()

      The name associated with the stack.

      Returns:
      The name associated with the stack.

    • stackStatus

      public final String stackStatus()

      Current status of the stack.

      Returns:
      Current status of the stack.

    • stackStatusReason

      public final String stackStatusReason()

      Success or failure message associated with the stack status.

      Returns:
      Success or failure message associated with the stack status.

    • timeoutInMinutes

      public final Integer timeoutInMinutes()

      The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

      Returns:
      The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

    • toBuilder

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

    • builder

      public static AwsCloudFormationStackDetails.Builder builder()

    • serializableBuilderClass

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