// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. package docdb import ( "context" "github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/internal/awsutil" ) // Represents the input to ModifyDBCluster. type ModifyDBClusterInput struct { _ struct{} `type:"structure"` // A value that specifies whether the changes in this request and any pending // changes are asynchronously applied as soon as possible, regardless of the // PreferredMaintenanceWindow setting for the cluster. If this parameter is // set to false, changes to the cluster are applied during the next maintenance // window. // // The ApplyImmediately parameter affects only the NewDBClusterIdentifier and // MasterUserPassword values. If you set this parameter value to false, the // changes to the NewDBClusterIdentifier and MasterUserPassword 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 `type:"boolean"` // 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 *int64 `type:"integer"` // The configuration setting for the log types to be enabled for export to Amazon // CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and // DisableLogTypes arrays determine which logs are exported (or not exported) // to CloudWatch Logs. CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"` // The cluster identifier for the cluster that is being modified. This parameter // is not case sensitive. // // Constraints: // // * Must match the identifier of an existing DBCluster. // // DBClusterIdentifier is a required field DBClusterIdentifier *string `type:"string" required:"true"` // The name of the cluster parameter group to use for the cluster. DBClusterParameterGroupName *string `type:"string"` // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, // the cluster cannot be deleted unless it is modified and DeletionProtection // is disabled. DeletionProtection protects clusters from being accidentally // deleted. DeletionProtection *bool `type:"boolean"` // 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. EngineVersion *string `type:"string"` // The password for the master database user. This password can contain any // printable ASCII character except forward slash (/), double quote ("), or // the "at" symbol (@). // // Constraints: Must contain from 8 to 100 characters. MasterUserPassword *string `type:"string"` // The new cluster identifier for the cluster when renaming a 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 `type:"string"` // The port number on which the cluster accepts connections. // // Constraints: Must be a value from 1150 to 65535. // // Default: The same port as the original cluster. Port *int64 `type:"integer"` // 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 AWS 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 `type:"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 AWS 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 `type:"string"` // A list of virtual private cloud (VPC) security groups that the cluster will // belong to. VpcSecurityGroupIds []string `locationNameList:"VpcSecurityGroupId" type:"list"` } // String returns the string representation func (s ModifyDBClusterInput) String() string { return awsutil.Prettify(s) } // Validate inspects the fields of the type to determine if they are valid. func (s *ModifyDBClusterInput) Validate() error { invalidParams := aws.ErrInvalidParams{Context: "ModifyDBClusterInput"} if s.DBClusterIdentifier == nil { invalidParams.Add(aws.NewErrParamRequired("DBClusterIdentifier")) } if invalidParams.Len() > 0 { return invalidParams } return nil } type ModifyDBClusterOutput struct { _ struct{} `type:"structure"` // Detailed information about a cluster. DBCluster *DBCluster `type:"structure"` } // String returns the string representation func (s ModifyDBClusterOutput) String() string { return awsutil.Prettify(s) } const opModifyDBCluster = "ModifyDBCluster" // ModifyDBClusterRequest returns a request value for making API operation for // Amazon DocumentDB with MongoDB compatibility. // // Modifies a setting for an Amazon DocumentDB cluster. You can change one or // more database configuration parameters by specifying these parameters and // the new values in the request. // // // Example sending a request using ModifyDBClusterRequest. // req := client.ModifyDBClusterRequest(params) // resp, err := req.Send(context.TODO()) // if err == nil { // fmt.Println(resp) // } // // Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBCluster func (c *Client) ModifyDBClusterRequest(input *ModifyDBClusterInput) ModifyDBClusterRequest { op := &aws.Operation{ Name: opModifyDBCluster, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &ModifyDBClusterInput{} } req := c.newRequest(op, input, &ModifyDBClusterOutput{}) return ModifyDBClusterRequest{Request: req, Input: input, Copy: c.ModifyDBClusterRequest} } // ModifyDBClusterRequest is the request type for the // ModifyDBCluster API operation. type ModifyDBClusterRequest struct { *aws.Request Input *ModifyDBClusterInput Copy func(*ModifyDBClusterInput) ModifyDBClusterRequest } // Send marshals and sends the ModifyDBCluster API request. func (r ModifyDBClusterRequest) Send(ctx context.Context) (*ModifyDBClusterResponse, error) { r.Request.SetContext(ctx) err := r.Request.Send() if err != nil { return nil, err } resp := &ModifyDBClusterResponse{ ModifyDBClusterOutput: r.Request.Data.(*ModifyDBClusterOutput), response: &aws.Response{Request: r.Request}, } return resp, nil } // ModifyDBClusterResponse is the response type for the // ModifyDBCluster API operation. type ModifyDBClusterResponse struct { *ModifyDBClusterOutput response *aws.Response } // SDKResponseMetdata returns the response metadata for the // ModifyDBCluster request. func (r *ModifyDBClusterResponse) SDKResponseMetdata() *aws.Response { return r.response }