Class: AWSCDK::ConnectCampaignsv2::CfnCampaignProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect_campaignsv2/cfn_campaign_props.rb

Overview

Properties for defining a CfnCampaign.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connect_instance_id:, name:, channel_subtype_config: nil, communication_limits_override: nil, communication_time_config: nil, connect_campaign_flow_arn: nil, entry_limits_config: nil, schedule: nil, source: nil, tags: nil, type: nil) ⇒ CfnCampaignProps

Returns a new instance of CfnCampaignProps.

Parameters:



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_campaignsv2/cfn_campaign_props.rb', line 20

def initialize(connect_instance_id:, name:, channel_subtype_config: nil, communication_limits_override: nil, communication_time_config: nil, connect_campaign_flow_arn: nil, entry_limits_config: nil, schedule: nil, source: nil, tags: nil, type: nil)
  @connect_instance_id = connect_instance_id
  Jsii::Type.check_type(@connect_instance_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectInstanceId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @channel_subtype_config = channel_subtype_config.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::ChannelSubtypeConfigProperty.new(**channel_subtype_config.transform_keys(&:to_sym)) : channel_subtype_config
  Jsii::Type.check_type(@channel_subtype_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uQ2hhbm5lbFN1YnR5cGVDb25maWdQcm9wZXJ0eSJ9XX19")), "channelSubtypeConfig") unless @channel_subtype_config.nil?
  @communication_limits_override = communication_limits_override.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::CommunicationLimitsConfigProperty.new(**communication_limits_override.transform_keys(&:to_sym)) : communication_limits_override
  Jsii::Type.check_type(@communication_limits_override, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uQ29tbXVuaWNhdGlvbkxpbWl0c0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "communicationLimitsOverride") unless @communication_limits_override.nil?
  @communication_time_config = communication_time_config.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::CommunicationTimeConfigProperty.new(**communication_time_config.transform_keys(&:to_sym)) : communication_time_config
  Jsii::Type.check_type(@communication_time_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uQ29tbXVuaWNhdGlvblRpbWVDb25maWdQcm9wZXJ0eSJ9XX19")), "communicationTimeConfig") unless @communication_time_config.nil?
  @connect_campaign_flow_arn = connect_campaign_flow_arn
  Jsii::Type.check_type(@connect_campaign_flow_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectCampaignFlowArn") unless @connect_campaign_flow_arn.nil?
  @entry_limits_config = entry_limits_config.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::EntryLimitsConfigProperty.new(**entry_limits_config.transform_keys(&:to_sym)) : entry_limits_config
  Jsii::Type.check_type(@entry_limits_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uRW50cnlMaW1pdHNDb25maWdQcm9wZXJ0eSJ9XX19")), "entryLimitsConfig") unless @entry_limits_config.nil?
  @schedule = schedule.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::ScheduleProperty.new(**schedule.transform_keys(&:to_sym)) : schedule
  Jsii::Type.check_type(@schedule, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uU2NoZWR1bGVQcm9wZXJ0eSJ9XX19")), "schedule") unless @schedule.nil?
  @source = source.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::SourceProperty.new(**source.transform_keys(&:to_sym)) : source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uU291cmNlUHJvcGVydHkifV19fQ==")), "source") unless @source.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

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

Contains channel subtype configuration for an outbound campaign.

Returns:

See Also:



61
62
63
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 61

def channel_subtype_config
  @channel_subtype_config
end

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

Communication limits configuration for an outbound campaign.

Returns:

See Also:



66
67
68
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 66

def communication_limits_override
  @communication_limits_override
end

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

Contains communication time configuration for an outbound campaign.

Returns:

See Also:



71
72
73
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 71

def communication_time_config
  @communication_time_config
end

#connect_campaign_flow_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.

Returns:

  • (String, nil)

See Also:



76
77
78
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 76

def connect_campaign_flow_arn
  @connect_campaign_flow_arn
end

#connect_instance_id ⇒ String (readonly)

The identifier of the Amazon Connect instance.

You can find the instance_id in the ARN of the instance.

Returns:

  • (String)

See Also:



51
52
53
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 51

def connect_instance_id
  @connect_instance_id
end

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

Entry limits config for a campaign.

Returns:

See Also:



81
82
83
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 81

def entry_limits_config
  @entry_limits_config
end

#name ⇒ String (readonly)

The name of the outbound campaign.

Returns:

  • (String)

See Also:



56
57
58
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 56

def name
  @name
end

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

Contains the schedule configuration.

Returns:

See Also:



86
87
88
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 86

def schedule
  @schedule
end

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

Contains source configuration.

Returns:

See Also:



91
92
93
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 91

def source
  @source
end

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

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

For example, { "tags": {"key1":"value1", "key2":"value2"} } .

Returns:

See Also:



98
99
100
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 98

def tags
  @tags
end

#type ⇒ String? (readonly)

The type of campaign.

Returns:

  • (String, nil)

See Also:



103
104
105
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 103

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 105

def self.jsii_properties
  {
    :connect_instance_id => "connectInstanceId",
    :name => "name",
    :channel_subtype_config => "channelSubtypeConfig",
    :communication_limits_override => "communicationLimitsOverride",
    :communication_time_config => "communicationTimeConfig",
    :connect_campaign_flow_arn => "connectCampaignFlowArn",
    :entry_limits_config => "entryLimitsConfig",
    :schedule => "schedule",
    :source => "source",
    :tags => "tags",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'connect_campaignsv2/cfn_campaign_props.rb', line 121

def to_jsii
  result = {}
  result.merge!({
    "connectInstanceId" => @connect_instance_id,
    "name" => @name,
    "channelSubtypeConfig" => @channel_subtype_config,
    "communicationLimitsOverride" => @communication_limits_override,
    "communicationTimeConfig" => @communication_time_config,
    "connectCampaignFlowArn" => @connect_campaign_flow_arn,
    "entryLimitsConfig" => @entry_limits_config,
    "schedule" => @schedule,
    "source" => @source,
    "tags" => @tags,
    "type" => @type,
  })
  result.compact
end