SnapshotCopy class
Resource for managing an AWS Redshift Snapshot Copy.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.redshift.SnapshotCopy("example", {
clusterIdentifier: exampleAwsRedshiftCluster.id,
destinationRegion: "us-east-1",
});
import pulumi
import pulumi_aws as aws
example = aws.redshift.SnapshotCopy("example",
cluster_identifier=example_aws_redshift_cluster["id"],
destination_region="us-east-1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.RedShift.SnapshotCopy("example", new()
{
ClusterIdentifier = exampleAwsRedshiftCluster.Id,
DestinationRegion = "us-east-1",
});
});
package main
import (
"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 {
_, err := redshift.NewSnapshotCopy(ctx, "example", &redshift.SnapshotCopyArgs{
ClusterIdentifier: pulumi.Any(exampleAwsRedshiftCluster.Id),
DestinationRegion: pulumi.String("us-east-1"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_redshift_snapshotcopy" "example" {
cluster_identifier = exampleAwsRedshiftCluster.id
destination_region = "us-east-1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.SnapshotCopy;
import com.pulumi.aws.redshift.SnapshotCopyArgs;
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 SnapshotCopy("example", SnapshotCopyArgs.builder()
.clusterIdentifier(exampleAwsRedshiftCluster.id())
.destinationRegion("us-east-1")
.build());
}
}
resources:
example:
type: aws:redshift:SnapshotCopy
properties:
clusterIdentifier: ${exampleAwsRedshiftCluster.id}
destinationRegion: us-east-1
Import
Using pulumi import, import Redshift Snapshot Copy using the id. For example:
$ pulumi import aws:redshift/snapshotCopy:SnapshotCopy example cluster-id-12345678
Constructors
- SnapshotCopy(String name, {SnapshotCopyArgs? args, CustomResourceOptions? options})
-
Creates a new SnapshotCopy.
nameThe Pulumi resource name.argsArguments used to configure this SnapshotCopy. The set of arguments for SnapshotCopy.optionsResource options controlling this resource's behavior. - SnapshotCopy.reference(String urn)
- Creates a typed reference to an existing SnapshotCopy resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
clusterIdentifier
↔ Output<
String> -
Identifier of the source cluster.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
destinationRegion
↔ Output<
String> -
AWS Region to copy snapshots to.
latefinal
- 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
-
manualSnapshotRetentionPeriod
↔ Output<
int> -
Number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is
-1, the manual snapshot is retained indefinitely.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> -
Number of days to retain automated snapshots in the destination region after they are copied from the source region.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
snapshotCopyGrantName
↔ Output<
String?> -
Name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
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, {SnapshotCopyState? state, CustomResourceOptions? options}) → SnapshotCopy -
Gets an existing SnapshotCopy resource's state with the given
nameandid.