Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. SnapshotCopyGrant
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.redshift.SnapshotCopyGrant

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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={
    "destination_region": "us-east-2",
    "grant_name": test.snapshot_copy_grant_name,
})

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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: &redshift.ClusterSnapshotCopyArgs{
				DestinationRegion: pulumi.String("us-east-2"),
				GrantName:         test.SnapshotCopyGrantName,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 Aws.RedShift.Inputs.ClusterSnapshotCopyArgs
        {
            DestinationRegion = "us-east-2",
            GrantName = test.SnapshotCopyGrantName,
        },
    });

});

    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 com.pulumi.aws.redshift.inputs.ClusterSnapshotCopyArgs;
import java.util.List;
import java.util.ArrayList;
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(ClusterSnapshotCopyArgs.builder()
                .destinationRegion("us-east-2")
                .grantName(test.snapshotCopyGrantName())
                .build())
            .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}

    Create SnapshotCopyGrant Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SnapshotCopyGrant(name: string, args: SnapshotCopyGrantArgs, opts?: CustomResourceOptions);
    @overload
def SnapshotCopyGrant(resource_name: str,
                      args: SnapshotCopyGrantArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def SnapshotCopyGrant(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      snapshot_copy_grant_name: Optional[str] = None,
                      kms_key_id: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewSnapshotCopyGrant(ctx *Context, name string, args SnapshotCopyGrantArgs, opts ...ResourceOption) (*SnapshotCopyGrant, error)
    public SnapshotCopyGrant(string name, SnapshotCopyGrantArgs args, CustomResourceOptions? opts = null)
    public SnapshotCopyGrant(String name, SnapshotCopyGrantArgs args)
public SnapshotCopyGrant(String name, SnapshotCopyGrantArgs args, CustomResourceOptions options)

    type: aws:redshift:SnapshotCopyGrant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args SnapshotCopyGrantArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args SnapshotCopyGrantArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var snapshotCopyGrantResource = new Aws.RedShift.SnapshotCopyGrant("snapshotCopyGrantResource", new()
{
    SnapshotCopyGrantName = "string",
    KmsKeyId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := redshift.NewSnapshotCopyGrant(ctx, "snapshotCopyGrantResource", &redshift.SnapshotCopyGrantArgs{
	SnapshotCopyGrantName: pulumi.String("string"),
	KmsKeyId:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var snapshotCopyGrantResource = new SnapshotCopyGrant("snapshotCopyGrantResource", SnapshotCopyGrantArgs.builder()
    .snapshotCopyGrantName("string")
    .kmsKeyId("string")
    .tags(Map.of("string", "string"))
    .build());

    snapshot_copy_grant_resource = aws.redshift.SnapshotCopyGrant("snapshotCopyGrantResource",
    snapshot_copy_grant_name="string",
    kms_key_id="string",
    tags={
        "string": "string",
    })

    const snapshotCopyGrantResource = new aws.redshift.SnapshotCopyGrant("snapshotCopyGrantResource", {
    snapshotCopyGrantName: "string",
    kmsKeyId: "string",
    tags: {
        string: "string",
    },
});

    type: aws:redshift:SnapshotCopyGrant
properties:
    kmsKeyId: string
    snapshotCopyGrantName: string
    tags:
        string: string

    SnapshotCopyGrant Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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 Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of snapshot copy grant
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of snapshot copy grant
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of snapshot copy grant
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of snapshot copy grant
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of snapshot copy grant
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        snapshot_copy_grant_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> SnapshotCopyGrant
    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)
    public static SnapshotCopyGrant get(String name, Output<String> id, SnapshotCopyGrantState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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 Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import Redshift Snapshot Copy Grants by name. For example:

    $ pulumi import aws:redshift/snapshotCopyGrant:SnapshotCopyGrant test my-grant

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws