Class Snapshot

Creates a Snapshot of an EBS Volume.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Ebs.Volume("example", new Aws.Ebs.VolumeArgs
    {
        AvailabilityZone = "us-west-2a",
        Size = 40,
        Tags = 
        {
            { "Name", "HelloWorld" },
        },
    });
    var exampleSnapshot = new Aws.Ebs.Snapshot("exampleSnapshot", new Aws.Ebs.SnapshotArgs
    {
        Tags = 
        {
            { "Name", "HelloWorld_snap" },
        },
        VolumeId = example.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Snapshot

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

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.Ebs

Assembly: Pulumi.Aws.dll

Syntax

public class Snapshot : CustomResource

Constructors

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

DataEncryptionKeyId

The data encryption key identifier for the snapshot.

Declaration

public Output<string> DataEncryptionKeyId { get; }

Property Value

Type	Description
Output<System.String>

Description

A description of what the snapshot is.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Encrypted

Whether the snapshot is encrypted.

Declaration

public Output<bool> Encrypted { get; }

Property Value

Type	Description
Output<System.Boolean>

KmsKeyId

The ARN for the KMS encryption key.

Declaration

public Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

OwnerAlias

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

Declaration

public Output<string> OwnerAlias { get; }

Property Value

Type	Description
Output<System.String>

OwnerId

The AWS account ID of the EBS snapshot owner.

Declaration

public Output<string> OwnerId { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the snapshot

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

VolumeId

The Volume ID of which to make a snapshot.

Declaration

public Output<string> VolumeId { get; }

Property Value

Type	Description
Output<System.String>

VolumeSize

The size of the drive in GiBs.

Declaration

public Output<int> VolumeSize { get; }

Property Value

Type	Description
Output<System.Int32>

Methods

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