ClusterSnapshot class

Creates a Redshift cluster snapshot

Example Usage

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

const example = new aws.redshift.ClusterSnapshot("example", {
    clusterSnapshotName: "example",
    clusterSnapshotContent: JSON.stringify({
        AllowDBUserOverride: "1",
        Client_ID: "ExampleClientID",
        App_ID: "example",
    }),
});
import pulumi
import json
import pulumi_aws as aws

example = aws.redshift.ClusterSnapshot("example",
    cluster_snapshot_name="example",
    cluster_snapshot_content=json.dumps({
        "AllowDBUserOverride": "1",
        "Client_ID": "ExampleClientID",
        "App_ID": "example",
    }))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.RedShift.ClusterSnapshot("example", new()
    {
        ClusterSnapshotName = "example",
        ClusterSnapshotContent = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["AllowDBUserOverride"] = "1",
            ["Client_ID"] = "ExampleClientID",
            ["App_ID"] = "example",
        }),
    });

});
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]string{
			"AllowDBUserOverride": "1",
			"Client_ID":           "ExampleClientID",
			"App_ID":              "example",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = redshift.NewClusterSnapshot(ctx, "example", &redshift.ClusterSnapshotArgs{
			ClusterSnapshotName:    "example",
			ClusterSnapshotContent: json0,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_redshift_clustersnapshot" "example" {
  cluster_snapshot_name = "example"
  cluster_snapshot_content = jsonencode({
    "AllowDBUserOverride" = "1"
    "Client_ID"           = "ExampleClientID"
    "App_ID"              = "example"
  })
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.ClusterSnapshot;
import com.pulumi.aws.redshift.ClusterSnapshotArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .clusterSnapshotName("example")
            .clusterSnapshotContent(serializeJson(
                jsonObject(
                    jsonProperty("AllowDBUserOverride", "1"),
                    jsonProperty("Client_ID", "ExampleClientID"),
                    jsonProperty("App_ID", "example")
                )))
            .build());

    }
}
resources:
  example:
    type: aws:redshift:ClusterSnapshot
    properties:
      clusterSnapshotName: example
      clusterSnapshotContent:
        fn::toJSON:
          AllowDBUserOverride: '1'
          Client_ID: ExampleClientID
          App_ID: example

Import

Using pulumi import, import Redshift Cluster Snapshots using snapshotIdentifier. For example:

$ pulumi import aws:redshift/clusterSnapshot:ClusterSnapshot test example

Constructors

ClusterSnapshot(String name, {ClusterSnapshotArgs? args, CustomResourceOptions? options})
Creates a new ClusterSnapshot. name The Pulumi resource name. args Arguments used to configure this ClusterSnapshot. The set of arguments for ClusterSnapshot. options Resource options controlling this resource's behavior.
ClusterSnapshot.reference(String urn)
Creates a typed reference to an existing ClusterSnapshot resource.

Properties

arn ↔ Output<String>
ARN of the snapshot.
latefinal
childResources → Set<Resource>
finalinherited
clusterIdentifier ↔ Output<String>
The cluster identifier for which you want a snapshot.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kmsKeyId ↔ Output<String>
KMS key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
latefinal
manualSnapshotRetentionPeriod ↔ Output<int?>
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
latefinal
ownerAccount ↔ Output<String>
For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snapshotIdentifier ↔ Output<String>
A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ClusterSnapshotState? state, CustomResourceOptions? options}) → ClusterSnapshot
Gets an existing ClusterSnapshot resource's state with the given name and id.