Class: AWSCDK::Forecast::CfnDatasetGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
forecast/cfn_dataset_group_props.rb

Overview

Properties for defining a CfnDatasetGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dataset_group_name:, domain:, dataset_arns: nil, tags: nil) ⇒ CfnDatasetGroupProps

Returns a new instance of CfnDatasetGroupProps.

Parameters:

  • dataset_group_name (String) —

    The name of the dataset group.

  • domain (String) —

    The domain associated with the dataset group.

  • dataset_arns (Array<String>, nil) (defaults to: nil) —

    An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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



13
14
15
16
17
18
19
20
21
22
 
# File 'forecast/cfn_dataset_group_props.rb', line 13

def initialize(dataset_group_name:, domain:, dataset_arns: nil, tags: nil)
  @dataset_group_name = dataset_group_name
  Jsii::Type.check_type(@dataset_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datasetGroupName")
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain")
  @dataset_arns = dataset_arns
  Jsii::Type.check_type(@dataset_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "datasetArns") unless @dataset_arns.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#dataset_arns ⇒ Array<String>? (readonly)

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

Returns:

  • (Array<String>, nil)

See Also:



42
43
44
 
# File 'forecast/cfn_dataset_group_props.rb', line 42

def dataset_arns
  @dataset_arns
end

#dataset_group_name ⇒ String (readonly)

The name of the dataset group.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'forecast/cfn_dataset_group_props.rb', line 28

def dataset_group_name
  @dataset_group_name
end

#domain ⇒ String (readonly)

The domain associated with the dataset group.

When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType , Amazon Forecast requires that item_id , timestamp , and demand fields are present in your data. For more information, see Dataset groups .

Returns:

  • (String)

See Also:



37
38
39
 
# File 'forecast/cfn_dataset_group_props.rb', line 37

def domain
  @domain
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

For more information, see Tag .

Returns:

See Also:



49
50
51
 
# File 'forecast/cfn_dataset_group_props.rb', line 49

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'forecast/cfn_dataset_group_props.rb', line 51

def self.jsii_properties
  {
    :dataset_group_name => "datasetGroupName",
    :domain => "domain",
    :dataset_arns => "datasetArns",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'forecast/cfn_dataset_group_props.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "datasetGroupName" => @dataset_group_name,
    "domain" => @domain,
    "datasetArns" => @dataset_arns,
    "tags" => @tags,
  })
  result.compact
end