aws_db_snapshot.md

April 1, 2019 ยท View on GitHub

Document: "rds"

Path: "https://github.com/aws/aws-sdk-go-v2/tree/master/models/apis/rds/2014-10-31/api-2.json")

DBSnapshot

aws_db_snapshot {
  db_instance_identifier => "db_instance_identifier (optional)",
  dbi_resource_id => "dbi_resource_id (optional)",
  db_snapshot_identifier => "db_snapshot_identifier (optional)",
  engine_version => "engine_version (optional)",
  filters => "Filters (optional)",
  include_public => "IncludePublic (optional)",
  include_shared => "IncludeShared (optional)",
  max_records => "MaxRecords (optional)",
  option_group_name => "option_group_name (optional)",
  option_group_name => "option_group_name (optional)",
  snapshot_type => "snapshot_type (optional)",
  tags => "Tags (optional)",
}
NameTypeRequired
db_instance_identifierStringfalse
dbi_resource_idStringfalse
db_snapshot_identifierStringfalse
engine_versionStringfalse
filtersFilterListfalse
include_publicBooleanfalse
include_sharedBooleanfalse
max_recordsIntegerOptionalfalse
option_group_nameStringfalse
option_group_nameStringfalse
snapshot_typeStringfalse
tagsTagListfalse

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the DBSnapshot

OperationPathVerbDescriptionOperationID
Create/POST

Creates a DBSnapshot. The source DBInstance must be in "available" state.

CreateDBSnapshot
List - list all/POST

Returns information about DB snapshots. This API action supports pagination.

DescribeDBSnapshots
List - get one``
List - get list using params/POST

Returns information about DB snapshots. This API action supports pagination.

DescribeDBSnapshots
Update/POST

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

ModifyDBSnapshot
Delete/POST

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB snapshot must be in the available state to be deleted.

DeleteDBSnapshot