ClusterSnapshot

class ClusterSnapshot : KotlinCustomResource

Manages an RDS database cluster snapshot for Aurora clusters. For managing RDS database instance snapshots, see the aws.rds.Snapshot resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.rds.ClusterSnapshot("example", {
dbClusterIdentifier: exampleAwsRdsCluster.id,
dbClusterSnapshotIdentifier: "resourcetestsnapshot1234",
});
import pulumi
import pulumi_aws as aws
example = aws.rds.ClusterSnapshot("example",
db_cluster_identifier=example_aws_rds_cluster["id"],
db_cluster_snapshot_identifier="resourcetestsnapshot1234")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Rds.ClusterSnapshot("example", new()
{
DbClusterIdentifier = exampleAwsRdsCluster.Id,
DbClusterSnapshotIdentifier = "resourcetestsnapshot1234",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.NewClusterSnapshot(ctx, "example", &rds.ClusterSnapshotArgs{
DbClusterIdentifier: pulumi.Any(exampleAwsRdsCluster.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.rds.ClusterSnapshot;
import com.pulumi.aws.rds.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(exampleAwsRdsCluster.id())
.dbClusterSnapshotIdentifier("resourcetestsnapshot1234")
.build());
}
}
resources:
example:
type: aws:rds:ClusterSnapshot
properties:
dbClusterIdentifier: ${exampleAwsRdsCluster.id}
dbClusterSnapshotIdentifier: resourcetestsnapshot1234

Import

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

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

Properties

Link copied to clipboard
val allocatedStorage: Output<Int>

Allocated storage size in gigabytes (GB).

Link copied to clipboard

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

Link copied to clipboard

The DB Cluster Identifier from which to take the snapshot.

Link copied to clipboard

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

Link copied to clipboard

The Identifier for the snapshot.

Link copied to clipboard
val engine: Output<String>

Name of the database engine.

Link copied to clipboard
val engineVersion: Output<String>

Version of the database engine for this DB cluster snapshot.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kmsKeyId: Output<String>

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

Link copied to clipboard
val licenseModel: Output<String>

License model information for the restored DB cluster.

Link copied to clipboard
val port: Output<Int>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val sharedAccounts: Output<List<String>>?

List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.

Link copied to clipboard
val snapshotType: Output<String>
Link copied to clipboard
Link copied to clipboard
val status: Output<String>

The status of this DB Cluster Snapshot.

Link copied to clipboard

Whether the DB cluster snapshot is encrypted.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val vpcId: Output<String>

The VPC ID associated with the DB cluster snapshot.