Class: AWSCDK::Connect::CfnContactFlowProps

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

Overview

Properties for defining a CfnContactFlow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content:, instance_arn:, name:, type:, description: nil, state: nil, tags: nil) ⇒ CfnContactFlowProps

Returns a new instance of CfnContactFlowProps.

Parameters:

  • content (String)

    The content of the flow.

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

    The Amazon Resource Name (ARN) of the Connect Customer instance.

  • name (String)

    The name of the flow.

  • type (String)

    The type of the flow.

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

    The description of the flow.

  • state (String, nil) (defaults to: nil)

    The state of the flow.

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

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



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'connect/cfn_contact_flow_props.rb', line 16

def initialize(content:, instance_arn:, name:, type:, description: nil, state: nil, tags: nil)
  @content = content
  Jsii::Type.check_type(@content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "content")
  @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")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @state = state
  Jsii::Type.check_type(@state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "state") unless @state.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

#contentString (readonly)

The content of the flow.

For more information, see Connect Customer Flow language in the Connect Customer Administrator Guide .



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

def content
  @content
end

#descriptionString? (readonly)

The description of the flow.



61
62
63
# File 'connect/cfn_contact_flow_props.rb', line 61

def description
  @description
end

#instance_arnString, AWSCDK::Interfaces::AWSConnect::IInstanceRef (readonly)

The Amazon Resource Name (ARN) of the Connect Customer instance.



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

def instance_arn
  @instance_arn
end

#nameString (readonly)

The name of the flow.



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

def name
  @name
end

#stateString? (readonly)

The state of the flow.



66
67
68
# File 'connect/cfn_contact_flow_props.rb', line 66

def state
  @state
end

#tagsArray<AWSCDK::CfnTag>? (readonly)

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

For more information, see Tag .



73
74
75
# File 'connect/cfn_contact_flow_props.rb', line 73

def tags
  @tags
end

#typeString (readonly)

The type of the flow.

For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide .



56
57
58
# File 'connect/cfn_contact_flow_props.rb', line 56

def type
  @type
end

Class Method Details

.jsii_propertiesObject



75
76
77
78
79
80
81
82
83
84
85
# File 'connect/cfn_contact_flow_props.rb', line 75

def self.jsii_properties
  {
    :content => "content",
    :instance_arn => "instanceArn",
    :name => "name",
    :type => "type",
    :description => "description",
    :state => "state",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsiiObject



87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'connect/cfn_contact_flow_props.rb', line 87

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