AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ModifyDBClusterInput

import "github.com/aws/aws-sdk-go/service/rds"

type ModifyDBClusterInput struct { ApplyImmediately *bool `type:"boolean"` BacktrackWindow *int64 `type:"long"` BackupRetentionPeriod *int64 `type:"integer"` CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"` DBClusterIdentifier *string `type:"string" required:"true"` DBClusterParameterGroupName *string `type:"string"` DeletionProtection *bool `type:"boolean"` EnableHttpEndpoint *bool `type:"boolean"` EnableIAMDatabaseAuthentication *bool `type:"boolean"` EngineVersion *string `type:"string"` MasterUserPassword *string `type:"string"` NewDBClusterIdentifier *string `type:"string"` OptionGroupName *string `type:"string"` Port *int64 `type:"integer"` PreferredBackupWindow *string `type:"string"` PreferredMaintenanceWindow *string `type:"string"` ScalingConfiguration *ScalingConfiguration `type:"structure"` VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` }

ApplyImmediately

Type: *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 the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and 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

BacktrackWindow

Type: *int64

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

BackupRetentionPeriod

Type: *int64

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

CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon RDS User Guide.

DBClusterIdentifier

Type: *string

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

DBClusterIdentifier is a required field

DBClusterParameterGroupName

Type: *string

The name of the DB cluster parameter group to use for the DB cluster.

DeletionProtection

Type: *bool

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

EnableHttpEndpoint

Type: *bool

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the Amazon Aurora User Guide.

EnableIAMDatabaseAuthentication

Type: *bool

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

EngineVersion

Type: *string

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 CreateDBCluster, or call DescribeDBEngineVersions.

MasterUserPassword

Type: *string

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

NewDBClusterIdentifier

Type: *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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

OptionGroupName

Type: *string

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Port

Type: *int64

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.

PreferredBackupWindow

Type: *string

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the Amazon Aurora User Guide.

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.

PreferredMaintenanceWindow

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see Using Amazon Aurora Serverless (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the Amazon Aurora User Guide.

VpcSecurityGroupIds

Type: []*string

A list of VPC security groups that the DB cluster will belong to.

Method

GoString

func (s ModifyDBClusterInput) GoString() string

GoString returns the string representation

SetApplyImmediately

func (s *ModifyDBClusterInput) SetApplyImmediately(v bool) *ModifyDBClusterInput

SetApplyImmediately sets the ApplyImmediately field's value.

SetBacktrackWindow

func (s *ModifyDBClusterInput) SetBacktrackWindow(v int64) *ModifyDBClusterInput

SetBacktrackWindow sets the BacktrackWindow field's value.

SetBackupRetentionPeriod

func (s *ModifyDBClusterInput) SetBackupRetentionPeriod(v int64) *ModifyDBClusterInput

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

SetCloudwatchLogsExportConfiguration

func (s *ModifyDBClusterInput) SetCloudwatchLogsExportConfiguration(v *CloudwatchLogsExportConfiguration) *ModifyDBClusterInput

SetCloudwatchLogsExportConfiguration sets the CloudwatchLogsExportConfiguration field's value.

SetDBClusterIdentifier

func (s *ModifyDBClusterInput) SetDBClusterIdentifier(v string) *ModifyDBClusterInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

SetDBClusterParameterGroupName

func (s *ModifyDBClusterInput) SetDBClusterParameterGroupName(v string) *ModifyDBClusterInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

SetDeletionProtection

func (s *ModifyDBClusterInput) SetDeletionProtection(v bool) *ModifyDBClusterInput

SetDeletionProtection sets the DeletionProtection field's value.

SetEnableHttpEndpoint

func (s *ModifyDBClusterInput) SetEnableHttpEndpoint(v bool) *ModifyDBClusterInput

SetEnableHttpEndpoint sets the EnableHttpEndpoint field's value.

SetEnableIAMDatabaseAuthentication

func (s *ModifyDBClusterInput) SetEnableIAMDatabaseAuthentication(v bool) *ModifyDBClusterInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

SetEngineVersion

func (s *ModifyDBClusterInput) SetEngineVersion(v string) *ModifyDBClusterInput

SetEngineVersion sets the EngineVersion field's value.

SetMasterUserPassword

func (s *ModifyDBClusterInput) SetMasterUserPassword(v string) *ModifyDBClusterInput

SetMasterUserPassword sets the MasterUserPassword field's value.

SetNewDBClusterIdentifier

func (s *ModifyDBClusterInput) SetNewDBClusterIdentifier(v string) *ModifyDBClusterInput

SetNewDBClusterIdentifier sets the NewDBClusterIdentifier field's value.

SetOptionGroupName

func (s *ModifyDBClusterInput) SetOptionGroupName(v string) *ModifyDBClusterInput

SetOptionGroupName sets the OptionGroupName field's value.

SetPort

func (s *ModifyDBClusterInput) SetPort(v int64) *ModifyDBClusterInput

SetPort sets the Port field's value.

SetPreferredBackupWindow

func (s *ModifyDBClusterInput) SetPreferredBackupWindow(v string) *ModifyDBClusterInput

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

SetPreferredMaintenanceWindow

func (s *ModifyDBClusterInput) SetPreferredMaintenanceWindow(v string) *ModifyDBClusterInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetScalingConfiguration

func (s *ModifyDBClusterInput) SetScalingConfiguration(v *ScalingConfiguration) *ModifyDBClusterInput

SetScalingConfiguration sets the ScalingConfiguration field's value.

SetVpcSecurityGroupIds

func (s *ModifyDBClusterInput) SetVpcSecurityGroupIds(v []*string) *ModifyDBClusterInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

String

func (s ModifyDBClusterInput) String() string

String returns the string representation

Validate

func (s *ModifyDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: