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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package neptune
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/neptune/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Modify a setting for a DB cluster. You can change one or more database
// configuration parameters by specifying these parameters and the new values in
// the request.
func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInput, optFns ...func(*Options)) (*ModifyDBClusterOutput, error) {
if params == nil {
params = &ModifyDBClusterInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ModifyDBCluster", params, optFns, c.addOperationModifyDBClusterMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ModifyDBClusterOutput)
out.ResultMetadata = metadata
return out, nil
}
type ModifyDBClusterInput struct {
// The DB cluster identifier for the cluster being modified. This parameter is not
// case-sensitive.
//
// Constraints:
//
// - Must match the identifier of an existing DBCluster.
//
// This member is required.
DBClusterIdentifier *string
// A value that indicates whether upgrades between different major versions are
// allowed.
//
// Constraints: You must set the allow-major-version-upgrade flag when providing
// an EngineVersion parameter that uses a different major version than the DB
// cluster's current version.
AllowMajorVersionUpgrade *bool
// A value that 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 DB cluster. If this parameter
// is set to false , changes to the DB cluster are applied during the next
// maintenance window.
//
// The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If
// you set the ApplyImmediately parameter value to false, then changes to
// NewDBClusterIdentifier values are applied during the next maintenance window.
// All other changes are applied immediately, regardless of the value of the
// ApplyImmediately parameter.
//
// Default: false
ApplyImmediately *bool
// The number of days for which automated backups are retained. You must specify a
// minimum value of 1.
//
// Default: 1
//
// Constraints:
//
// - Must be a value from 1 to 35
BackupRetentionPeriod *int32
// The configuration setting for the log types to be enabled for export to
// CloudWatch Logs for a specific DB cluster. See [Using the CLI to publish Neptune audit logs to CloudWatch Logs].
//
// [Using the CLI to publish Neptune audit logs to CloudWatch Logs]: https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli
CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration
// If set to true , tags are copied to any snapshot of the DB cluster that is
// created.
CopyTagsToSnapshot *bool
// The name of the DB cluster parameter group to use for the DB cluster.
DBClusterParameterGroupName *string
// The name of the DB parameter group to apply to all instances of the DB cluster.
//
// When you apply a parameter group using DBInstanceParameterGroupName , parameter
// changes aren't applied during the next maintenance window but instead are
// applied immediately.
//
// Default: The existing name setting
//
// Constraints:
//
// - The DB parameter group must be in the same DB parameter group family as the
// target DB cluster version.
//
// - The DBInstanceParameterGroupName parameter is only valid in combination with
// the AllowMajorVersionUpgrade parameter.
DBInstanceParameterGroupName *string
// A value that indicates whether the DB cluster has deletion protection enabled.
// The database can't be deleted when deletion protection is enabled. By default,
// deletion protection is disabled.
DeletionProtection *bool
// True to enable mapping of Amazon Identity and Access Management (IAM) accounts
// to database accounts, and otherwise false.
//
// Default: false
EnableIAMDatabaseAuthentication *bool
// The version number of the database engine to which you want to upgrade.
// Changing this parameter results in an outage. The change is applied during the
// next maintenance window unless the ApplyImmediately parameter is set to true.
//
// For a list of valid engine versions, see [Engine Releases for Amazon Neptune], or call DescribeDBEngineVersions.
//
// [Engine Releases for Amazon Neptune]: https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html
EngineVersion *string
// Not supported by Neptune.
MasterUserPassword *string
// The new DB cluster identifier for the DB cluster when renaming a DB cluster.
// 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: my-cluster2
NewDBClusterIdentifier *string
// Not supported by Neptune.
OptionGroupName *string
// The port number on which the DB cluster accepts connections.
//
// Constraints: Value must be 1150-65535
//
// Default: The same port as the original DB cluster.
Port *int32
// The daily time range during which automated backups are created if automated
// backups are enabled, using the BackupRetentionPeriod parameter.
//
// The default is a 30-minute window selected at random from an 8-hour block of
// time for each Amazon Region.
//
// Constraints:
//
// - Must be in the format hh24:mi-hh24:mi .
//
// - Must be in Universal Coordinated Time (UTC).
//
// - Must not conflict with the preferred maintenance window.
//
// - Must be at least 30 minutes.
PreferredBackupWindow *string
// The weekly time range during which system maintenance can occur, in Universal
// Coordinated Time (UTC).
//
// Format: ddd:hh24:mi-ddd:hh24:mi
//
// The default is a 30-minute window selected at random from an 8-hour block of
// time for each Amazon Region, occurring on a random day of the week.
//
// Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
//
// Constraints: Minimum 30-minute window.
PreferredMaintenanceWindow *string
// Contains the scaling configuration of a Neptune Serverless DB cluster.
//
// For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide.
//
// [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html
ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration
// The storage type to associate with the DB cluster.
//
// Valid Values:
//
// - standard | iopt1
//
// Default:
//
// - standard
StorageType *string
// A list of VPC security groups that the DB cluster will belong to.
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type ModifyDBClusterOutput struct {
// Contains the details of an Amazon Neptune DB cluster.
//
// This data type is used as a response element in the DescribeDBClusters.
DBCluster *types.DBCluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationModifyDBClusterMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpModifyDBCluster{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpModifyDBCluster{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ModifyDBCluster"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpModifyDBClusterValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opModifyDBCluster(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opModifyDBCluster(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ModifyDBCluster",
}
}
|