Snapshot class

Creates a new Amazon Redshift Serverless Snapshot.

Example Usage

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

const example = new aws.redshiftserverless.Snapshot("example", {
    namespaceName: exampleAwsRedshiftserverlessWorkgroup.namespaceName,
    snapshotName: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.redshiftserverless.Snapshot("example",
    namespace_name=example_aws_redshiftserverless_workgroup["namespaceName"],
    snapshot_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.RedshiftServerless.Snapshot("example", new()
    {
        NamespaceName = exampleAwsRedshiftserverlessWorkgroup.NamespaceName,
        SnapshotName = "example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshiftserverless"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshiftserverless.NewSnapshot(ctx, "example", &redshiftserverless.SnapshotArgs{
			NamespaceName: pulumi.Any(exampleAwsRedshiftserverlessWorkgroup.NamespaceName),
			SnapshotName:  pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_redshiftserverless_snapshot" "example" {
  namespace_name = exampleAwsRedshiftserverlessWorkgroup.namespaceName
  snapshot_name  = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshiftserverless.Snapshot;
import com.pulumi.aws.redshiftserverless.SnapshotArgs;
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 Snapshot("example", SnapshotArgs.builder()
            .namespaceName(exampleAwsRedshiftserverlessWorkgroup.namespaceName())
            .snapshotName("example")
            .build());

    }
}
resources:
  example:
    type: aws:redshiftserverless:Snapshot
    properties:
      namespaceName: ${exampleAwsRedshiftserverlessWorkgroup.namespaceName}
      snapshotName: example

Import

Using pulumi import, import Redshift Serverless Snapshots using the snapshotName. For example:

$ pulumi import aws:redshiftserverless/snapshot:Snapshot example example

Constructors

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

Properties

accountsWithProvisionedRestoreAccesses ↔ Output<List<String>>
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
latefinal
accountsWithRestoreAccesses ↔ Output<List<String>>
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
latefinal
adminUsername ↔ Output<String>
The username of the database within a snapshot.
latefinal
arn ↔ Output<String>
ARN of the snapshot.
latefinal
childResources → Set<Resource>
finalinherited
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>
The unique identifier of the KMS key used to encrypt the snapshot.
latefinal
namespaceArn ↔ Output<String>
ARN of the namespace the snapshot was created from.
latefinal
namespaceName ↔ Output<String>
The namespace to create a snapshot for.
latefinal
ownerAccount ↔ Output<String>
The owner Amazon Web Services; account of the 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
retentionPeriod ↔ Output<int?>
How long to retain the created snapshot. Default value is -1.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snapshotName ↔ Output<String>
The name of the snapshot.
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, {SnapshotState? state, CustomResourceOptions? options}) → Snapshot
Gets an existing Snapshot resource's state with the given name and id.