api_op_GetRelationalDatabaseMasterUserPassword.go raw
1 // Code generated by smithy-go-codegen DO NOT EDIT.
2
3 package lightsail
4
5 import (
6 "context"
7 "fmt"
8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9 "github.com/aws/aws-sdk-go-v2/service/lightsail/types"
10 "github.com/aws/smithy-go/middleware"
11 smithyhttp "github.com/aws/smithy-go/transport/http"
12 "time"
13 )
14
15 // Returns the current, previous, or pending versions of the master user password
16 // for a Lightsail database.
17 //
18 // The GetRelationalDatabaseMasterUserPassword operation supports tag-based access
19 // control via resource tags applied to the resource identified by
20 // relationalDatabaseName.
21 func (c *Client) GetRelationalDatabaseMasterUserPassword(ctx context.Context, params *GetRelationalDatabaseMasterUserPasswordInput, optFns ...func(*Options)) (*GetRelationalDatabaseMasterUserPasswordOutput, error) {
22 if params == nil {
23 params = &GetRelationalDatabaseMasterUserPasswordInput{}
24 }
25
26 result, metadata, err := c.invokeOperation(ctx, "GetRelationalDatabaseMasterUserPassword", params, optFns, c.addOperationGetRelationalDatabaseMasterUserPasswordMiddlewares)
27 if err != nil {
28 return nil, err
29 }
30
31 out := result.(*GetRelationalDatabaseMasterUserPasswordOutput)
32 out.ResultMetadata = metadata
33 return out, nil
34 }
35
36 type GetRelationalDatabaseMasterUserPasswordInput struct {
37
38 // The name of your database for which to get the master user password.
39 //
40 // This member is required.
41 RelationalDatabaseName *string
42
43 // The password version to return.
44 //
45 // Specifying CURRENT or PREVIOUS returns the current or previous passwords
46 // respectively. Specifying PENDING returns the newest version of the password
47 // that will rotate to CURRENT . After the PENDING password rotates to CURRENT ,
48 // the PENDING password is no longer available.
49 //
50 // Default: CURRENT
51 PasswordVersion types.RelationalDatabasePasswordVersion
52
53 noSmithyDocumentSerde
54 }
55
56 type GetRelationalDatabaseMasterUserPasswordOutput struct {
57
58 // The timestamp when the specified version of the master user password was
59 // created.
60 CreatedAt *time.Time
61
62 // The master user password for the password version specified.
63 MasterUserPassword *string
64
65 // Metadata pertaining to the operation's result.
66 ResultMetadata middleware.Metadata
67
68 noSmithyDocumentSerde
69 }
70
71 func (c *Client) addOperationGetRelationalDatabaseMasterUserPasswordMiddlewares(stack *middleware.Stack, options Options) (err error) {
72 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
73 return err
74 }
75 err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetRelationalDatabaseMasterUserPassword{}, middleware.After)
76 if err != nil {
77 return err
78 }
79 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetRelationalDatabaseMasterUserPassword{}, middleware.After)
80 if err != nil {
81 return err
82 }
83 if err := addProtocolFinalizerMiddlewares(stack, options, "GetRelationalDatabaseMasterUserPassword"); err != nil {
84 return fmt.Errorf("add protocol finalizers: %v", err)
85 }
86
87 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
88 return err
89 }
90 if err = addSetLoggerMiddleware(stack, options); err != nil {
91 return err
92 }
93 if err = addClientRequestID(stack); err != nil {
94 return err
95 }
96 if err = addComputeContentLength(stack); err != nil {
97 return err
98 }
99 if err = addResolveEndpointMiddleware(stack, options); err != nil {
100 return err
101 }
102 if err = addComputePayloadSHA256(stack); err != nil {
103 return err
104 }
105 if err = addRetry(stack, options); err != nil {
106 return err
107 }
108 if err = addRawResponseToMetadata(stack); err != nil {
109 return err
110 }
111 if err = addRecordResponseTiming(stack); err != nil {
112 return err
113 }
114 if err = addSpanRetryLoop(stack, options); err != nil {
115 return err
116 }
117 if err = addClientUserAgent(stack, options); err != nil {
118 return err
119 }
120 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
121 return err
122 }
123 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
124 return err
125 }
126 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
127 return err
128 }
129 if err = addTimeOffsetBuild(stack, c); err != nil {
130 return err
131 }
132 if err = addUserAgentRetryMode(stack, options); err != nil {
133 return err
134 }
135 if err = addCredentialSource(stack, options); err != nil {
136 return err
137 }
138 if err = addOpGetRelationalDatabaseMasterUserPasswordValidationMiddleware(stack); err != nil {
139 return err
140 }
141 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRelationalDatabaseMasterUserPassword(options.Region), middleware.Before); err != nil {
142 return err
143 }
144 if err = addRecursionDetection(stack); err != nil {
145 return err
146 }
147 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
148 return err
149 }
150 if err = addResponseErrorMiddleware(stack); err != nil {
151 return err
152 }
153 if err = addRequestResponseLogging(stack, options); err != nil {
154 return err
155 }
156 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
157 return err
158 }
159 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
160 return err
161 }
162 if err = addInterceptAttempt(stack, options); err != nil {
163 return err
164 }
165 if err = addInterceptors(stack, options); err != nil {
166 return err
167 }
168 return nil
169 }
170
171 func newServiceMetadataMiddleware_opGetRelationalDatabaseMasterUserPassword(region string) *awsmiddleware.RegisterServiceMetadata {
172 return &awsmiddleware.RegisterServiceMetadata{
173 Region: region,
174 ServiceID: ServiceID,
175 OperationName: "GetRelationalDatabaseMasterUserPassword",
176 }
177 }
178