software.amazon.awssdk.services.cloudformation.model

Class StackEvent

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.StackEvent

All Implemented Interfaces:

ToCopyableBuilder<StackEvent.Builder,StackEvent>

@Generated(value="software.amazon.awssdk:codegen")
public final class StackEvent
extends Object
implements ToCopyableBuilder<StackEvent.Builder,StackEvent>

The StackEvent data type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StackEvent.Builder

Method Summary

Modifier and Type	Method and Description
static StackEvent.Builder	builder()
String	clientRequestToken() The token passed to the operation that generated this event.
boolean	equals(Object obj)
String	eventId() The unique ID of this event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	logicalResourceId() The logical name of the resource specified in the template.
String	physicalResourceId() The name or unique identifier associated with the physical instance of the resource.
String	resourceProperties() BLOB of the properties used to create the resource.
ResourceStatus	resourceStatus() Current status of the resource.
String	resourceStatusAsString() Current status of the resource.
String	resourceStatusReason() Success/failure message associated with the resource.
String	resourceType() Type of resource.
static Class<? extends StackEvent.Builder>	serializableBuilderClass()
String	stackId() The unique ID name of the instance of the stack.
String	stackName() The name associated with a stack.
Instant	timestamp() Time the status was updated.
StackEvent.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

stackId

public String stackId()

The unique ID name of the instance of the stack.

Returns:

The unique ID name of the instance of the stack.

eventId

public String eventId()

The unique ID of this event.

Returns:

The unique ID of this event.

stackName

public String stackName()

The name associated with a stack.

Returns:

The name associated with a stack.

logicalResourceId

public String logicalResourceId()

The logical name of the resource specified in the template.

Returns:

The logical name of the resource specified in the template.

physicalResourceId

public String physicalResourceId()

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

Returns:

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

resourceType

public String resourceType()

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

Returns:

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

timestamp

public Instant timestamp()

Time the status was updated.

Returns:

Time the status was updated.

resourceStatus

public ResourceStatus resourceStatus()

Current status of the resource.

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

Returns:

Current status of the resource.

See Also:

ResourceStatus

resourceStatusAsString

public String resourceStatusAsString()

Current status of the resource.

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

Returns:

Current status of the resource.

See Also:

ResourceStatus

resourceStatusReason

public String resourceStatusReason()

Success/failure message associated with the resource.

Returns:

Success/failure message associated with the resource.

resourceProperties

public String resourceProperties()

BLOB of the properties used to create the resource.

Returns:

BLOB of the properties used to create the resource.

clientRequestToken

public String 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.

Returns:

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.

toBuilder

public StackEvent.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StackEvent.Builder,StackEvent>

Returns:

a builder for type T

builder

public static StackEvent.Builder builder()

serializableBuilderClass

public static Class<? extends StackEvent.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)