Package software.amazon.awscdk.services.redshift

Class CfnSnapshotCopyGrant

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.redshift.CfnSnapshotCopyGrant
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISnapshotCopyGrantRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:59.723Z") @Stability(Stable) public class CfnSnapshotCopyGrant extends CfnResource implements IInspectable, ISnapshotCopyGrantRef, ITaggableV2
Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from AWS Key Management Service (KMS) to encrypt copied snapshots in a destination region.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 CfnSnapshotCopyGrant cfnSnapshotCopyGrant = CfnSnapshotCopyGrant.Builder.create(this, "MyCfnSnapshotCopyGrant")
         .snapshotCopyGrantName("snapshotCopyGrantName")
         // the properties below are optional
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSnapshotCopyGrant

      protected CfnSnapshotCopyGrant(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSnapshotCopyGrant

      protected CfnSnapshotCopyGrant(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSnapshotCopyGrant

      @Stability(Stable) public CfnSnapshotCopyGrant(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSnapshotCopyGrantProps props)
      Create a new AWS::Redshift::SnapshotCopyGrant.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForSnapshotCopyGrant

      @Stability(Stable) @NotNull public static String arnForSnapshotCopyGrant(@NotNull ISnapshotCopyGrantRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSnapshotCopyGrant

      @Stability(Stable) @NotNull public static Boolean isCfnSnapshotCopyGrant(@NotNull Object x)
      Checks whether the given object is a CfnSnapshotCopyGrant.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the snapshot copy grant.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getSnapshotCopyGrantRef

      @Stability(Stable) @NotNull public SnapshotCopyGrantReference getSnapshotCopyGrantRef()
      A reference to a SnapshotCopyGrant resource.
      Specified by:
      getSnapshotCopyGrantRef in interface ISnapshotCopyGrantRef

    • getSnapshotCopyGrantName

      @Stability(Stable) @NotNull public String getSnapshotCopyGrantName()
      The name of the snapshot copy grant.

    • setSnapshotCopyGrantName

      @Stability(Stable) public void setSnapshotCopyGrantName(@NotNull String value)
      The name of the snapshot copy grant.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tag instances.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tag instances.