SnapshotCopyGrant class
Creates a snapshot copy grant that allows AWS Redshift to encrypt copied snapshots with a customer master key from AWS KMS in a destination region.
Note that the grant must exist in the destination region, and not in the region of the cluster.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.redshift.SnapshotCopyGrant("test", {snapshotCopyGrantName: "my-grant"});
const testCluster = new aws.redshift.Cluster("test", {snapshotCopy: [{
destinationRegion: "us-east-2",
grantName: test.snapshotCopyGrantName,
}]});
import pulumi
import pulumi_aws as aws
test = aws.redshift.SnapshotCopyGrant("test", snapshot_copy_grant_name="my-grant")
test_cluster = aws.redshift.Cluster("test", snapshot_copy=[{
"destinationRegion": "us-east-2",
"grantName": test.snapshot_copy_grant_name,
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.RedShift.SnapshotCopyGrant("test", new()
{
SnapshotCopyGrantName = "my-grant",
});
var testCluster = new Aws.RedShift.Cluster("test", new()
{
SnapshotCopy = new[]
{
{
{ "destinationRegion", "us-east-2" },
{ "grantName", test.SnapshotCopyGrantName },
},
},
});
});
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 {
test, err := redshift.NewSnapshotCopyGrant(ctx, "test", &redshift.SnapshotCopyGrantArgs{
SnapshotCopyGrantName: pulumi.String("my-grant"),
})
if err != nil {
return err
}
_, err = redshift.NewCluster(ctx, "test", &redshift.ClusterArgs{
SnapshotCopy: []map[string]interface{}{
map[string]interface{}{
"destinationRegion": "us-east-2",
"grantName": test.SnapshotCopyGrantName,
},
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_redshift_snapshotcopygrant" "test" {
snapshot_copy_grant_name = "my-grant"
}
resource "aws_redshift_cluster" "test" {
snapshot_copy = [{
"destinationRegion" = "us-east-2"
"grantName" = aws_redshift_snapshotcopygrant.test.snapshot_copy_grant_name
}]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.SnapshotCopyGrant;
import com.pulumi.aws.redshift.SnapshotCopyGrantArgs;
import com.pulumi.aws.redshift.Cluster;
import com.pulumi.aws.redshift.ClusterArgs;
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 test = new SnapshotCopyGrant("test", SnapshotCopyGrantArgs.builder()
.snapshotCopyGrantName("my-grant")
.build());
var testCluster = new Cluster("testCluster", ClusterArgs.builder()
.snapshotCopy(Arrays.asList(Map.ofEntries(
Map.entry("destinationRegion", "us-east-2"),
Map.entry("grantName", test.snapshotCopyGrantName())
)))
.build());
}
}
resources:
test:
type: aws:redshift:SnapshotCopyGrant
properties:
snapshotCopyGrantName: my-grant
testCluster:
type: aws:redshift:Cluster
name: test
properties:
snapshotCopy:
- destinationRegion: us-east-2
grantName: ${test.snapshotCopyGrantName}
Import
Using pulumi import, import Redshift Snapshot Copy Grants by name. For example:
$ pulumi import aws:redshift/snapshotCopyGrant:SnapshotCopyGrant test my-grant
Constructors
- SnapshotCopyGrant(String name, {SnapshotCopyGrantArgs? args, CustomResourceOptions? options})
-
Creates a new SnapshotCopyGrant.
nameThe Pulumi resource name.argsArguments used to configure this SnapshotCopyGrant. The set of arguments for SnapshotCopyGrant.optionsResource options controlling this resource's behavior. - SnapshotCopyGrant.reference(String urn)
- Creates a typed reference to an existing SnapshotCopyGrant resource.
Properties
-
arn
↔ Output<
String> -
ARN of snapshot copy grant
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> -
Unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the ARN of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. If not specified, the default key is used.
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
-
snapshotCopyGrantName
↔ Output<
String> -
A friendly name for identifying the grant.
latefinal
-
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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, {SnapshotCopyGrantState? state, CustomResourceOptions? options}) → SnapshotCopyGrant -
Gets an existing SnapshotCopyGrant resource's state with the given
nameandid.