AWS SDK Version 3 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.

The StackEvent data type.

Inheritance Hierarchy

System.Object
  Amazon.CloudFormation.Model.StackEvent

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

Syntax

C#
public class StackEvent

The StackEvent type exposes the following members

Constructors

NameDescription
Public Method StackEvent()

Properties

NameTypeDescription
Public Property ClientRequestToken System.String

Gets and sets the property ClientRequestToken.

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

Public Property DetailedStatus Amazon.CloudFormation.DetailedStatus

Gets and sets the property DetailedStatus.

An optional field containing information about the detailed status of the stack event.

  • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

  • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

Public Property EventId System.String

Gets and sets the property EventId.

The unique ID of this event.

Public Property HookFailureMode Amazon.CloudFormation.HookFailureMode

Gets and sets the property HookFailureMode.

Specify the hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.

Public Property HookInvocationPoint Amazon.CloudFormation.HookInvocationPoint

Gets and sets the property HookInvocationPoint.

Invocation points are points in provisioning logic where hooks are initiated.

Public Property HookStatus Amazon.CloudFormation.HookStatus

Gets and sets the property HookStatus.

Provides the status of the change set hook.

Public Property HookStatusReason System.String

Gets and sets the property HookStatusReason.

Provides the reason for the hook status.

Public Property HookType System.String

Gets and sets the property HookType.

The name of the hook.

Public Property LogicalResourceId System.String

Gets and sets the property LogicalResourceId.

The logical name of the resource specified in the template.

Public Property PhysicalResourceId System.String

Gets and sets the property PhysicalResourceId.

The name or unique identifier associated with the physical instance of the resource.

Public Property ResourceProperties System.String

Gets and sets the property ResourceProperties.

BLOB of the properties used to create the resource.

Public Property ResourceStatus Amazon.CloudFormation.ResourceStatus

Gets and sets the property ResourceStatus.

Current status of the resource.

Public Property ResourceStatusReason System.String

Gets and sets the property ResourceStatusReason.

Success/failure message associated with the resource.

Public Property ResourceType System.String

Gets and sets the property ResourceType.

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

Public Property StackId System.String

Gets and sets the property StackId.

The unique ID name of the instance of the stack.

Public Property StackName System.String

Gets and sets the property StackName.

The name associated with a stack.

Public Property Timestamp System.DateTime

Gets and sets the property Timestamp.

Time the status was updated.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5