github.com/koding/terraform@v0.6.4-0.20170608090606-5d7e0339779d/website/source/docs/providers/aws/r/db_snapshot.html.md (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_db_snapshot"
     4  sidebar_current: "docs-aws-resource-db-snapshot"
     5  description: |-
     6    Provides an DB Instance.
     7  ---
     8  
     9  # aws\_db\_snapshot
    10  
    11  Creates a Snapshot of an DB Instance.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "aws_db_instance" "bar" {
    17  	allocated_storage = 10
    18  	engine = "MySQL"
    19  	engine_version = "5.6.21"
    20  	instance_class = "db.t1.micro"
    21  	name = "baz"
    22  	password = "barbarbarbar"
    23  	username = "foo"
    24  
    25      maintenance_window = "Fri:09:00-Fri:09:30"
    26  	backup_retention_period = 0
    27  	parameter_group_name = "default.mysql5.6"
    28  }
    29  
    30  resource "aws_db_snapshot" "test" {
    31  	db_instance_identifier = "${aws_db_instance.bar.id}"
    32  	db_snapshot_identifier = "testsnapshot1234"
    33  }
    34  ```
    35  
    36  ## Argument Reference
    37  
    38  The following arguments are supported:
    39  
    40  * `db_instance_identifier` - (Required) The DB Instance Identifier from which to take the snapshot.
    41  * `db_snapshot_identifier` - (Required) The Identifier for the snapshot.
    42  
    43  
    44  ## Attributes Reference
    45  
    46  The following attributes are exported:
    47  
    48  * `allocated_storage` - Specifies the allocated storage size in gigabytes (GB).
    49  * `availability_zone` - Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    50  * `db_snapshot_arn` - The Amazon Resource Name (ARN) for the DB snapshot.
    51  * `encrypted` - Specifies whether the DB snapshot is encrypted.
    52  * `engine` - Specifies the name of the database engine.
    53  * `engine_version` - Specifies the version of the database engine.
    54  * `iops` - Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    55  * `kms_key_id` - The ARN for the KMS encryption key.
    56  * `license_model` - License model information for the restored DB instance.
    57  * `option_group_name` - Provides the option group name for the DB snapshot.
    58  * `source_db_snapshot_identifier` - The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
    59  * `source_region` - The region that the DB snapshot was created in or copied from.
    60  * `status` - Specifies the status of this DB snapshot.
    61  * `storage_type` - Specifies the storage type associated with DB snapshot.
    62  * `vpc_id` - Specifies the storage type associated with DB snapshot.