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

Inherits:
Struct
  • Object
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_arn ⇒ String

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

Returns:

  • (String) 


1880
1881
1882
1883
1884
1885
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1880

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.

Returns:

  • (String) 


1880
1881
1882
1883
1884
1885
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1880

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