Class ResourceChange

    • Method Detail

      • logicalResourceId

        public final String logicalResourceId()

        The ID of the resource, as defined in the CloudFormation template.

        Returns:
        The ID of the resource, as defined in the CloudFormation template.
      • physicalResourceId

        public final String physicalResourceId()

        The ID of the resource, if it was already created.

        Returns:
        The ID of the resource, if it was already created.
      • resourceType

        public final String resourceType()

        The type of resource.

        Returns:
        The type of resource.
      • replacement

        public final Replacement replacement()

        If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

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

        Returns:
        If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.
        See Also:
        Replacement
      • replacementAsString

        public final String replacementAsString()

        If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

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

        Returns:
        If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.
        See Also:
        Replacement
      • scope

        public final List<ResourceAttribute> scope()

        The change scope.

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

        Returns:
        The change scope.
      • hasScope

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

        public final List<String> scopeAsStrings()

        The change scope.

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

        Returns:
        The change scope.
      • hasDetails

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

        public final List<ResourceChangeDetail> details()

        Information about the resource changes.

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

        Returns:
        Information about the resource changes.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)