Class ClusterSnapshot

Manages a DocDB database cluster snapshot for DocDB clusters.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.DocDB.ClusterSnapshot("example", new Aws.DocDB.ClusterSnapshotArgs
    {
        DbClusterIdentifier = aws_docdb_cluster.Example.Id,
        DbClusterSnapshotIdentifier = "resourcetestsnapshot1234",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ClusterSnapshot

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

Assembly: Pulumi.Aws.dll

Syntax

public class ClusterSnapshot : CustomResource

Constructors

ClusterSnapshot(String, ClusterSnapshotArgs, CustomResourceOptions)

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

Declaration

public ClusterSnapshot(string name, ClusterSnapshotArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterSnapshotArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AvailabilityZones

List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.

Declaration

public Output<ImmutableArray<string>> AvailabilityZones { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

DbClusterIdentifier

The DocDB Cluster Identifier from which to take the snapshot.

Declaration

public Output<string> DbClusterIdentifier { get; }

Property Value

Type	Description
Output<System.String>

DbClusterSnapshotArn

The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.

Declaration

public Output<string> DbClusterSnapshotArn { get; }

Property Value

Type	Description
Output<System.String>

DbClusterSnapshotIdentifier

The Identifier for the snapshot.

Declaration

public Output<string> DbClusterSnapshotIdentifier { get; }

Property Value

Type	Description
Output<System.String>

Engine

Specifies the name of the database engine.

Declaration

public Output<string> Engine { get; }

Property Value

Type	Description
Output<System.String>

EngineVersion

Version of the database engine for this DocDB cluster snapshot.

Declaration

public Output<string> EngineVersion { get; }

Property Value

Type	Description
Output<System.String>

KmsKeyId

If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.

Declaration

public Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

Port

Port that the DocDB cluster was listening on at the time of the snapshot.

Declaration

public Output<int> Port { get; }

Property Value

Type	Description
Output<System.Int32>

SnapshotType

Declaration

public Output<string> SnapshotType { get; }

Property Value

Type	Description
Output<System.String>

SourceDbClusterSnapshotArn

Declaration

public Output<string> SourceDbClusterSnapshotArn { get; }

Property Value

Type	Description
Output<System.String>

Status

The status of this DocDB Cluster Snapshot.

Declaration

public Output<string> Status { get; }

Property Value

Type	Description
Output<System.String>

StorageEncrypted

Specifies whether the DocDB cluster snapshot is encrypted.

Declaration

public Output<bool> StorageEncrypted { get; }

Property Value

Type	Description
Output<System.Boolean>

VpcId

The VPC ID associated with the DocDB cluster snapshot.

Declaration

public Output<string> VpcId { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static ClusterSnapshot Get(string name, Input<string> id, ClusterSnapshotState 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.
ClusterSnapshotState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ClusterSnapshot