1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package cloudformation
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/cloudformation/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Sends a signal to the specified resource with a success or failure status. You
15// can use the SignalResource API in conjunction with a creation policy or update
16// policy. AWS CloudFormation doesn't proceed with a stack creation or update until
17// resources receive the required number of signals or the timeout period is
18// exceeded. The SignalResource API is useful in cases where you want to send
19// signals from anywhere other than an Amazon EC2 instance.
20func (c *Client) SignalResource(ctx context.Context, params *SignalResourceInput, optFns ...func(*Options)) (*SignalResourceOutput, error) {
21	if params == nil {
22		params = &SignalResourceInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "SignalResource", params, optFns, addOperationSignalResourceMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*SignalResourceOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35// The input for the SignalResource action.
36type SignalResourceInput struct {
37
38	// The logical ID of the resource that you want to signal. The logical ID is the
39	// name of the resource that given in the template.
40	//
41	// This member is required.
42	LogicalResourceId *string
43
44	// The stack name or unique stack ID that includes the resource that you want to
45	// signal.
46	//
47	// This member is required.
48	StackName *string
49
50	// The status of the signal, which is either success or failure. A failure signal
51	// causes AWS CloudFormation to immediately fail the stack creation or update.
52	//
53	// This member is required.
54	Status types.ResourceSignalStatus
55
56	// A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling
57	// groups, specify the instance ID that you are signaling as the unique ID. If you
58	// send multiple signals to a single resource (such as signaling a wait condition),
59	// each signal requires a different unique ID.
60	//
61	// This member is required.
62	UniqueId *string
63}
64
65type SignalResourceOutput struct {
66	// Metadata pertaining to the operation's result.
67	ResultMetadata middleware.Metadata
68}
69
70func addOperationSignalResourceMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsquery_serializeOpSignalResource{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpSignalResource{}, middleware.After)
76	if err != nil {
77		return err
78	}
79	if err = addSetLoggerMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
83		return err
84	}
85	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
86		return err
87	}
88	if err = addResolveEndpointMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
92		return err
93	}
94	if err = addRetryMiddlewares(stack, options); err != nil {
95		return err
96	}
97	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
104		return err
105	}
106	if err = addClientUserAgent(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addOpSignalResourceValidationMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSignalResource(options.Region), middleware.Before); err != nil {
119		return err
120	}
121	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addResponseErrorMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addRequestResponseLogging(stack, options); err != nil {
128		return err
129	}
130	return nil
131}
132
133func newServiceMetadataMiddleware_opSignalResource(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "cloudformation",
138		OperationName: "SignalResource",
139	}
140}
141