libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.CreateSnapshotCopyGrant

Description

Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from Key Management Service (KMS) to encrypt copied snapshots in a destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Synopsis

Creating a Request

data CreateSnapshotCopyGrant Source #

The result of the CreateSnapshotCopyGrant action.

See: newCreateSnapshotCopyGrant smart constructor.

Constructors

CreateSnapshotCopyGrant' 

Fields

  • kmsKeyId :: Maybe Text

    The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

  • tags :: Maybe [Tag]

    A list of tag instances.

  • snapshotCopyGrantName :: Text

    The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • Alphabetic characters must be lowercase.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    • Must be unique for all clusters within an Amazon Web Services account.

Instances

Instances details
Eq CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Read CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Show CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Generic CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Associated Types

type Rep CreateSnapshotCopyGrant :: Type -> Type #

NFData CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Methods

rnf :: CreateSnapshotCopyGrant -> () #

Hashable CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

AWSRequest CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

ToHeaders CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

ToPath CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

ToQuery CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

type Rep CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

type Rep CreateSnapshotCopyGrant = D1 ('MetaData "CreateSnapshotCopyGrant" "Amazonka.Redshift.CreateSnapshotCopyGrant" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateSnapshotCopyGrant'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "snapshotCopyGrantName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateSnapshotCopyGrant Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

newCreateSnapshotCopyGrant Source #

Create a value of CreateSnapshotCopyGrant with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:CreateSnapshotCopyGrant', createSnapshotCopyGrant_kmsKeyId - The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

$sel:tags:CreateSnapshotCopyGrant', createSnapshotCopyGrant_tags - A list of tag instances.

$sel:snapshotCopyGrantName:CreateSnapshotCopyGrant', createSnapshotCopyGrant_snapshotCopyGrantName - The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • Alphabetic characters must be lowercase.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
  • Must be unique for all clusters within an Amazon Web Services account.

Request Lenses

createSnapshotCopyGrant_kmsKeyId :: Lens' CreateSnapshotCopyGrant (Maybe Text) Source #

The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

createSnapshotCopyGrant_snapshotCopyGrantName :: Lens' CreateSnapshotCopyGrant Text Source #

The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • Alphabetic characters must be lowercase.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
  • Must be unique for all clusters within an Amazon Web Services account.

Destructuring the Response

data CreateSnapshotCopyGrantResponse Source #

See: newCreateSnapshotCopyGrantResponse smart constructor.

Constructors

CreateSnapshotCopyGrantResponse' 

Fields

Instances

Instances details
Eq CreateSnapshotCopyGrantResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Read CreateSnapshotCopyGrantResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Show CreateSnapshotCopyGrantResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Generic CreateSnapshotCopyGrantResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

Associated Types

type Rep CreateSnapshotCopyGrantResponse :: Type -> Type #

NFData CreateSnapshotCopyGrantResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

type Rep CreateSnapshotCopyGrantResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateSnapshotCopyGrant

type Rep CreateSnapshotCopyGrantResponse = D1 ('MetaData "CreateSnapshotCopyGrantResponse" "Amazonka.Redshift.CreateSnapshotCopyGrant" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateSnapshotCopyGrantResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshotCopyGrant") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapshotCopyGrant)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSnapshotCopyGrantResponse Source #

Create a value of CreateSnapshotCopyGrantResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:snapshotCopyGrant:CreateSnapshotCopyGrantResponse', createSnapshotCopyGrantResponse_snapshotCopyGrant - Undocumented member.

$sel:httpStatus:CreateSnapshotCopyGrantResponse', createSnapshotCopyGrantResponse_httpStatus - The response's http status code.

Response Lenses