Class: Aws::ForecastService::Types::S3Config
- Inherits:
-
Struct
- Object
- Struct
- Aws::ForecastService::Types::S3Config
- Defined in:
- gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb
Overview
When making an API call, you may pass S3Config data as a hash:
{
path: "S3Path", # required
role_arn: "Arn", # required
kms_key_arn: "KMSKeyArn",
}
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#kms_key_arn ⇒ String
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
-
#path ⇒ String
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
-
#role_arn ⇒ String
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files.
Instance Attribute Details
#kms_key_arn ⇒ String
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
3705 3706 3707 3708 3709 3710 3711 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3705 class S3Config < Struct.new( :path, :role_arn, :kms_key_arn) SENSITIVE = [] include Aws::Structure end |
#path ⇒ String
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
3705 3706 3707 3708 3709 3710 3711 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3705 class S3Config < Struct.new( :path, :role_arn, :kms_key_arn) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
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.
3705 3706 3707 3708 3709 3710 3711 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3705 class S3Config < Struct.new( :path, :role_arn, :kms_key_arn) SENSITIVE = [] include Aws::Structure end |