Snapshot

class Snapshot : KotlinCustomResource

Manages an RDS database instance snapshot. For managing RDS database cluster snapshots, see the aws.rds.ClusterSnapshot resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const bar = new aws.rds.Instance("bar", {
allocatedStorage: 10,
engine: "mysql",
engineVersion: "5.6.21",
instanceClass: aws.rds.InstanceType.T2_Micro,
dbName: "baz",
password: "barbarbarbar",
username: "foo",
maintenanceWindow: "Fri:09:00-Fri:09:30",
backupRetentionPeriod: 0,
parameterGroupName: "default.mysql5.6",
});
const test = new aws.rds.Snapshot("test", {
dbInstanceIdentifier: bar.identifier,
dbSnapshotIdentifier: "testsnapshot1234",
});
import pulumi
import pulumi_aws as aws
bar = aws.rds.Instance("bar",
allocated_storage=10,
engine="mysql",
engine_version="5.6.21",
instance_class=aws.rds.InstanceType.T2_MICRO,
db_name="baz",
password="barbarbarbar",
username="foo",
maintenance_window="Fri:09:00-Fri:09:30",
backup_retention_period=0,
parameter_group_name="default.mysql5.6")
test = aws.rds.Snapshot("test",
db_instance_identifier=bar.identifier,
db_snapshot_identifier="testsnapshot1234")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var bar = new Aws.Rds.Instance("bar", new()
{
AllocatedStorage = 10,
Engine = "mysql",
EngineVersion = "5.6.21",
InstanceClass = Aws.Rds.InstanceType.T2_Micro,
DbName = "baz",
Password = "barbarbarbar",
Username = "foo",
MaintenanceWindow = "Fri:09:00-Fri:09:30",
BackupRetentionPeriod = 0,
ParameterGroupName = "default.mysql5.6",
});
var test = new Aws.Rds.Snapshot("test", new()
{
DbInstanceIdentifier = bar.Identifier,
DbSnapshotIdentifier = "testsnapshot1234",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
bar, err := rds.NewInstance(ctx, "bar", &rds.InstanceArgs{
AllocatedStorage: pulumi.Int(10),
Engine: pulumi.String("mysql"),
EngineVersion: pulumi.String("5.6.21"),
InstanceClass: pulumi.String(rds.InstanceType_T2_Micro),
DbName: pulumi.String("baz"),
Password: pulumi.String("barbarbarbar"),
Username: pulumi.String("foo"),
MaintenanceWindow: pulumi.String("Fri:09:00-Fri:09:30"),
BackupRetentionPeriod: pulumi.Int(0),
ParameterGroupName: pulumi.String("default.mysql5.6"),
})
if err != nil {
return err
}
_, err = rds.NewSnapshot(ctx, "test", &rds.SnapshotArgs{
DbInstanceIdentifier: bar.Identifier,
DbSnapshotIdentifier: pulumi.String("testsnapshot1234"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import com.pulumi.aws.rds.Snapshot;
import com.pulumi.aws.rds.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var bar = new Instance("bar", InstanceArgs.builder()
.allocatedStorage(10)
.engine("mysql")
.engineVersion("5.6.21")
.instanceClass("db.t2.micro")
.dbName("baz")
.password("barbarbarbar")
.username("foo")
.maintenanceWindow("Fri:09:00-Fri:09:30")
.backupRetentionPeriod(0)
.parameterGroupName("default.mysql5.6")
.build());
var test = new Snapshot("test", SnapshotArgs.builder()
.dbInstanceIdentifier(bar.identifier())
.dbSnapshotIdentifier("testsnapshot1234")
.build());
}
}
resources:
bar:
type: aws:rds:Instance
properties:
allocatedStorage: 10
engine: mysql
engineVersion: 5.6.21
instanceClass: db.t2.micro
dbName: baz
password: barbarbarbar
username: foo
maintenanceWindow: Fri:09:00-Fri:09:30
backupRetentionPeriod: 0
parameterGroupName: default.mysql5.6
test:
type: aws:rds:Snapshot
properties:
dbInstanceIdentifier: ${bar.identifier}
dbSnapshotIdentifier: testsnapshot1234

Import

Using pulumi import, import aws_db_snapshot using the snapshot identifier. For example:

$ pulumi import aws:rds/snapshot:Snapshot example my-snapshot

Properties

Link copied to clipboard
val allocatedStorage: Output<Int>

Specifies the allocated storage size in gigabytes (GB).

Link copied to clipboard

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Link copied to clipboard

The DB Instance Identifier from which to take the snapshot.

Link copied to clipboard
val dbSnapshotArn: Output<String>

The Amazon Resource Name (ARN) for the DB snapshot.

Link copied to clipboard

The Identifier for the snapshot.

Link copied to clipboard
val encrypted: Output<Boolean>

Specifies whether the DB snapshot is encrypted.

Link copied to clipboard
val engine: Output<String>

Specifies the name of the database engine.

Link copied to clipboard
val engineVersion: Output<String>

Specifies the version of the database engine.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val iops: Output<Int>

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Link copied to clipboard
val kmsKeyId: Output<String>

The ARN for the KMS encryption key.

Link copied to clipboard
val licenseModel: Output<String>

License model information for the restored DB instance.

Link copied to clipboard
val optionGroupName: Output<String>

Provides the option group name for the DB snapshot.

Link copied to clipboard
val port: Output<Int>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val sharedAccounts: Output<List<String>>?

List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.

Link copied to clipboard
val snapshotType: Output<String>
Link copied to clipboard

The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

Link copied to clipboard
val sourceRegion: Output<String>

The region that the DB snapshot was created in or copied from.

Link copied to clipboard
val status: Output<String>

Specifies the status of this DB snapshot.

Link copied to clipboard
val storageType: Output<String>

Specifies the storage type associated with DB snapshot.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val vpcId: Output<String>

Provides the VPC ID associated with the DB snapshot.