1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package rds 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/rds/types" 10 "github.com/aws/smithy-go/middleware" 11 smithyhttp "github.com/aws/smithy-go/transport/http" 12) 13 14// Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains 15// the DB instance's metadata, including its endpoint, DB parameter group, and 16// option group membership. Amazon RDS also retains the transaction logs so you can 17// do a point-in-time restore if necessary. For more information, see 18// 19// Stopping an 20// Amazon RDS DB Instance Temporarily 21// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html) 22// in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and 23// Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead. 24func (c *Client) StopDBInstance(ctx context.Context, params *StopDBInstanceInput, optFns ...func(*Options)) (*StopDBInstanceOutput, error) { 25 if params == nil { 26 params = &StopDBInstanceInput{} 27 } 28 29 result, metadata, err := c.invokeOperation(ctx, "StopDBInstance", params, optFns, addOperationStopDBInstanceMiddlewares) 30 if err != nil { 31 return nil, err 32 } 33 34 out := result.(*StopDBInstanceOutput) 35 out.ResultMetadata = metadata 36 return out, nil 37} 38 39type StopDBInstanceInput struct { 40 41 // The user-supplied instance identifier. 42 // 43 // This member is required. 44 DBInstanceIdentifier *string 45 46 // The user-supplied instance identifier of the DB Snapshot created immediately 47 // before the DB instance is stopped. 48 DBSnapshotIdentifier *string 49} 50 51type StopDBInstanceOutput struct { 52 53 // Contains the details of an Amazon RDS DB instance. This data type is used as a 54 // response element in the DescribeDBInstances action. 55 DBInstance *types.DBInstance 56 57 // Metadata pertaining to the operation's result. 58 ResultMetadata middleware.Metadata 59} 60 61func addOperationStopDBInstanceMiddlewares(stack *middleware.Stack, options Options) (err error) { 62 err = stack.Serialize.Add(&awsAwsquery_serializeOpStopDBInstance{}, middleware.After) 63 if err != nil { 64 return err 65 } 66 err = stack.Deserialize.Add(&awsAwsquery_deserializeOpStopDBInstance{}, middleware.After) 67 if err != nil { 68 return err 69 } 70 if err = addSetLoggerMiddleware(stack, options); err != nil { 71 return err 72 } 73 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 74 return err 75 } 76 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 77 return err 78 } 79 if err = addResolveEndpointMiddleware(stack, options); err != nil { 80 return err 81 } 82 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 83 return err 84 } 85 if err = addRetryMiddlewares(stack, options); err != nil { 86 return err 87 } 88 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 89 return err 90 } 91 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 92 return err 93 } 94 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 95 return err 96 } 97 if err = addClientUserAgent(stack); err != nil { 98 return err 99 } 100 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 101 return err 102 } 103 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 104 return err 105 } 106 if err = addOpStopDBInstanceValidationMiddleware(stack); err != nil { 107 return err 108 } 109 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStopDBInstance(options.Region), middleware.Before); err != nil { 110 return err 111 } 112 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 113 return err 114 } 115 if err = addResponseErrorMiddleware(stack); err != nil { 116 return err 117 } 118 if err = addRequestResponseLogging(stack, options); err != nil { 119 return err 120 } 121 return nil 122} 123 124func newServiceMetadataMiddleware_opStopDBInstance(region string) *awsmiddleware.RegisterServiceMetadata { 125 return &awsmiddleware.RegisterServiceMetadata{ 126 Region: region, 127 ServiceID: ServiceID, 128 SigningName: "rds", 129 OperationName: "StopDBInstance", 130 } 131} 132