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

Interface HookResultSummary.Builder

    • Method Detail

      • invocationPoint

        HookResultSummary.Builder invocationPoint​(String invocationPoint)

        The exact point in the provisioning logic where the Hook runs.

        Parameters:
        invocationPoint - The exact point in the provisioning logic where the Hook runs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HookInvocationPoint, HookInvocationPoint

      • failureMode

        HookResultSummary.Builder failureMode​(String failureMode)

        The failure mode of the invocation. The following are potential modes:

        • FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

        • WARN: If the hook invocation returns a failure, then the requested target operation should warn.

        Parameters:
        failureMode - The failure mode of the invocation. The following are potential modes:

        • FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

        • WARN: If the hook invocation returns a failure, then the requested target operation should warn.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HookFailureMode, HookFailureMode

      • failureMode

        HookResultSummary.Builder failureMode​(HookFailureMode failureMode)

        The failure mode of the invocation. The following are potential modes:

        • FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

        • WARN: If the hook invocation returns a failure, then the requested target operation should warn.

        Parameters:
        failureMode - The failure mode of the invocation. The following are potential modes:

        • FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

        • WARN: If the hook invocation returns a failure, then the requested target operation should warn.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HookFailureMode, HookFailureMode

      • typeName

        HookResultSummary.Builder typeName​(String typeName)

        The type name of the Hook being invoked.

        Parameters:
        typeName - The type name of the Hook being invoked.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • typeVersionId

        HookResultSummary.Builder typeVersionId​(String typeVersionId)

        The version of the Hook being invoked.

        Parameters:
        typeVersionId - The version of the Hook being invoked.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • typeConfigurationVersionId

        HookResultSummary.Builder typeConfigurationVersionId​(String typeConfigurationVersionId)

        The version of the Hook type configuration.

        Parameters:
        typeConfigurationVersionId - The version of the Hook type configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        HookResultSummary.Builder status​(String status)

        The state of the Hook invocation.

        Parameters:
        status - The state of the Hook invocation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HookStatus, HookStatus

      • status

        HookResultSummary.Builder status​(HookStatus status)

        The state of the Hook invocation.

        Parameters:
        status - The state of the Hook invocation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HookStatus, HookStatus

      • hookStatusReason

        HookResultSummary.Builder hookStatusReason​(String hookStatusReason)

        A description of the Hook results status. For example, if the Hook result is in a FAILED state, this may contain additional information for the FAILED state.

        Parameters:
        hookStatusReason - A description of the Hook results status. For example, if the Hook result is in a FAILED state, this may contain additional information for the FAILED state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.