ModifyDBClusterMessage

public struct ModifyDBClusterMessage : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let 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

    Declaration

    Swift

    public let backupRetentionPeriod: Int?

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

    Declaration

    Swift

    public let cloudwatchLogsExportConfiguration: CloudwatchLogsExportConfiguration?

  • The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster.

    Declaration

    Swift

    public let dBClusterIdentifier: String

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

    Declaration

    Swift

    public let dBClusterParameterGroupName: 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.

    Declaration

    Swift

    public let deletionProtection: Bool?

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

    Declaration

    Swift

    public let enableIAMDatabaseAuthentication: Bool?

  • The version number of the database engine. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API. For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

    Declaration

    Swift

    public let engineVersion: 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.

    Declaration

    Swift

    public let 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

    Declaration

    Swift

    public let newDBClusterIdentifier: String?

  • (Not supported by Neptune)

    Declaration

    Swift

    public let 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.

    Declaration

    Swift

    public let port: Int?

  • 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.

    Declaration

    Swift

    public let 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 AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.

    Declaration

    Swift

    public let preferredMaintenanceWindow: String?

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

    Declaration

    Swift

    public let vpcSecurityGroupIds: [String]?

  • Undocumented

    Declaration

    Swift

    public init(applyImmediately: Bool? = nil, backupRetentionPeriod: Int? = nil, cloudwatchLogsExportConfiguration: CloudwatchLogsExportConfiguration? = nil, dBClusterIdentifier: String, dBClusterParameterGroupName: String? = nil, deletionProtection: Bool? = nil, enableIAMDatabaseAuthentication: Bool? = nil, engineVersion: String? = nil, masterUserPassword: String? = nil, newDBClusterIdentifier: String? = nil, optionGroupName: String? = nil, port: Int? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, vpcSecurityGroupIds: [String]? = nil)