Class: AWSCDK::Connect::CfnTaskTemplateProps

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

Overview

Properties for defining a CfnTaskTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_arn:, client_token: nil, constraints: nil, contact_flow_arn: nil, defaults: nil, description: nil, fields: nil, name: nil, self_assign_contact_flow_arn: nil, status: nil, tags: nil) ⇒ CfnTaskTemplateProps

Returns a new instance of CfnTaskTemplateProps.

Parameters:

  • instance_arn (String) —

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

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • constraints (Object, nil) (defaults to: nil) —

    Constraints that are applicable to the fields listed.

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

    The Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template.

  • defaults (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Connect::CfnTaskTemplate::DefaultFieldValueProperty>, nil) (defaults to: nil) —

    The default values for fields when a task is created by referencing this template.

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

    The description of the task template.

  • fields (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Connect::CfnTaskTemplate::FieldProperty>, nil) (defaults to: nil) —

    Fields that are part of the template.

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

    The name of the task template.

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

    The Amazon Resource Name (ARN) of the flow.

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

    The status of the task template.

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

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



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'connect/cfn_task_template_props.rb', line 20

def initialize(instance_arn:, client_token: nil, constraints: nil, contact_flow_arn: nil, defaults: nil, description: nil, fields: nil, name: nil, self_assign_contact_flow_arn: nil, status: nil, tags: nil)
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  @client_token = client_token
  Jsii::Type.check_type(@client_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientToken") unless @client_token.nil?
  @constraints = constraints
  Jsii::Type.check_type(@constraints, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "constraints") unless @constraints.nil?
  @contact_flow_arn = contact_flow_arn
  Jsii::Type.check_type(@contact_flow_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contactFlowArn") unless @contact_flow_arn.nil?
  @defaults = defaults
  Jsii::Type.check_type(@defaults, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5UYXNrVGVtcGxhdGUuRGVmYXVsdEZpZWxkVmFsdWVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "defaults") unless @defaults.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @fields = fields
  Jsii::Type.check_type(@fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5UYXNrVGVtcGxhdGUuRmllbGRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "fields") unless @fields.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @self_assign_contact_flow_arn = self_assign_contact_flow_arn
  Jsii::Type.check_type(@self_assign_contact_flow_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selfAssignContactFlowArn") unless @self_assign_contact_flow_arn.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

#client_token ⇒ String? (readonly)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

  • (String, nil)

See Also:



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

def client_token
  @client_token
end

#constraints ⇒ Object? (readonly)

Constraints that are applicable to the fields listed.

The values can be represented in either JSON or YAML format. For an example of the JSON configuration, see Examples at the bottom of this page.

Returns:

  • (Object, nil)

See Also:



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

def constraints
  @constraints
end

#contact_flow_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template.

ContactFlowArn is not required when there is a field with field_type = QUICK_CONNECT .

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'connect/cfn_task_template_props.rb', line 68

def contact_flow_arn
  @contact_flow_arn
end

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

The default values for fields when a task is created by referencing this template.

Returns:

See Also:



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

def defaults
  @defaults
end

#description ⇒ String? (readonly)

The description of the task template.

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'connect/cfn_task_template_props.rb', line 78

def description
  @description
end

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

Fields that are part of the template.

A template requires at least one field that has type Name .

Returns:

See Also:



85
86
87
 
# File 'connect/cfn_task_template_props.rb', line 85

def fields
  @fields
end

#instance_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



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

def instance_arn
  @instance_arn
end

#name ⇒ String? (readonly)

The name of the task template.

Returns:

  • (String, nil)

See Also:



90
91
92
 
# File 'connect/cfn_task_template_props.rb', line 90

def name
  @name
end

#self_assign_contact_flow_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the flow.

Returns:

  • (String, nil)

See Also:



95
96
97
 
# File 'connect/cfn_task_template_props.rb', line 95

def self_assign_contact_flow_arn
  @self_assign_contact_flow_arn
end

#status ⇒ String? (readonly)

The status of the task template.

Returns:

  • (String, nil)

See Also:



100
101
102
 
# File 'connect/cfn_task_template_props.rb', line 100

def status
  @status
end

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

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

Returns:

See Also:



105
106
107
 
# File 'connect/cfn_task_template_props.rb', line 105

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'connect/cfn_task_template_props.rb', line 107

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :client_token => "clientToken",
    :constraints => "constraints",
    :contact_flow_arn => "contactFlowArn",
    :defaults => "defaults",
    :description => "description",
    :fields => "fields",
    :name => "name",
    :self_assign_contact_flow_arn => "selfAssignContactFlowArn",
    :status => "status",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'connect/cfn_task_template_props.rb', line 123

def to_jsii
  result = {}
  result.merge!({
    "instanceArn" => @instance_arn,
    "clientToken" => @client_token,
    "constraints" => @constraints,
    "contactFlowArn" => @contact_flow_arn,
    "defaults" => @defaults,
    "description" => @description,
    "fields" => @fields,
    "name" => @name,
    "selfAssignContactFlowArn" => @self_assign_contact_flow_arn,
    "status" => @status,
    "tags" => @tags,
  })
  result.compact
end