Class: AWSCDK::Connect::CfnPromptProps

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

Overview

Properties for defining a CfnPrompt.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_arn:, name:, description: nil, s3_uri: nil, tags: nil) ⇒ CfnPromptProps

Returns a new instance of CfnPromptProps.

Parameters:

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

    The identifier of the Connect Customer instance.

  • name (String) —

    The name of the prompt.

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

    The description of the prompt.

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

    The URI for the S3 bucket where the prompt is stored.

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

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



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

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

#description ⇒ String? (readonly)

The description of the prompt.

Returns:

  • (String, nil)

See Also:



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

def description
  @description
end

#instance_arn ⇒ String, AWSCDK::Interfaces::AWSConnect::IInstanceRef (readonly)

The identifier of the Connect Customer instance.

Returns:

See Also:



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

def instance_arn
  @instance_arn
end

#name ⇒ String (readonly)

The name of the prompt.

Returns:

  • (String)

See Also:



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

def name
  @name
end

#s3_uri ⇒ String? (readonly)

The URI for the S3 bucket where the prompt is stored.

This property is required when you create a prompt.

Returns:

  • (String, nil)

See Also:



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

def s3_uri
  @s3_uri
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:



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

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'connect/cfn_prompt_props.rb', line 57

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :name => "name",
    :description => "description",
    :s3_uri => "s3Uri",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'connect/cfn_prompt_props.rb', line 67

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