Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Forecast.Types.S3Config

Description

Synopsis

data S3Config = S3Config' {
- kmsKeyArn :: Maybe Text
- path :: Text
- roleArn :: Text
}
newS3Config :: Text -> Text -> S3Config
s3Config_kmsKeyArn :: Lens' S3Config (Maybe Text)
s3Config_path :: Lens' S3Config Text
s3Config_roleArn :: Lens' S3Config Text

Documentation

data S3Config Source #

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.

See: newS3Config smart constructor.

Constructors

S3Config'

Fields

kmsKeyArn :: Maybe Text
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
path :: Text
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
roleArn :: Text
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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.

Instances

Instances details

Eq S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Methods (==) :: S3Config -> S3Config -> Bool # (/=) :: S3Config -> S3Config -> Bool #
Read S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Methods readsPrec :: Int -> ReadS S3Config # readList :: ReadS [S3Config] # readPrec :: ReadPrec S3Config # readListPrec :: ReadPrec [S3Config] #
Show S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Methods showsPrec :: Int -> S3Config -> ShowS # show :: S3Config -> String # showList :: [S3Config] -> ShowS #
Generic S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Associated Types type Rep S3Config :: Type -> Type # Methods from :: S3Config -> Rep S3Config x # to :: Rep S3Config x -> S3Config #
NFData S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Methods rnf :: S3Config -> () #
Hashable S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Methods hashWithSalt :: Int -> S3Config -> Int # hash :: S3Config -> Int #
ToJSON S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Methods toJSON :: S3Config -> Value # toEncoding :: S3Config -> Encoding # toJSONList :: [S3Config] -> Value # toEncodingList :: [S3Config] -> Encoding #
FromJSON S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config Methods parseJSON :: Value -> Parser S3Config # parseJSONList :: Value -> Parser [S3Config] #
type Rep S3Config Source #
Instance details Defined in Amazonka.Forecast.Types.S3Config type Rep S3Config = D1 ('MetaData "S3Config" "Amazonka.Forecast.Types.S3Config" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "S3Config'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newS3Config Source #

Arguments

:: Text	`$sel:path:S3Config'`
-> Text	`$sel:roleArn:S3Config'`
-> S3Config

Create a value of S3Config 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:kmsKeyArn:S3Config', s3Config_kmsKeyArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

$sel:path:S3Config', s3Config_path - The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

$sel:roleArn:S3Config', s3Config_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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.

s3Config_kmsKeyArn :: Lens' S3Config (Maybe Text) Source #

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

s3Config_path :: Lens' S3Config Text Source #

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

s3Config_roleArn :: Lens' S3Config Text Source #

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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.