Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. forecast
  5. Dataset

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.forecast.Dataset

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type Definition for AWS::Forecast::Dataset

Create Dataset Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Dataset(name: string, args: DatasetArgs, opts?: CustomResourceOptions);
@overload
def Dataset(resource_name: str,
            args: DatasetArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Dataset(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            dataset_type: Optional[DatasetType] = None,
            domain: Optional[DatasetDomain] = None,
            schema: Optional[SchemaPropertiesArgs] = None,
            data_frequency: Optional[str] = None,
            dataset_name: Optional[str] = None,
            encryption_config: Optional[EncryptionConfigPropertiesArgs] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDataset(ctx *Context, name string, args DatasetArgs, opts ...ResourceOption) (*Dataset, error)
public Dataset(string name, DatasetArgs args, CustomResourceOptions? opts = null)
public Dataset(String name, DatasetArgs args)
public Dataset(String name, DatasetArgs args, CustomResourceOptions options)

type: aws-native:forecast:Dataset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatasetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DatasetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DatasetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatasetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatasetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Dataset Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Dataset resource accepts the following input properties:

DatasetType This property is required. Pulumi.AwsNative.Forecast.DatasetType
The dataset type
Domain This property is required. Pulumi.AwsNative.Forecast.DatasetDomain
The domain associated with the dataset
Schema This property is required. Pulumi.AwsNative.Forecast.Inputs.SchemaProperties
The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
DataFrequency string
Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
DatasetName string
A name for the dataset
EncryptionConfig Pulumi.AwsNative.Forecast.Inputs.EncryptionConfigProperties
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
Tags List<Pulumi.AwsNative.Inputs.Tag>

An array of key-value pairs to apply to this resource.

For more information, see Tag .

DatasetType This property is required. DatasetType
The dataset type
Domain This property is required. DatasetDomain
The domain associated with the dataset
Schema This property is required. SchemaPropertiesArgs
The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
DataFrequency string
Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
DatasetName string
A name for the dataset
EncryptionConfig EncryptionConfigPropertiesArgs
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
Tags TagArgs

An array of key-value pairs to apply to this resource.

For more information, see Tag .

datasetType This property is required. DatasetType
The dataset type
domain This property is required. DatasetDomain
The domain associated with the dataset
schema This property is required. SchemaProperties
The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
dataFrequency String
Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
datasetName String
A name for the dataset
encryptionConfig EncryptionConfigProperties
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
tags List<Tag>

An array of key-value pairs to apply to this resource.

For more information, see Tag .

datasetType This property is required. DatasetType
The dataset type
domain This property is required. DatasetDomain
The domain associated with the dataset
schema This property is required. SchemaProperties
The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
dataFrequency string
Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
datasetName string
A name for the dataset
encryptionConfig EncryptionConfigProperties
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
tags Tag[]

An array of key-value pairs to apply to this resource.

For more information, see Tag .

dataset_type This property is required. DatasetType
The dataset type
domain This property is required. DatasetDomain
The domain associated with the dataset
schema This property is required. SchemaPropertiesArgs
The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
data_frequency str
Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
dataset_name str
A name for the dataset
encryption_config EncryptionConfigPropertiesArgs
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
tags Sequence[TagArgs]

An array of key-value pairs to apply to this resource.

For more information, see Tag .

datasetType This property is required. "TARGET_TIME_SERIES" | "RELATED_TIME_SERIES" | "ITEM_METADATA"
The dataset type
domain This property is required. "RETAIL" | "CUSTOM" | "INVENTORY_PLANNING" | "EC2_CAPACITY" | "WORK_FORCE" | "WEB_TRAFFIC" | "METRICS"
The domain associated with the dataset
schema This property is required. Property Map
The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
dataFrequency String
Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
datasetName String
A name for the dataset
encryptionConfig Property Map
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
tags List<Property Map>

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Outputs

All input properties are implicitly available as output properties. Additionally, the Dataset resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the dataset.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The Amazon Resource Name (ARN) of the dataset.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the dataset.
id String
The provider-assigned unique ID for this managed resource.
arn string
The Amazon Resource Name (ARN) of the dataset.
id string
The provider-assigned unique ID for this managed resource.
arn str
The Amazon Resource Name (ARN) of the dataset.
id str
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the dataset.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

DatasetAttributesItemProperties
, DatasetAttributesItemPropertiesArgs

AttributeName string
Name of the dataset field
AttributeType DatasetAttributesItemPropertiesAttributeType
Data type of the field
attributeName String
Name of the dataset field
attributeType DatasetAttributesItemPropertiesAttributeType
Data type of the field
attributeName string
Name of the dataset field
attributeType DatasetAttributesItemPropertiesAttributeType
Data type of the field
attribute_name str
Name of the dataset field
attribute_type DatasetAttributesItemPropertiesAttributeType
Data type of the field

DatasetAttributesItemPropertiesAttributeType
, DatasetAttributesItemPropertiesAttributeTypeArgs

String
string
Integer
integer
Float
float
Timestamp
timestamp
Geolocation
geolocation
DatasetAttributesItemPropertiesAttributeTypeString
string
DatasetAttributesItemPropertiesAttributeTypeInteger
integer
DatasetAttributesItemPropertiesAttributeTypeFloat
float
DatasetAttributesItemPropertiesAttributeTypeTimestamp
timestamp
DatasetAttributesItemPropertiesAttributeTypeGeolocation
geolocation
String
string
Integer
integer
Float
float
Timestamp
timestamp
Geolocation
geolocation
String
string
Integer
integer
Float
float
Timestamp
timestamp
Geolocation
geolocation
STRING
string
INTEGER
integer
FLOAT
float
TIMESTAMP
timestamp
GEOLOCATION
geolocation
"string"
string
"integer"
integer
"float"
float
"timestamp"
timestamp
"geolocation"
geolocation

DatasetDomain
, DatasetDomainArgs

Retail
RETAIL
Custom
CUSTOM
InventoryPlanning
INVENTORY_PLANNING
Ec2Capacity
EC2_CAPACITY
WorkForce
WORK_FORCE
WebTraffic
WEB_TRAFFIC
Metrics
METRICS
DatasetDomainRetail
RETAIL
DatasetDomainCustom
CUSTOM
DatasetDomainInventoryPlanning
INVENTORY_PLANNING
DatasetDomainEc2Capacity
EC2_CAPACITY
DatasetDomainWorkForce
WORK_FORCE
DatasetDomainWebTraffic
WEB_TRAFFIC
DatasetDomainMetrics
METRICS
Retail
RETAIL
Custom
CUSTOM
InventoryPlanning
INVENTORY_PLANNING
Ec2Capacity
EC2_CAPACITY
WorkForce
WORK_FORCE
WebTraffic
WEB_TRAFFIC
Metrics
METRICS
Retail
RETAIL
Custom
CUSTOM
InventoryPlanning
INVENTORY_PLANNING
Ec2Capacity
EC2_CAPACITY
WorkForce
WORK_FORCE
WebTraffic
WEB_TRAFFIC
Metrics
METRICS
RETAIL
RETAIL
CUSTOM
CUSTOM
INVENTORY_PLANNING
INVENTORY_PLANNING
EC2_CAPACITY
EC2_CAPACITY
WORK_FORCE
WORK_FORCE
WEB_TRAFFIC
WEB_TRAFFIC
METRICS
METRICS
"RETAIL"
RETAIL
"CUSTOM"
CUSTOM
"INVENTORY_PLANNING"
INVENTORY_PLANNING
"EC2_CAPACITY"
EC2_CAPACITY
"WORK_FORCE"
WORK_FORCE
"WEB_TRAFFIC"
WEB_TRAFFIC
"METRICS"
METRICS

DatasetType
, DatasetTypeArgs

TargetTimeSeries
TARGET_TIME_SERIES
RelatedTimeSeries
RELATED_TIME_SERIES
ItemMetadata
ITEM_METADATA
DatasetTypeTargetTimeSeries
TARGET_TIME_SERIES
DatasetTypeRelatedTimeSeries
RELATED_TIME_SERIES
DatasetTypeItemMetadata
ITEM_METADATA
TargetTimeSeries
TARGET_TIME_SERIES
RelatedTimeSeries
RELATED_TIME_SERIES
ItemMetadata
ITEM_METADATA
TargetTimeSeries
TARGET_TIME_SERIES
RelatedTimeSeries
RELATED_TIME_SERIES
ItemMetadata
ITEM_METADATA
TARGET_TIME_SERIES
TARGET_TIME_SERIES
RELATED_TIME_SERIES
RELATED_TIME_SERIES
ITEM_METADATA
ITEM_METADATA
"TARGET_TIME_SERIES"
TARGET_TIME_SERIES
"RELATED_TIME_SERIES"
RELATED_TIME_SERIES
"ITEM_METADATA"
ITEM_METADATA

EncryptionConfigProperties
, EncryptionConfigPropertiesArgs

KmsKeyArn string
The Amazon Resource Name (ARN) of the KMS key.
RoleArn 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.

KmsKeyArn string
The Amazon Resource Name (ARN) of the KMS key.
RoleArn 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.

kmsKeyArn String
The Amazon Resource Name (ARN) of the KMS key.
roleArn 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.

kmsKeyArn string
The Amazon Resource Name (ARN) of the KMS key.
roleArn 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.

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

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.

kmsKeyArn String
The Amazon Resource Name (ARN) of the KMS key.
roleArn 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.

SchemaProperties
, SchemaPropertiesArgs

Attributes List<Pulumi.AwsNative.Forecast.Inputs.DatasetAttributesItemProperties>
An array of attributes specifying the name and type of each field in a dataset.
Attributes []DatasetAttributesItemProperties
An array of attributes specifying the name and type of each field in a dataset.
attributes List<DatasetAttributesItemProperties>
An array of attributes specifying the name and type of each field in a dataset.
attributes DatasetAttributesItemProperties[]
An array of attributes specifying the name and type of each field in a dataset.
attributes Sequence[DatasetAttributesItemProperties]
An array of attributes specifying the name and type of each field in a dataset.
attributes List<Property Map>
An array of attributes specifying the name and type of each field in a dataset.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native