Class: AWSCDK::Connect::CfnViewProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_view_props.rb

Overview

Properties for defining a CfnView.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(actions:, instance_arn:, name:, template:, description: nil, tags: nil) ⇒ CfnViewProps

Returns a new instance of CfnViewProps.

Parameters:

  • actions (Array<String>) —

    A list of actions possible from the view.

  • instance_arn (String, AWSCDK::Interfaces::AWSConnect::IInstanceRef) —

    The Amazon Resource Name (ARN) of the instance.

  • name (String) —

    The name of the view.

  • template (Object) —

    The view template representing the structure of the view.

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

    The description of the view.

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

    The tags associated with the view resource (not specific to view version).



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

def initialize(actions:, instance_arn:, name:, template:, description: nil, tags: nil)
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "actions")
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb25uZWN0LklJbnN0YW5jZVJlZiJ9XX19")), "instanceArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @template = template
  Jsii::Type.check_type(@template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "template")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.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

#actions ⇒ Array<String> (readonly)

A list of actions possible from the view.

Returns:

  • (Array<String>)

See Also:



34
35
36
 
# File 'connect/cfn_view_props.rb', line 34

def actions
  @actions
end

#description ⇒ String? (readonly)

The description of the view.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'connect/cfn_view_props.rb', line 54

def description
  @description
end

#instance_arn ⇒ String, AWSCDK::Interfaces::AWSConnect::IInstanceRef (readonly)

The Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



39
40
41
 
# File 'connect/cfn_view_props.rb', line 39

def instance_arn
  @instance_arn
end

#name ⇒ String (readonly)

The name of the view.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'connect/cfn_view_props.rb', line 44

def name
  @name
end

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

The tags associated with the view resource (not specific to view version).

Returns:

See Also:



59
60
61
 
# File 'connect/cfn_view_props.rb', line 59

def tags
  @tags
end

#template ⇒ Object (readonly)

The view template representing the structure of the view.

Returns:

  • (Object)

See Also:



49
50
51
 
# File 'connect/cfn_view_props.rb', line 49

def template
  @template
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :actions => "actions",
    :instance_arn => "instanceArn",
    :name => "name",
    :template => "template",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "actions" => @actions,
    "instanceArn" => @instance_arn,
    "name" => @name,
    "template" => @template,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end