Class: Aws::ConnectCases::Types::CreateTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::ConnectCases::Types::CreateTemplateRequest

Defined in:

gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A brief description of the template.

• #domain_id ⇒ String

  The unique identifier of the Cases domain.

• #layout_configuration ⇒ Types::LayoutConfiguration

  Configuration of layouts associated to the template.

• #name ⇒ String

  A name for the template.

• #required_fields ⇒ Array<Types::RequiredField>

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

• #rules ⇒ Array<Types::TemplateRule>

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

• #status ⇒ String

  The status of the template.

• #tag_propagation_configurations ⇒ Array<Types::TagPropagationConfiguration>

  Defines tag propagation configuration for resources created within a domain.

Instance Attribute Details

#description ⇒ String

A brief description of the template.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#domain_id ⇒ String

The unique identifier of the Cases domain.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#layout_configuration ⇒ Types::LayoutConfiguration

Configuration of layouts associated to the template.

Returns:

• (Types::LayoutConfiguration)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the template. It must be unique per domain.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#required_fields ⇒ Array<Types::RequiredField>

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

To require a Customer Profile when creating cases, include customer_id in this list. If customer_id is omitted, the Customer Profile field is optional and can be added, changed, or removed after case creation.

Returns:

• (Array<Types::RequiredField>)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#rules ⇒ Array<Types::TemplateRule>

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

Returns:

• (Array<Types::TemplateRule>)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the template.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#tag_propagation_configurations ⇒ Array<Types::TagPropagationConfiguration>

Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.

Returns:

• (Array<Types::TagPropagationConfiguration>)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1473

class CreateTemplateRequest < Struct.new(
  :domain_id,
  :name,
  :description,
  :layout_configuration,
  :required_fields,
  :status,
  :rules,
  :tag_propagation_configurations)
  SENSITIVE = []
  include Aws::Structure
end