Class: AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinitionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
customer_profiles/cfn_calculated_attribute_definition_props.rb

Overview

Properties for defining a CfnCalculatedAttributeDefinition.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attribute_details:, calculated_attribute_name:, domain_name:, statistic:, conditions: nil, description: nil, display_name: nil, tags: nil, use_historical_data: nil) ⇒ CfnCalculatedAttributeDefinitionProps

Returns a new instance of CfnCalculatedAttributeDefinitionProps.

Parameters:

  • attribute_details (AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::AttributeDetailsProperty) —

    Mathematical expression and a list of attribute items specified in that expression.

  • calculated_attribute_name (String) —

    The name of an attribute defined in a profile object type.

  • domain_name (String) —

    The unique name of the domain.

  • statistic (String) —

    The aggregation operation to perform for the calculated attribute.

  • conditions (AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::ConditionsProperty, nil) (defaults to: nil) —

    The conditions including range, object count, and threshold for the calculated attribute.

  • description (String, nil) (defaults to: nil) —

    The description of the calculated attribute.

  • display_name (String, nil) (defaults to: nil) —

    The display name of the calculated attribute.

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

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

  • use_historical_data (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether historical data ingested before the Calculated Attribute was created should be included in calculations.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 18

def initialize(attribute_details:, calculated_attribute_name:, domain_name:, statistic:, conditions: nil, description: nil, display_name: nil, tags: nil, use_historical_data: nil)
  @attribute_details = attribute_details.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::AttributeDetailsProperty.new(**attribute_details.transform_keys(&:to_sym)) : attribute_details
  Jsii::Type.check_type(@attribute_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkNhbGN1bGF0ZWRBdHRyaWJ1dGVEZWZpbml0aW9uLkF0dHJpYnV0ZURldGFpbHNQcm9wZXJ0eSJ9XX19")), "attributeDetails")
  @calculated_attribute_name = calculated_attribute_name
  Jsii::Type.check_type(@calculated_attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "calculatedAttributeName")
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @statistic = statistic
  Jsii::Type.check_type(@statistic, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "statistic")
  @conditions = conditions.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::ConditionsProperty.new(**conditions.transform_keys(&:to_sym)) : conditions
  Jsii::Type.check_type(@conditions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkNhbGN1bGF0ZWRBdHRyaWJ1dGVEZWZpbml0aW9uLkNvbmRpdGlvbnNQcm9wZXJ0eSJ9XX19")), "conditions") unless @conditions.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.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?
  @use_historical_data = use_historical_data
  Jsii::Type.check_type(@use_historical_data, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useHistoricalData") unless @use_historical_data.nil?
end

Instance Attribute Details

#attribute_details ⇒ AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::AttributeDetailsProperty (readonly)

Mathematical expression and a list of attribute items specified in that expression.

Returns:

See Also:



43
44
45
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 43

def attribute_details
  @attribute_details
end

#calculated_attribute_name ⇒ String (readonly)

The name of an attribute defined in a profile object type.

Returns:

  • (String)

See Also:



48
49
50
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 48

def calculated_attribute_name
  @calculated_attribute_name
end

#conditions ⇒ AWSCDK::IResolvable, ... (readonly)

The conditions including range, object count, and threshold for the calculated attribute.

Returns:

See Also:



63
64
65
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 63

def conditions
  @conditions
end

#description ⇒ String? (readonly)

The description of the calculated attribute.

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 68

def description
  @description
end

#display_name ⇒ String? (readonly)

The display name of the calculated attribute.

Returns:

  • (String, nil)

See Also:



73
74
75
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 73

def display_name
  @display_name
end

#domain_name ⇒ String (readonly)

The unique name of the domain.

Returns:

  • (String)

See Also:



53
54
55
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 53

def domain_name
  @domain_name
end

#statistic ⇒ String (readonly)

The aggregation operation to perform for the calculated attribute.

Returns:

  • (String)

See Also:



58
59
60
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 58

def statistic
  @statistic
end

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

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

Returns:

See Also:



78
79
80
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 78

def tags
  @tags
end

#use_historical_data ⇒ Boolean, ... (readonly)

Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

Returns:

See Also:



83
84
85
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 83

def use_historical_data
  @use_historical_data
end

Class Method Details

.jsii_properties ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 85

def self.jsii_properties
  {
    :attribute_details => "attributeDetails",
    :calculated_attribute_name => "calculatedAttributeName",
    :domain_name => "domainName",
    :statistic => "statistic",
    :conditions => "conditions",
    :description => "description",
    :display_name => "displayName",
    :tags => "tags",
    :use_historical_data => "useHistoricalData",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'customer_profiles/cfn_calculated_attribute_definition_props.rb', line 99

def to_jsii
  result = {}
  result.merge!({
    "attributeDetails" => @attribute_details,
    "calculatedAttributeName" => @calculated_attribute_name,
    "domainName" => @domain_name,
    "statistic" => @statistic,
    "conditions" => @conditions,
    "description" => @description,
    "displayName" => @display_name,
    "tags" => @tags,
    "useHistoricalData" => @use_historical_data,
  })
  result.compact
end