Class: AWSCDK::Connect::CfnAgentStatusProps

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

Overview

Properties for defining a CfnAgentStatus.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_arn:, name:, state:, description: nil, display_order: nil, reset_order_number: nil, tags: nil, type: nil) ⇒ CfnAgentStatusProps

Returns a new instance of CfnAgentStatusProps.

Parameters:

  • instance_arn (String) —

    The Amazon Resource Name (ARN) of the instance.

  • name (String) —

    The name of the agent status.

  • state (String) —

    The state of the agent status.

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

    The description of the agent status.

  • display_order (Numeric, nil) (defaults to: nil) —

    The display order of the agent status.

  • reset_order_number (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A number indicating the reset order of the agent status.

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

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

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

    The type of agent status.



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

def initialize(instance_arn:, name:, state:, description: nil, display_order: nil, reset_order_number: nil, tags: nil, type: nil)
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @state = state
  Jsii::Type.check_type(@state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "state")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @display_order = display_order
  Jsii::Type.check_type(@display_order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "displayOrder") unless @display_order.nil?
  @reset_order_number = reset_order_number
  Jsii::Type.check_type(@reset_order_number, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "resetOrderNumber") unless @reset_order_number.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?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the agent status.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'connect/cfn_agent_status_props.rb', line 55

def description
  @description
end

#display_order ⇒ Numeric? (readonly)

The display order of the agent status.

Returns:

  • (Numeric, nil)

See Also:



60
61
62
 
# File 'connect/cfn_agent_status_props.rb', line 60

def display_order
  @display_order
end

#instance_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'connect/cfn_agent_status_props.rb', line 40

def instance_arn
  @instance_arn
end

#name ⇒ String (readonly)

The name of the agent status.

Returns:

  • (String)

See Also:



45
46
47
 
# File 'connect/cfn_agent_status_props.rb', line 45

def name
  @name
end

#reset_order_number ⇒ Boolean, ... (readonly)

A number indicating the reset order of the agent status.

Returns:

See Also:



65
66
67
 
# File 'connect/cfn_agent_status_props.rb', line 65

def reset_order_number
  @reset_order_number
end

#state ⇒ String (readonly)

The state of the agent status.

Returns:

  • (String)

See Also:



50
51
52
 
# File 'connect/cfn_agent_status_props.rb', line 50

def state
  @state
end

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

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

For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



72
73
74
 
# File 'connect/cfn_agent_status_props.rb', line 72

def tags
  @tags
end

#type ⇒ String? (readonly)

The type of agent status.

Returns:

  • (String, nil)

See Also:



77
78
79
 
# File 'connect/cfn_agent_status_props.rb', line 77

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'connect/cfn_agent_status_props.rb', line 79

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :name => "name",
    :state => "state",
    :description => "description",
    :display_order => "displayOrder",
    :reset_order_number => "resetOrderNumber",
    :tags => "tags",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'connect/cfn_agent_status_props.rb', line 92

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