SnapshotCopyGrant

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var testSnapshotCopyGrant = new Aws.RedShift.SnapshotCopyGrant("testSnapshotCopyGrant", new Aws.RedShift.SnapshotCopyGrantArgs
        {
            SnapshotCopyGrantName = "my-grant",
        });
        var testCluster = new Aws.RedShift.Cluster("testCluster", new Aws.RedShift.ClusterArgs
        {
            SnapshotCopy = new Aws.RedShift.Inputs.ClusterSnapshotCopyArgs
            {
                DestinationRegion = "us-east-2",
                GrantName = testSnapshotCopyGrant.SnapshotCopyGrantName,
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/redshift"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        testSnapshotCopyGrant, err := redshift.NewSnapshotCopyGrant(ctx, "testSnapshotCopyGrant", &redshift.SnapshotCopyGrantArgs{
            SnapshotCopyGrantName: pulumi.String("my-grant"),
        })
        if err != nil {
            return err
        }
        _, err = redshift.NewCluster(ctx, "testCluster", &redshift.ClusterArgs{
            SnapshotCopy: &redshift.ClusterSnapshotCopyArgs{
                DestinationRegion: pulumi.String("us-east-2"),
                GrantName:         testSnapshotCopyGrant.SnapshotCopyGrantName,
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

test_snapshot_copy_grant = aws.redshift.SnapshotCopyGrant("testSnapshotCopyGrant", snapshot_copy_grant_name="my-grant")
test_cluster = aws.redshift.Cluster("testCluster", snapshot_copy={
    "destinationRegion": "us-east-2",
    "grantName": test_snapshot_copy_grant.snapshot_copy_grant_name,
})

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

const testSnapshotCopyGrant = new aws.redshift.SnapshotCopyGrant("test", {
    snapshotCopyGrantName: "my-grant",
});
const testCluster = new aws.redshift.Cluster("test", {
    // ... other configuration ...
    snapshotCopy: {
        destinationRegion: "us-east-2",
        grantName: testSnapshotCopyGrant.snapshotCopyGrantName,
    },
});

Create a SnapshotCopyGrant Resource

new SnapshotCopyGrant(name: string, args: SnapshotCopyGrantArgs, opts?: CustomResourceOptions);

def SnapshotCopyGrant(resource_name, opts=None, kms_key_id=None, snapshot_copy_grant_name=None, tags=None, __props__=None);

func NewSnapshotCopyGrant(ctx *Context, name string, args SnapshotCopyGrantArgs, opts ...ResourceOption) (*SnapshotCopyGrant, error)

public SnapshotCopyGrant(string name, SnapshotCopyGrantArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args SnapshotCopyGrantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SnapshotCopyGrantArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SnapshotCopyGrantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

SnapshotCopyGrant Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The SnapshotCopyGrant resource accepts the following input properties:

SnapshotCopyGrantName string: A friendly name for identifying the grant.
KmsKeyId string: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

SnapshotCopyGrantName string: A friendly name for identifying the grant.
KmsKeyId string: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
Tags map[string]string: A map of tags to assign to the resource.

snapshotCopyGrantName string: A friendly name for identifying the grant.
kmsKeyId string: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
tags {[key: string]: string}: A map of tags to assign to the resource.

snapshot_copy_grant_name str: A friendly name for identifying the grant.
kms_key_id str: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
tags Dict[str, str]: A map of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the SnapshotCopyGrant resource produces the following output properties:

Arn string: Amazon Resource Name (ARN) of snapshot copy grant
Id string: The provider-assigned unique ID for this managed resource.

Arn string: Amazon Resource Name (ARN) of snapshot copy grant
Id string: The provider-assigned unique ID for this managed resource.

arn string: Amazon Resource Name (ARN) of snapshot copy grant
id string: The provider-assigned unique ID for this managed resource.

arn str: Amazon Resource Name (ARN) of snapshot copy grant
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing SnapshotCopyGrant Resource

Get an existing SnapshotCopyGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SnapshotCopyGrantState, opts?: CustomResourceOptions): SnapshotCopyGrant

static get(resource_name, id, opts=None, arn=None, kms_key_id=None, snapshot_copy_grant_name=None, tags=None, __props__=None);

func GetSnapshotCopyGrant(ctx *Context, name string, id IDInput, state *SnapshotCopyGrantState, opts ...ResourceOption) (*SnapshotCopyGrant, error)

public static SnapshotCopyGrant Get(string name, Input<string> id, SnapshotCopyGrantState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: Amazon Resource Name (ARN) of snapshot copy grant
KmsKeyId string: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
SnapshotCopyGrantName string: A friendly name for identifying the grant.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Arn string: Amazon Resource Name (ARN) of snapshot copy grant
KmsKeyId string: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
SnapshotCopyGrantName string: A friendly name for identifying the grant.
Tags map[string]string: A map of tags to assign to the resource.

arn string: Amazon Resource Name (ARN) of snapshot copy grant
kmsKeyId string: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
snapshotCopyGrantName string: A friendly name for identifying the grant.
tags {[key: string]: string}: A map of tags to assign to the resource.

arn str: Amazon Resource Name (ARN) of snapshot copy grant
kms_key_id str: The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (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.
snapshot_copy_grant_name str: A friendly name for identifying the grant.
tags Dict[str, str]: A map of tags to assign to the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud