Class: AWSCDK::Cases::CfnTemplateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cases/cfn_template_props.rb

Overview

Properties for defining a CfnTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, description: nil, domain_id: nil, layout_configuration: nil, required_fields: nil, rules: nil, status: nil, tags: nil) ⇒ CfnTemplateProps

Returns a new instance of CfnTemplateProps.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'cases/cfn_template_props.rb', line 17

def initialize(name:, description: nil, domain_id: nil, layout_configuration: nil, required_fields: nil, rules: nil, status: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @domain_id = domain_id
  Jsii::Type.check_type(@domain_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainId") unless @domain_id.nil?
  @layout_configuration = layout_configuration.is_a?(Hash) ? ::AWSCDK::Cases::CfnTemplate::LayoutConfigurationProperty.new(**layout_configuration.transform_keys(&:to_sym)) : layout_configuration
  Jsii::Type.check_type(@layout_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jYXNlcy5DZm5UZW1wbGF0ZS5MYXlvdXRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "layoutConfiguration") unless @layout_configuration.nil?
  @required_fields = required_fields
  Jsii::Type.check_type(@required_fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2FzZXMuQ2ZuVGVtcGxhdGUuUmVxdWlyZWRGaWVsZFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "requiredFields") unless @required_fields.nil?
  @rules = rules
  Jsii::Type.check_type(@rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2FzZXMuQ2ZuVGVtcGxhdGUuVGVtcGxhdGVSdWxlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "rules") unless @rules.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.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)

A brief description of the template.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'cases/cfn_template_props.rb', line 45

def description
  @description
end

#domain_id ⇒ String? (readonly)

The unique identifier of the Cases domain.

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'cases/cfn_template_props.rb', line 50

def domain_id
  @domain_id
end

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

Object to store configuration of layouts associated to the template.

Returns:

See Also:



55
56
57
 
# File 'cases/cfn_template_props.rb', line 55

def layout_configuration
  @layout_configuration
end

#name ⇒ String (readonly)

The template name.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'cases/cfn_template_props.rb', line 40

def name
  @name
end

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

A list of fields that must contain a value for a case to be successfully created with this template.

Returns:

See Also:



60
61
62
 
# File 'cases/cfn_template_props.rb', line 60

def required_fields
  @required_fields
end

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

A list of case rules (also known as case field conditions ) on a template.

Returns:

See Also:



65
66
67
 
# File 'cases/cfn_template_props.rb', line 65

def rules
  @rules
end

#status ⇒ String? (readonly)

The status of the template.

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'cases/cfn_template_props.rb', line 70

def status
  @status
end

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

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

Returns:

See Also:



75
76
77
 
# File 'cases/cfn_template_props.rb', line 75

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'cases/cfn_template_props.rb', line 77

def self.jsii_properties
  {
    :name => "name",
    :description => "description",
    :domain_id => "domainId",
    :layout_configuration => "layoutConfiguration",
    :required_fields => "requiredFields",
    :rules => "rules",
    :status => "status",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'cases/cfn_template_props.rb', line 90

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "description" => @description,
    "domainId" => @domain_id,
    "layoutConfiguration" => @layout_configuration,
    "requiredFields" => @required_fields,
    "rules" => @rules,
    "status" => @status,
    "tags" => @tags,
  })
  result.compact
end