software.amazon.awssdk.services.cloudformation.model

Interface StackEvent.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StackEvent.Builder,StackEvent>, SdkBuilder<StackEvent.Builder,StackEvent>, SdkPojo

Enclosing class:

StackEvent

public static interface StackEvent.Builder
extends SdkPojo, CopyableBuilder<StackEvent.Builder,StackEvent>

Method Summary

Modifier and Type	Method and Description
StackEvent.Builder	clientRequestToken(String clientRequestToken) The token passed to the operation that generated this event.
StackEvent.Builder	eventId(String eventId) The unique ID of this event.
StackEvent.Builder	hookFailureMode(HookFailureMode hookFailureMode) Specify the hook failure mode for non-compliant resources in the followings ways.
StackEvent.Builder	hookFailureMode(String hookFailureMode) Specify the hook failure mode for non-compliant resources in the followings ways.
StackEvent.Builder	hookInvocationPoint(HookInvocationPoint hookInvocationPoint) Invocation points are points in provisioning logic where hooks are initiated.
StackEvent.Builder	hookInvocationPoint(String hookInvocationPoint) Invocation points are points in provisioning logic where hooks are initiated.
StackEvent.Builder	hookStatus(HookStatus hookStatus) Provides the status of the change set hook.
StackEvent.Builder	hookStatus(String hookStatus) Provides the status of the change set hook.
StackEvent.Builder	hookStatusReason(String hookStatusReason) Provides the reason for the hook status.
StackEvent.Builder	hookType(String hookType) The name of the hook.
StackEvent.Builder	logicalResourceId(String logicalResourceId) The logical name of the resource specified in the template.
StackEvent.Builder	physicalResourceId(String physicalResourceId) The name or unique identifier associated with the physical instance of the resource.
StackEvent.Builder	resourceProperties(String resourceProperties) BLOB of the properties used to create the resource.
StackEvent.Builder	resourceStatus(ResourceStatus resourceStatus) Current status of the resource.
StackEvent.Builder	resourceStatus(String resourceStatus) Current status of the resource.
StackEvent.Builder	resourceStatusReason(String resourceStatusReason) Success/failure message associated with the resource.
StackEvent.Builder	resourceType(String resourceType) Type of resource.
StackEvent.Builder	stackId(String stackId) The unique ID name of the instance of the stack.
StackEvent.Builder	stackName(String stackName) The name associated with a stack.
StackEvent.Builder	timestamp(Instant timestamp) Time the status was updated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

stackId

StackEvent.Builder stackId(String stackId)

The unique ID name of the instance of the stack.

Parameters:

stackId - The unique ID name of the instance of the stack.

Returns:

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

eventId

StackEvent.Builder eventId(String eventId)

The unique ID of this event.

Parameters:

eventId - The unique ID of this event.

Returns:

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

stackName

StackEvent.Builder stackName(String stackName)

The name associated with a stack.

Parameters:

stackName - The name associated with a stack.

Returns:

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

logicalResourceId

StackEvent.Builder logicalResourceId(String logicalResourceId)

The logical name of the resource specified in the template.

Parameters:

logicalResourceId - The logical name of the resource specified in the template.

Returns:

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

physicalResourceId

StackEvent.Builder physicalResourceId(String physicalResourceId)

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

Parameters:

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

Returns:

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

resourceType

StackEvent.Builder resourceType(String resourceType)

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

Parameters:

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

Returns:

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

timestamp

StackEvent.Builder timestamp(Instant timestamp)

Time the status was updated.

Parameters:

timestamp - Time the status was updated.

Returns:

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

resourceStatus

StackEvent.Builder resourceStatus(String resourceStatus)

Current status of the resource.

Parameters:

resourceStatus - Current status of the resource.

Returns:

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

See Also:

ResourceStatus, ResourceStatus

resourceStatus

StackEvent.Builder resourceStatus(ResourceStatus resourceStatus)

Current status of the resource.

Parameters:

resourceStatus - Current status of the resource.

Returns:

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

See Also:

ResourceStatus, ResourceStatus

resourceStatusReason

StackEvent.Builder resourceStatusReason(String resourceStatusReason)

Success/failure message associated with the resource.

Parameters:

resourceStatusReason - Success/failure message associated with the resource.

Returns:

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

resourceProperties

StackEvent.Builder resourceProperties(String resourceProperties)

BLOB of the properties used to create the resource.

Parameters:

resourceProperties - BLOB of the properties used to create the resource.

Returns:

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

clientRequestToken

StackEvent.Builder clientRequestToken(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.

Parameters:

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:

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

hookType

StackEvent.Builder hookType(String hookType)

The name of the hook.

Parameters:

hookType - The name of the hook.

Returns:

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

hookStatus

StackEvent.Builder hookStatus(String hookStatus)

Provides the status of the change set hook.

Parameters:

hookStatus - Provides the status of the change set hook.

Returns:

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

See Also:

HookStatus, HookStatus

hookStatus

StackEvent.Builder hookStatus(HookStatus hookStatus)

Provides the status of the change set hook.

Parameters:

hookStatus - Provides the status of the change set hook.

Returns:

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

See Also:

HookStatus, HookStatus

hookStatusReason

StackEvent.Builder hookStatusReason(String hookStatusReason)

Provides the reason for the hook status.

Parameters:

hookStatusReason - Provides the reason for the hook status.

Returns:

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

hookInvocationPoint

StackEvent.Builder hookInvocationPoint(String hookInvocationPoint)

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

Parameters:

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

Returns:

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

See Also:

HookInvocationPoint, HookInvocationPoint

hookInvocationPoint

StackEvent.Builder hookInvocationPoint(HookInvocationPoint hookInvocationPoint)

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

Parameters:

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

Returns:

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

See Also:

HookInvocationPoint, HookInvocationPoint

hookFailureMode

StackEvent.Builder hookFailureMode(String 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.

Parameters:

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.

Returns:

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

See Also:

HookFailureMode, HookFailureMode

hookFailureMode

StackEvent.Builder hookFailureMode(HookFailureMode 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.

Parameters:

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.

Returns:

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

See Also:

HookFailureMode, HookFailureMode