Class: Aws::ForecastService::Types::EncryptionConfig

Inherits:

Struct

Object
Struct
Aws::ForecastService::Types::EncryptionConfig

show all

Defined in:: gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Note:

When making an API call, you may pass EncryptionConfig data as a hash:

{
  role_arn: "Arn", # required
  kms_key_arn: "KMSKeyArn", # required
}

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#kms_key_arn ⇒ String
The Amazon Resource Name (ARN) of the KMS key.
#role_arn ⇒ String
The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Instance Attribute Details

#kms_key_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3789

class EncryptionConfig < Struct.new(
  :role_arn,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

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.