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.

DeleteDBInstanceInput

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

type DeleteDBInstanceInput struct { DBInstanceIdentifier *string `type:"string" required:"true"` DeleteAutomatedBackups *bool `type:"boolean"` FinalDBSnapshotIdentifier *string `type:"string"` SkipFinalSnapshot *bool `type:"boolean"` }

DBInstanceIdentifier

Type: *string

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

DBInstanceIdentifier is a required field

DeleteAutomatedBackups

Type: *bool

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. This parameter defaults to true.

FinalDBSnapshotIdentifier

Type: *string

The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

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

  • Can't be specified when deleting a Read Replica.

SkipFinalSnapshot

Type: *bool

A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Method

GoString

func (s DeleteDBInstanceInput) GoString() string

GoString returns the string representation

SetDBInstanceIdentifier

func (s *DeleteDBInstanceInput) SetDBInstanceIdentifier(v string) *DeleteDBInstanceInput

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

SetDeleteAutomatedBackups

func (s *DeleteDBInstanceInput) SetDeleteAutomatedBackups(v bool) *DeleteDBInstanceInput

SetDeleteAutomatedBackups sets the DeleteAutomatedBackups field's value.

SetFinalDBSnapshotIdentifier

func (s *DeleteDBInstanceInput) SetFinalDBSnapshotIdentifier(v string) *DeleteDBInstanceInput

SetFinalDBSnapshotIdentifier sets the FinalDBSnapshotIdentifier field's value.

SetSkipFinalSnapshot

func (s *DeleteDBInstanceInput) SetSkipFinalSnapshot(v bool) *DeleteDBInstanceInput

SetSkipFinalSnapshot sets the SkipFinalSnapshot field's value.

String

func (s DeleteDBInstanceInput) String() string

String returns the string representation

Validate

func (s *DeleteDBInstanceInput) Validate() error

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

On this page: