Interface HookResultSummary.Builder

    • Method Detail

      • hookResultId

        HookResultSummary.Builder hookResultId​(String hookResultId)

        The unique identifier for this Hook invocation result.

        Parameters:
        hookResultId - The unique identifier for this Hook invocation result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • invocationPoint

        HookResultSummary.Builder invocationPoint​(String invocationPoint)

        The specific point in the provisioning process where the Hook is invoked.

        Parameters:
        invocationPoint - The specific point in the provisioning process where the Hook is invoked.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HookInvocationPoint, HookInvocationPoint
      • invocationPoint

        HookResultSummary.Builder invocationPoint​(HookInvocationPoint invocationPoint)

        The specific point in the provisioning process where the Hook is invoked.

        Parameters:
        invocationPoint - The specific point in the provisioning process where the Hook is invoked.
        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.

        Parameters:
        failureMode - The failure mode of the invocation.
        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 name of the Hook that was invoked.

        Parameters:
        typeName - The name of the Hook that was 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 that was invoked.

        Parameters:
        typeVersionId - The version of the Hook that was 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 configuration.

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

        HookResultSummary.Builder status​(String status)

        The status of the Hook invocation. The following statuses are possible:

        • HOOK_IN_PROGRESS: The Hook is currently running.

        • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

        • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

        • HOOK_FAILED: The Hook encountered an error during execution.

        Parameters:
        status - The status of the Hook invocation. The following statuses are possible:

        • HOOK_IN_PROGRESS: The Hook is currently running.

        • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

        • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

        • HOOK_FAILED: The Hook encountered an error during execution.

        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 status of the Hook invocation. The following statuses are possible:

        • HOOK_IN_PROGRESS: The Hook is currently running.

        • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

        • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

        • HOOK_FAILED: The Hook encountered an error during execution.

        Parameters:
        status - The status of the Hook invocation. The following statuses are possible:

        • HOOK_IN_PROGRESS: The Hook is currently running.

        • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

        • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

        • HOOK_FAILED: The Hook encountered an error during execution.

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

        HookResultSummary.Builder invokedAt​(Instant invokedAt)

        The timestamp when the Hook was invoked.

        Only shown in responses when the request does not specify TargetType and TargetId filters.

        Parameters:
        invokedAt - The timestamp when the Hook was invoked.

        Only shown in responses when the request does not specify TargetType and TargetId filters.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • targetId

        HookResultSummary.Builder targetId​(String targetId)

        The unique identifier of the Hook invocation target.

        Parameters:
        targetId - The unique identifier of the Hook invocation target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • typeArn

        HookResultSummary.Builder typeArn​(String typeArn)

        The ARN of the Hook that was invoked.

        Parameters:
        typeArn - The ARN of the Hook that was invoked.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • hookExecutionTarget

        HookResultSummary.Builder hookExecutionTarget​(String hookExecutionTarget)

        The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.

        Only shown in responses when the request does not specify TargetType and TargetId filters.

        Parameters:
        hookExecutionTarget - The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.

        Only shown in responses when the request does not specify TargetType and TargetId filters.

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