AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a Hook invocation, its status, and the reason for its status.

Inheritance Hierarchy

System.Object
  Amazon.CloudFormation.Model.HookResultSummary

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C#
public class HookResultSummary

The HookResultSummary type exposes the following members

Constructors

NameDescription
Public Method HookResultSummary()

Properties

NameTypeDescription
Public Property FailureMode Amazon.CloudFormation.HookFailureMode

Gets and sets the property FailureMode.

The failure mode of the invocation.

Public Property HookExecutionTarget System.String

Gets and sets the property HookExecutionTarget.

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

Public Property HookResultId System.String

Gets and sets the property HookResultId.

The unique identifier for this Hook invocation result.

Public Property HookStatusReason System.String

Gets and sets the property 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.

Public Property InvocationPoint Amazon.CloudFormation.HookInvocationPoint

Gets and sets the property InvocationPoint.

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

Public Property InvokedAt System.Nullable<System.DateTime>

Gets and sets the property InvokedAt.

The timestamp when the Hook was invoked.

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

Public Property Status Amazon.CloudFormation.HookStatus

Gets and sets the property 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.

Public Property TargetId System.String

Gets and sets the property TargetId.

The unique identifier of the Hook invocation target.

Public Property TargetType Amazon.CloudFormation.ListHookResultsTargetType

Gets and sets the property TargetType.

The target type that the Hook was invoked against.

Public Property TypeArn System.String

Gets and sets the property TypeArn.

The ARN of the Hook that was invoked.

Public Property TypeConfigurationVersionId System.String

Gets and sets the property TypeConfigurationVersionId.

The version of the Hook configuration.

Public Property TypeName System.String

Gets and sets the property TypeName.

The name of the Hook that was invoked.

Public Property TypeVersionId System.String

Gets and sets the property TypeVersionId.

The version of the Hook that was invoked.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer