Package software.amazon.awssdk.services.cloudformation.model

Interface StackEvent.Builder

    • 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 identifier of this event.

        Parameters:
        eventId - The unique identifier 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.

      • operationId

        StackEvent.Builder operationId​(String operationId)

        The unique identifier of the operation that generated this stack event.

        Parameters:
        operationId - The unique identifier of the operation that generated this stack event.
        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.

      • 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)

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

        Parameters:
        hookInvocationPoint - 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

      • hookInvocationPoint

        StackEvent.Builder hookInvocationPoint​(HookInvocationPoint hookInvocationPoint)

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

        Parameters:
        hookInvocationPoint - 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

      • hookInvocationId

        StackEvent.Builder hookInvocationId​(String hookInvocationId)

        The unique identifier of the Hook invocation.

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

      • 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

      • detailedStatus

        StackEvent.Builder detailedStatus​(String detailedStatus)

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

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

        Parameters:
        detailedStatus - An optional field that contains information about the detailed status of the stack event.

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

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

      • detailedStatus

        StackEvent.Builder detailedStatus​(DetailedStatus detailedStatus)

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

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

        Parameters:
        detailedStatus - An optional field that contains information about the detailed status of the stack event.

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

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