Class: AWSCDK::CustomerProfiles::CfnRecommenderProps

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

Overview

Properties for defining a CfnRecommender.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, recommender_name:, recommender_recipe_name:, description: nil, recommender_config: nil, tags: nil) ⇒ CfnRecommenderProps

Returns a new instance of CfnRecommenderProps.

Parameters:

  • domain_name (String) —

    The name of the domain for which the recommender will be created.

  • recommender_name (String) —

    The name of the recommender.

  • recommender_recipe_name (String) —

    The name of the recommender recipe.

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

    The description of the recommender.

  • recommender_config (AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnRecommender::RecommenderConfigProperty, nil) (defaults to: nil) —

    Configuration for the recommender.

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

    The tags used to organize, track, or control access for this resource.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'customer_profiles/cfn_recommender_props.rb', line 15

def initialize(domain_name:, recommender_name:, recommender_recipe_name:, description: nil, recommender_config: nil, tags: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @recommender_name = recommender_name
  Jsii::Type.check_type(@recommender_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "recommenderName")
  @recommender_recipe_name = recommender_recipe_name
  Jsii::Type.check_type(@recommender_recipe_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "recommenderRecipeName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @recommender_config = recommender_config.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnRecommender::RecommenderConfigProperty.new(**recommender_config.transform_keys(&:to_sym)) : recommender_config
  Jsii::Type.check_type(@recommender_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmblJlY29tbWVuZGVyLlJlY29tbWVuZGVyQ29uZmlnUHJvcGVydHkifV19fQ==")), "recommenderConfig") unless @recommender_config.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

#description ⇒ String? (readonly)

The description of the recommender.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'customer_profiles/cfn_recommender_props.rb', line 49

def description
  @description
end

#domain_name ⇒ String (readonly)

The name of the domain for which the recommender will be created.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'customer_profiles/cfn_recommender_props.rb', line 34

def domain_name
  @domain_name
end

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

Configuration for the recommender.

Returns:

See Also:



54
55
56
 
# File 'customer_profiles/cfn_recommender_props.rb', line 54

def recommender_config
  @recommender_config
end

#recommender_name ⇒ String (readonly)

The name of the recommender.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'customer_profiles/cfn_recommender_props.rb', line 39

def recommender_name
  @recommender_name
end

#recommender_recipe_name ⇒ String (readonly)

The name of the recommender recipe.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'customer_profiles/cfn_recommender_props.rb', line 44

def recommender_recipe_name
  @recommender_recipe_name
end

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

The tags used to organize, track, or control access for this resource.

Returns:

See Also:



59
60
61
 
# File 'customer_profiles/cfn_recommender_props.rb', line 59

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'customer_profiles/cfn_recommender_props.rb', line 61

def self.jsii_properties
  {
    :domain_name => "domainName",
    :recommender_name => "recommenderName",
    :recommender_recipe_name => "recommenderRecipeName",
    :description => "description",
    :recommender_config => "recommenderConfig",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'customer_profiles/cfn_recommender_props.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "recommenderName" => @recommender_name,
    "recommenderRecipeName" => @recommender_recipe_name,
    "description" => @description,
    "recommenderConfig" => @recommender_config,
    "tags" => @tags,
  })
  result.compact
end