libZSservicesZSamazonka-forecastZSamazonka-forecast
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.Forecast.Types.EncryptionConfig

Description

 
Synopsis

Documentation

data EncryptionConfig Source #

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

See: newEncryptionConfig smart constructor.

Constructors

EncryptionConfig' 

Fields

  • roleArn :: Text

    The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

  • kmsKeyArn :: Text

    The Amazon Resource Name (ARN) of the KMS key.

Instances

Instances details
Eq EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

Read EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

Show EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

Generic EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

Associated Types

type Rep EncryptionConfig :: Type -> Type #

NFData EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

Methods

rnf :: EncryptionConfig -> () #

Hashable EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

ToJSON EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

FromJSON EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

type Rep EncryptionConfig Source # 
Instance details

Defined in Amazonka.Forecast.Types.EncryptionConfig

type Rep EncryptionConfig = D1 ('MetaData "EncryptionConfig" "Amazonka.Forecast.Types.EncryptionConfig" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "EncryptionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEncryptionConfig Source #

Create a value of EncryptionConfig 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:roleArn:EncryptionConfig', encryptionConfig_roleArn - The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

$sel:kmsKeyArn:EncryptionConfig', encryptionConfig_kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key.

encryptionConfig_roleArn :: Lens' EncryptionConfig Text Source #

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

encryptionConfig_kmsKeyArn :: Lens' EncryptionConfig Text Source #

The Amazon Resource Name (ARN) of the KMS key.