Class Snapshot

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var bar = new Aws.Rds.Instance("bar", new Aws.Rds.InstanceArgs
    {
        AllocatedStorage = 10,
        BackupRetentionPeriod = 0,
        Engine = "MySQL",
        EngineVersion = "5.6.21",
        InstanceClass = "db.t2.micro",
        MaintenanceWindow = "Fri:09:00-Fri:09:30",
        Name = "baz",
        ParameterGroupName = "default.mysql5.6",
        Password = "barbarbarbar",
        Username = "foo",
    });
    var test = new Aws.Rds.Snapshot("test", new Aws.Rds.SnapshotArgs
    {
        DbInstanceIdentifier = bar.Id,
        DbSnapshotIdentifier = "testsnapshot1234",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Snapshot
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Rds
Assembly: Pulumi.Aws.dll
Syntax
public class Snapshot : CustomResource

Constructors

View Source

Snapshot(String, SnapshotArgs, CustomResourceOptions)

Create a Snapshot resource with the given unique name, arguments, and options.

Declaration
public Snapshot(string name, SnapshotArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
SnapshotArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AllocatedStorage

Specifies the allocated storage size in gigabytes (GB).

Declaration
public Output<int> AllocatedStorage { get; }
Property Value
Type Description
Output<System.Int32>
View Source

AvailabilityZone

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

Declaration
public Output<string> AvailabilityZone { get; }
Property Value
Type Description
Output<System.String>
View Source

DbInstanceIdentifier

The DB Instance Identifier from which to take the snapshot.

Declaration
public Output<string> DbInstanceIdentifier { get; }
Property Value
Type Description
Output<System.String>
View Source

DbSnapshotArn

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

Declaration
public Output<string> DbSnapshotArn { get; }
Property Value
Type Description
Output<System.String>
View Source

DbSnapshotIdentifier

The Identifier for the snapshot.

Declaration
public Output<string> DbSnapshotIdentifier { get; }
Property Value
Type Description
Output<System.String>
View Source

Encrypted

Specifies whether the DB snapshot is encrypted.

Declaration
public Output<bool> Encrypted { get; }
Property Value
Type Description
Output<System.Boolean>
View Source

Engine

Specifies the name of the database engine.

Declaration
public Output<string> Engine { get; }
Property Value
Type Description
Output<System.String>
View Source

EngineVersion

Specifies the version of the database engine.

Declaration
public Output<string> EngineVersion { get; }
Property Value
Type Description
Output<System.String>
View Source

Iops

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

Declaration
public Output<int> Iops { get; }
Property Value
Type Description
Output<System.Int32>
View Source

KmsKeyId

The ARN for the KMS encryption key.

Declaration
public Output<string> KmsKeyId { get; }
Property Value
Type Description
Output<System.String>
View Source

LicenseModel

License model information for the restored DB instance.

Declaration
public Output<string> LicenseModel { get; }
Property Value
Type Description
Output<System.String>
View Source

OptionGroupName

Provides the option group name for the DB snapshot.

Declaration
public Output<string> OptionGroupName { get; }
Property Value
Type Description
Output<System.String>
View Source

Port

Declaration
public Output<int> Port { get; }
Property Value
Type Description
Output<System.Int32>
View Source

SnapshotType

Declaration
public Output<string> SnapshotType { get; }
Property Value
Type Description
Output<System.String>
View Source

SourceDbSnapshotIdentifier

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

Declaration
public Output<string> SourceDbSnapshotIdentifier { get; }
Property Value
Type Description
Output<System.String>
View Source

SourceRegion

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

Declaration
public Output<string> SourceRegion { get; }
Property Value
Type Description
Output<System.String>
View Source

Status

Specifies the status of this DB snapshot.

Declaration
public Output<string> Status { get; }
Property Value
Type Description
Output<System.String>
View Source

StorageType

Specifies the storage type associated with DB snapshot.

Declaration
public Output<string> StorageType { get; }
Property Value
Type Description
Output<System.String>
View Source

Tags

Key-value map of resource tags

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

VpcId

Specifies the storage type associated with DB snapshot.

Declaration
public Output<string> VpcId { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, SnapshotState, CustomResourceOptions)

Get an existing Snapshot resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Snapshot Get(string name, Input<string> id, SnapshotState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
SnapshotState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Snapshot