pulumi-aws-kotlin/com.pulumi.aws.rds.kotlin/Snapshot

Snapshot

class Snapshot : KotlinCustomResource

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

Example Usage

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());
    }
}

Import

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

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

Properties

allocatedStorage

val allocatedStorage: Output<Int>

Specifies the allocated storage size in gigabytes (GB).

availabilityZone

val availabilityZone: Output<String>

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

dbInstanceIdentifier

val dbInstanceIdentifier: Output<String>

The DB Instance Identifier from which to take the snapshot.

dbSnapshotArn

val dbSnapshotArn: Output<String>

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

dbSnapshotIdentifier

val dbSnapshotIdentifier: Output<String>

The Identifier for the snapshot.

encrypted

val encrypted: Output<Boolean>

Specifies whether the DB snapshot is encrypted.

engine

val engine: Output<String>

Specifies the name of the database engine.

engineVersion

val engineVersion: Output<String>

Specifies the version of the database engine.

val id: Output<String>

iops

val iops: Output<Int>

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

kmsKeyId

val kmsKeyId: Output<String>

The ARN for the KMS encryption key.

licenseModel

val licenseModel: Output<String>

License model information for the restored DB instance.

optionGroupName

val optionGroupName: Output<String>

Provides the option group name for the DB snapshot.

port

val port: Output<Int>

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

sharedAccounts

val sharedAccounts: Output<List<String>>?

List of AWS Account ids to share snapshot with, use all to make snaphot public.

snapshotType

val snapshotType: Output<String>

sourceDbSnapshotIdentifier

val sourceDbSnapshotIdentifier: Output<String>

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

sourceRegion

val sourceRegion: Output<String>

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

status

val status: Output<String>

Specifies the status of this DB snapshot.

storageType

val storageType: Output<String>

Specifies the storage type associated with DB snapshot.