AWS Classic v5.33.0, Mar 24 23

aws.docdb.ClusterSnapshot

Manages a DocDB database cluster snapshot for DocDB clusters.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DocDB.ClusterSnapshot("example", new()
    {
        DbClusterIdentifier = aws_docdb_cluster.Example.Id,
        DbClusterSnapshotIdentifier = "resourcetestsnapshot1234",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/docdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docdb.NewClusterSnapshot(ctx, "example", &docdb.ClusterSnapshotArgs{
			DbClusterIdentifier:         pulumi.Any(aws_docdb_cluster.Example.Id),
			DbClusterSnapshotIdentifier: pulumi.String("resourcetestsnapshot1234"),
		})
		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.docdb.ClusterSnapshot;
import com.pulumi.aws.docdb.ClusterSnapshotArgs;
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 example = new ClusterSnapshot("example", ClusterSnapshotArgs.builder()        
            .dbClusterIdentifier(aws_docdb_cluster.example().id())
            .dbClusterSnapshotIdentifier("resourcetestsnapshot1234")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.docdb.ClusterSnapshot("example",
    db_cluster_identifier=aws_docdb_cluster["example"]["id"],
    db_cluster_snapshot_identifier="resourcetestsnapshot1234")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.docdb.ClusterSnapshot("example", {
    dbClusterIdentifier: aws_docdb_cluster.example.id,
    dbClusterSnapshotIdentifier: "resourcetestsnapshot1234",
});

resources:
  example:
    type: aws:docdb:ClusterSnapshot
    properties:
      dbClusterIdentifier: ${aws_docdb_cluster.example.id}
      dbClusterSnapshotIdentifier: resourcetestsnapshot1234

Create ClusterSnapshot Resource

new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: CustomResourceOptions);

@overload
def ClusterSnapshot(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    db_cluster_identifier: Optional[str] = None,
                    db_cluster_snapshot_identifier: Optional[str] = None)
@overload
def ClusterSnapshot(resource_name: str,
                    args: ClusterSnapshotArgs,
                    opts: Optional[ResourceOptions] = None)

func NewClusterSnapshot(ctx *Context, name string, args ClusterSnapshotArgs, opts ...ResourceOption) (*ClusterSnapshot, error)

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

public ClusterSnapshot(String name, ClusterSnapshotArgs args)
public ClusterSnapshot(String name, ClusterSnapshotArgs args, CustomResourceOptions options)

type: aws:docdb:ClusterSnapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterSnapshotArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ClusterSnapshotArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterSnapshotArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterSnapshotArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClusterSnapshotArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ClusterSnapshot Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ClusterSnapshot resource accepts the following input properties:

DbClusterIdentifier string: The DocDB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.

DbClusterIdentifier string: The DocDB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.

dbClusterIdentifier String: The DocDB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.

dbClusterIdentifier string: The DocDB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotIdentifier string: The Identifier for the snapshot.

db_cluster_identifier str: The DocDB Cluster Identifier from which to take the snapshot.
db_cluster_snapshot_identifier str: The Identifier for the snapshot.

dbClusterIdentifier String: The DocDB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.

Outputs

All input properties are implicitly available as output properties. Additionally, the ClusterSnapshot resource produces the following output properties:

AvailabilityZones List<string>: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
Engine string: Specifies the name of the database engine.
EngineVersion string: Version of the database engine for this DocDB cluster snapshot.
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
Port int: Port that the DocDB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DocDB Cluster Snapshot.
StorageEncrypted bool: Specifies whether the DocDB cluster snapshot is encrypted.
VpcId string: The VPC ID associated with the DocDB cluster snapshot.

AvailabilityZones []string: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
Engine string: Specifies the name of the database engine.
EngineVersion string: Version of the database engine for this DocDB cluster snapshot.
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
Port int: Port that the DocDB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DocDB Cluster Snapshot.
StorageEncrypted bool: Specifies whether the DocDB cluster snapshot is encrypted.
VpcId string: The VPC ID associated with the DocDB cluster snapshot.

availabilityZones List<String>: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
engine String: Specifies the name of the database engine.
engineVersion String: Version of the database engine for this DocDB cluster snapshot.
id String: The provider-assigned unique ID for this managed resource.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port Integer: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DocDB Cluster Snapshot.
storageEncrypted Boolean: Specifies whether the DocDB cluster snapshot is encrypted.
vpcId String: The VPC ID associated with the DocDB cluster snapshot.

availabilityZones string[]: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
dbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
engine string: Specifies the name of the database engine.
engineVersion string: Version of the database engine for this DocDB cluster snapshot.
id string: The provider-assigned unique ID for this managed resource.
kmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port number: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshotType string
sourceDbClusterSnapshotArn string
status string: The status of this DocDB Cluster Snapshot.
storageEncrypted boolean: Specifies whether the DocDB cluster snapshot is encrypted.
vpcId string: The VPC ID associated with the DocDB cluster snapshot.

availability_zones Sequence[str]: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
db_cluster_snapshot_arn str: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
engine str: Specifies the name of the database engine.
engine_version str: Version of the database engine for this DocDB cluster snapshot.
id str: The provider-assigned unique ID for this managed resource.
kms_key_id str: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port int: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshot_type str
source_db_cluster_snapshot_arn str
status str: The status of this DocDB Cluster Snapshot.
storage_encrypted bool: Specifies whether the DocDB cluster snapshot is encrypted.
vpc_id str: The VPC ID associated with the DocDB cluster snapshot.

availabilityZones List<String>: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
engine String: Specifies the name of the database engine.
engineVersion String: Version of the database engine for this DocDB cluster snapshot.
id String: The provider-assigned unique ID for this managed resource.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port Number: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DocDB Cluster Snapshot.
storageEncrypted Boolean: Specifies whether the DocDB cluster snapshot is encrypted.
vpcId String: The VPC ID associated with the DocDB cluster snapshot.

Look up Existing ClusterSnapshot Resource

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

public static get(name: string, id: Input<ID>, state?: ClusterSnapshotState, opts?: CustomResourceOptions): ClusterSnapshot

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zones: Optional[Sequence[str]] = None,
        db_cluster_identifier: Optional[str] = None,
        db_cluster_snapshot_arn: Optional[str] = None,
        db_cluster_snapshot_identifier: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        port: Optional[int] = None,
        snapshot_type: Optional[str] = None,
        source_db_cluster_snapshot_arn: Optional[str] = None,
        status: Optional[str] = None,
        storage_encrypted: Optional[bool] = None,
        vpc_id: Optional[str] = None) -> ClusterSnapshot

func GetClusterSnapshot(ctx *Context, name string, id IDInput, state *ClusterSnapshotState, opts ...ResourceOption) (*ClusterSnapshot, error)

public static ClusterSnapshot Get(string name, Input<string> id, ClusterSnapshotState? state, CustomResourceOptions? opts = null)

public static ClusterSnapshot get(String name, Output<String> id, ClusterSnapshotState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AvailabilityZones List<string>: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
DbClusterIdentifier string: The DocDB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.
Engine string: Specifies the name of the database engine.
EngineVersion string: Version of the database engine for this DocDB cluster snapshot.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
Port int: Port that the DocDB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DocDB Cluster Snapshot.
StorageEncrypted bool: Specifies whether the DocDB cluster snapshot is encrypted.
VpcId string: The VPC ID associated with the DocDB cluster snapshot.

AvailabilityZones []string: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
DbClusterIdentifier string: The DocDB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.
Engine string: Specifies the name of the database engine.
EngineVersion string: Version of the database engine for this DocDB cluster snapshot.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
Port int: Port that the DocDB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DocDB Cluster Snapshot.
StorageEncrypted bool: Specifies whether the DocDB cluster snapshot is encrypted.
VpcId string: The VPC ID associated with the DocDB cluster snapshot.

availabilityZones List<String>: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
dbClusterIdentifier String: The DocDB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.
engine String: Specifies the name of the database engine.
engineVersion String: Version of the database engine for this DocDB cluster snapshot.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port Integer: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DocDB Cluster Snapshot.
storageEncrypted Boolean: Specifies whether the DocDB cluster snapshot is encrypted.
vpcId String: The VPC ID associated with the DocDB cluster snapshot.

availabilityZones string[]: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
dbClusterIdentifier string: The DocDB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
dbClusterSnapshotIdentifier string: The Identifier for the snapshot.
engine string: Specifies the name of the database engine.
engineVersion string: Version of the database engine for this DocDB cluster snapshot.
kmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port number: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshotType string
sourceDbClusterSnapshotArn string
status string: The status of this DocDB Cluster Snapshot.
storageEncrypted boolean: Specifies whether the DocDB cluster snapshot is encrypted.
vpcId string: The VPC ID associated with the DocDB cluster snapshot.

availability_zones Sequence[str]: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
db_cluster_identifier str: The DocDB Cluster Identifier from which to take the snapshot.
db_cluster_snapshot_arn str: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
db_cluster_snapshot_identifier str: The Identifier for the snapshot.
engine str: Specifies the name of the database engine.
engine_version str: Version of the database engine for this DocDB cluster snapshot.
kms_key_id str: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port int: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshot_type str
source_db_cluster_snapshot_arn str
status str: The status of this DocDB Cluster Snapshot.
storage_encrypted bool: Specifies whether the DocDB cluster snapshot is encrypted.
vpc_id str: The VPC ID associated with the DocDB cluster snapshot.

availabilityZones List<String>: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
dbClusterIdentifier String: The DocDB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.
engine String: Specifies the name of the database engine.
engineVersion String: Version of the database engine for this DocDB cluster snapshot.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port Number: Port that the DocDB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DocDB Cluster Snapshot.
storageEncrypted Boolean: Specifies whether the DocDB cluster snapshot is encrypted.
vpcId String: The VPC ID associated with the DocDB cluster snapshot.

Import

aws_docdb_cluster_snapshot can be imported by using the cluster snapshot identifier, e.g.,

 $ pulumi import aws:docdb/clusterSnapshot:ClusterSnapshot example my-cluster-snapshot

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.