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.

CreateDBClusterInput

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

type CreateDBClusterInput struct { AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"` BacktrackWindow *int64 `type:"long"` BackupRetentionPeriod *int64 `type:"integer"` CharacterSetName *string `type:"string"` DBClusterIdentifier *string `type:"string" required:"true"` DBClusterParameterGroupName *string `type:"string"` DBSubnetGroupName *string `type:"string"` DatabaseName *string `type:"string"` DeletionProtection *bool `type:"boolean"` DestinationRegion *string `type:"string"` EnableCloudwatchLogsExports []*string `type:"list"` EnableIAMDatabaseAuthentication *bool `type:"boolean"` Engine *string `type:"string" required:"true"` EngineMode *string `type:"string"` EngineVersion *string `type:"string"` GlobalClusterIdentifier *string `type:"string"` KmsKeyId *string `type:"string"` MasterUserPassword *string `type:"string"` MasterUsername *string `type:"string"` OptionGroupName *string `type:"string"` Port *int64 `type:"integer"` PreSignedUrl *string `type:"string"` PreferredBackupWindow *string `type:"string"` PreferredMaintenanceWindow *string `type:"string"` ReplicationSourceIdentifier *string `type:"string"` ScalingConfiguration *ScalingConfiguration `type:"structure"` SourceRegion *string `type:"string" ignore:"true"` StorageEncrypted *bool `type:"boolean"` Tags []*Tag `locationNameList:"Tag" type:"list"` VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` }

AvailabilityZones

Type: []*string

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the Amazon Aurora User Guide.

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

CharacterSetName

Type: *string

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

DBClusterIdentifier

Type: *string

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: my-cluster1

DBClusterIdentifier is a required field

DBClusterParameterGroupName

Type: *string

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.

DBSubnetGroupName

Type: *string

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

DatabaseName

Type: *string

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

DeletionProtection

Type: *bool

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

DestinationRegion

Type: *string

DestinationRegion is used for presigning the request to a given region.

EnableCloudwatchLogsExports

Type: []*string

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list 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/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) 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

Engine

Type: *string

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Engine is a required field

EngineMode

Type: *string

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.

EngineVersion

Type: *string

The version number of the database engine to use.

Aurora MySQL

Example: 5.6.10a, 5.7.12

Aurora PostgreSQL

Example: 9.6.3

GlobalClusterIdentifier

Type: *string

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

KmsKeyId

Type: *string

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS will use your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

MasterUserPassword

Type: *string

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

Constraints: Must contain from 8 to 41 characters.

MasterUsername

Type: *string

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

OptionGroupName

Type: *string

A value that indicates that the DB cluster should be associated with the specified option group.

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 instances in the DB cluster accept connections.

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

PreSignedUrl

Type: *string

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

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.

ReplicationSourceIdentifier

Type: *string

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

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.

SourceRegion

Type: *string

SourceRegion is the source region where the resource exists. This is not sent over the wire and is only used for presigning. This value should always have the same region as the source ARN.

StorageEncrypted

Type: *bool

Specifies whether the DB cluster is encrypted.

Tags

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

VpcSecurityGroupIds

Type: []*string

A list of EC2 VPC security groups to associate with this DB cluster.

Method

GoString

func (s CreateDBClusterInput) GoString() string

GoString returns the string representation

SetAvailabilityZones

func (s *CreateDBClusterInput) SetAvailabilityZones(v []*string) *CreateDBClusterInput

SetAvailabilityZones sets the AvailabilityZones field's value.

SetBacktrackWindow

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

SetBacktrackWindow sets the BacktrackWindow field's value.

SetBackupRetentionPeriod

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

SetCharacterSetName

func (s *CreateDBClusterInput) SetCharacterSetName(v string) *CreateDBClusterInput

SetCharacterSetName sets the CharacterSetName field's value.

SetDBClusterIdentifier

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

SetDBClusterParameterGroupName

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

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

SetDBSubnetGroupName

func (s *CreateDBClusterInput) SetDBSubnetGroupName(v string) *CreateDBClusterInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

SetDatabaseName

func (s *CreateDBClusterInput) SetDatabaseName(v string) *CreateDBClusterInput

SetDatabaseName sets the DatabaseName field's value.

SetDeletionProtection

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

SetDeletionProtection sets the DeletionProtection field's value.

SetDestinationRegion

func (s *CreateDBClusterInput) SetDestinationRegion(v string) *CreateDBClusterInput

SetDestinationRegion sets the DestinationRegion field's value.

SetEnableCloudwatchLogsExports

func (s *CreateDBClusterInput) SetEnableCloudwatchLogsExports(v []*string) *CreateDBClusterInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

SetEnableIAMDatabaseAuthentication

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

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

SetEngine

func (s *CreateDBClusterInput) SetEngine(v string) *CreateDBClusterInput

SetEngine sets the Engine field's value.

SetEngineMode

func (s *CreateDBClusterInput) SetEngineMode(v string) *CreateDBClusterInput

SetEngineMode sets the EngineMode field's value.

SetEngineVersion

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

SetEngineVersion sets the EngineVersion field's value.

SetGlobalClusterIdentifier

func (s *CreateDBClusterInput) SetGlobalClusterIdentifier(v string) *CreateDBClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

SetKmsKeyId

func (s *CreateDBClusterInput) SetKmsKeyId(v string) *CreateDBClusterInput

SetKmsKeyId sets the KmsKeyId field's value.

SetMasterUserPassword

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

SetMasterUserPassword sets the MasterUserPassword field's value.

SetMasterUsername

func (s *CreateDBClusterInput) SetMasterUsername(v string) *CreateDBClusterInput

SetMasterUsername sets the MasterUsername field's value.

SetOptionGroupName

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

SetOptionGroupName sets the OptionGroupName field's value.

SetPort

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

SetPort sets the Port field's value.

SetPreSignedUrl

func (s *CreateDBClusterInput) SetPreSignedUrl(v string) *CreateDBClusterInput

SetPreSignedUrl sets the PreSignedUrl field's value.

SetPreferredBackupWindow

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetReplicationSourceIdentifier

func (s *CreateDBClusterInput) SetReplicationSourceIdentifier(v string) *CreateDBClusterInput

SetReplicationSourceIdentifier sets the ReplicationSourceIdentifier field's value.

SetScalingConfiguration

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

SetScalingConfiguration sets the ScalingConfiguration field's value.

SetSourceRegion

func (s *CreateDBClusterInput) SetSourceRegion(v string) *CreateDBClusterInput

SetSourceRegion sets the SourceRegion field's value.

SetStorageEncrypted

func (s *CreateDBClusterInput) SetStorageEncrypted(v bool) *CreateDBClusterInput

SetStorageEncrypted sets the StorageEncrypted field's value.

SetTags

func (s *CreateDBClusterInput) SetTags(v []*Tag) *CreateDBClusterInput

SetTags sets the Tags field's value.

SetVpcSecurityGroupIds

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

String

func (s CreateDBClusterInput) String() string

String returns the string representation

Validate

func (s *CreateDBClusterInput) Validate() error

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

On this page: