Class: AWSCDK::Connect::CfnPredefinedAttributeProps

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

Overview

Properties for defining a CfnPredefinedAttribute.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_arn:, name:, attribute_configuration: nil, purposes: nil, values: nil) ⇒ CfnPredefinedAttributeProps

Returns a new instance of CfnPredefinedAttributeProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'connect/cfn_predefined_attribute_props.rb', line 14

def initialize(instance_arn:, name:, attribute_configuration: nil, purposes: nil, values: 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")
  @attribute_configuration = attribute_configuration.is_a?(Hash) ? ::AWSCDK::Connect::CfnPredefinedAttribute::AttributeConfigurationProperty.new(**attribute_configuration.transform_keys(&:to_sym)) : attribute_configuration
  Jsii::Type.check_type(@attribute_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmblByZWRlZmluZWRBdHRyaWJ1dGUuQXR0cmlidXRlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "attributeConfiguration") unless @attribute_configuration.nil?
  @purposes = purposes
  Jsii::Type.check_type(@purposes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "purposes") unless @purposes.nil?
  @values = values.is_a?(Hash) ? ::AWSCDK::Connect::CfnPredefinedAttribute::ValuesProperty.new(**values.transform_keys(&:to_sym)) : values
  Jsii::Type.check_type(@values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmblByZWRlZmluZWRBdHRyaWJ1dGUuVmFsdWVzUHJvcGVydHkifV19fQ==")), "values") unless @values.nil?
end

Instance Attribute Details

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

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

Returns:

See Also:



41
42
43
 
# File 'connect/cfn_predefined_attribute_props.rb', line 41

def attribute_configuration
  @attribute_configuration
end

#instance_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'connect/cfn_predefined_attribute_props.rb', line 31

def instance_arn
  @instance_arn
end

#name ⇒ String (readonly)

The name of the predefined attribute.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'connect/cfn_predefined_attribute_props.rb', line 36

def name
  @name
end

#purposes ⇒ Array<String>? (readonly)

Values that enable you to categorize your predefined attributes.

You can use them in custom UI elements across the Amazon Connect admin website.

Returns:

  • (Array<String>, nil)

See Also:



48
49
50
 
# File 'connect/cfn_predefined_attribute_props.rb', line 48

def purposes
  @purposes
end

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

The values of a predefined attribute.

Returns:

See Also:



53
54
55
 
# File 'connect/cfn_predefined_attribute_props.rb', line 53

def values
  @values
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'connect/cfn_predefined_attribute_props.rb', line 55

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :name => "name",
    :attribute_configuration => "attributeConfiguration",
    :purposes => "purposes",
    :values => "values",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'connect/cfn_predefined_attribute_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "instanceArn" => @instance_arn,
    "name" => @name,
    "attributeConfiguration" => @attribute_configuration,
    "purposes" => @purposes,
    "values" => @values,
  })
  result.compact
end