1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package docdb
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/docdb/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Modifies settings for an instance. You can change one or more database
// configuration parameters by specifying these parameters and the new values in
// the request.
func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceInput, optFns ...func(*Options)) (*ModifyDBInstanceOutput, error) {
if params == nil {
params = &ModifyDBInstanceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ModifyDBInstance", params, optFns, c.addOperationModifyDBInstanceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ModifyDBInstanceOutput)
out.ResultMetadata = metadata
return out, nil
}
// Represents the input to ModifyDBInstance .
type ModifyDBInstanceInput struct {
// The instance identifier. This value is stored as a lowercase string.
// Constraints:
// - Must match the identifier of an existing DBInstance .
//
// This member is required.
DBInstanceIdentifier *string
// Specifies whether the modifications in this request and any pending
// modifications are asynchronously applied as soon as possible, regardless of the
// PreferredMaintenanceWindow setting for the instance. If this parameter is set to
// false , changes to the instance are applied during the next maintenance window.
// Some parameter changes can cause an outage and are applied on the next reboot.
// Default: false
ApplyImmediately *bool
// This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not
// perform minor version upgrades regardless of the value set.
AutoMinorVersionUpgrade *bool
// Indicates the certificate that needs to be associated with the instance.
CACertificateIdentifier *string
// Specifies whether the DB instance is restarted when you rotate your SSL/TLS
// certificate. By default, the DB instance is restarted when you rotate your
// SSL/TLS certificate. The certificate is not updated until the DB instance is
// restarted. Set this parameter only if you are not using SSL/TLS to connect to
// the DB instance. If you are using SSL/TLS to connect to the DB instance, see
// Updating Your Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)
// and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)
// in the Amazon DocumentDB Developer Guide.
CertificateRotationRestart *bool
// A value that indicates whether to copy all tags from the DB instance to
// snapshots of the DB instance. By default, tags are not copied.
CopyTagsToSnapshot *bool
// The new compute and memory capacity of the instance; for example, db.r5.large .
// Not all instance classes are available in all Amazon Web Services Regions. If
// you modify the instance class, an outage occurs during the change. The change is
// applied during the next maintenance window, unless ApplyImmediately is
// specified as true for this request. Default: Uses existing setting.
DBInstanceClass *string
// A value that indicates whether to enable Performance Insights for the DB
// Instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)
// .
EnablePerformanceInsights *bool
// The new instance identifier for the instance when renaming an instance. When
// you change the instance identifier, an instance reboot occurs immediately if you
// set Apply Immediately to true . It occurs during the next maintenance window if
// you set Apply Immediately to false . This value is stored as a lowercase string.
// Constraints:
// - Must contain from 1 to 63 letters, numbers, or hyphens.
// - The first character must be a letter.
// - Cannot end with a hyphen or contain two consecutive hyphens.
// Example: mydbinstance
NewDBInstanceIdentifier *string
// The KMS key identifier for encryption of Performance Insights data. The KMS key
// identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If
// you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
// DocumentDB uses your default KMS key. There is a default KMS key for your Amazon
// Web Services account. Your Amazon Web Services account has a different default
// KMS key for each Amazon Web Services region.
PerformanceInsightsKMSKeyId *string
// The weekly time range (in UTC) during which system maintenance can occur, which
// might result in an outage. Changing this parameter doesn't result in an outage
// except in the following situation, and the change is asynchronously applied as
// soon as possible. If there are pending actions that cause a reboot, and the
// maintenance window is changed to include the current time, changing this
// parameter causes a reboot of the instance. If you are moving this window to the
// current time, there must be at least 30 minutes between the current time and end
// of the window to ensure that pending changes are applied. Default: Uses existing
// setting. Format: ddd:hh24:mi-ddd:hh24:mi Valid days: Mon, Tue, Wed, Thu, Fri,
// Sat, Sun Constraints: Must be at least 30 minutes.
PreferredMaintenanceWindow *string
// A value that specifies the order in which an Amazon DocumentDB replica is
// promoted to the primary instance after a failure of the existing primary
// instance. Default: 1 Valid values: 0-15
PromotionTier *int32
noSmithyDocumentSerde
}
type ModifyDBInstanceOutput struct {
// Detailed information about an instance.
DBInstance *types.DBInstance
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationModifyDBInstanceMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpModifyDBInstance{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpModifyDBInstance{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ModifyDBInstance"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpModifyDBInstanceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opModifyDBInstance(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opModifyDBInstance(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ModifyDBInstance",
}
}
|