You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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. This object is optionally submitted in the CreateDataset and CreatePredictor requests.

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_arnString

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

Returns:

  • (String)


1528
1529
1530
1531
1532
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1528

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

#role_arnString

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the AWS KMS key.

Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an InvalidInputException is thrown.

Returns:

  • (String)


1528
1529
1530
1531
1532
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1528

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