Class: AWSCDK::ConnectCampaignsv2::CfnCampaign

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSConnectcampaignsv2::ICampaignRef
Defined in:
connect_campaignsv2/cfn_campaign.rb

Overview

Creates an outbound campaign.

  • For users to be able to view or edit a campaign at a later date by using the Amazon Connect user interface, you must add the instance ID as a tag. For example, { "tags": {"owner": "arn:aws:connect:{REGION}:{AWS_ACCOUNT_ID}:instance/{CONNECT_INSTANCE_ID}"}} .
  • After a campaign is created, you can't add/remove source.
  • Configuring maximum ring time is not supported for the Preview dial mode.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCampaign

Create a new AWS::ConnectCampaignsV2::Campaign.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::ConnectCampaignsv2::CfnCampaignProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaignProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdGNhbXBhaWduc3YyLkNmbkNhbXBhaWduUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_campaign(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_campaign(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuSUNhbXBhaWduUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_connectcampaignsv2.CfnCampaign", "arnForCampaign", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


193
194
195
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 193

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_connectcampaignsv2.CfnCampaign", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_campaign(x) ⇒ Boolean

Checks whether the given object is a CfnCampaign.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 95

def self.is_cfn_campaign(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_connectcampaignsv2.CfnCampaign", "isCfnCampaign", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :campaign_ref => { kind: :property, name: "campaignRef", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :connect_instance_id => { kind: :property, name: "connectInstanceId", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :channel_subtype_config => { kind: :property, name: "channelSubtypeConfig", is_optional: true },
    :communication_limits_override => { kind: :property, name: "communicationLimitsOverride", is_optional: true },
    :communication_time_config => { kind: :property, name: "communicationTimeConfig", is_optional: true },
    :connect_campaign_flow_arn => { kind: :property, name: "connectCampaignFlowArn", is_optional: true },
    :entry_limits_config => { kind: :property, name: "entryLimitsConfig", is_optional: true },
    :schedule => { kind: :property, name: "schedule", is_optional: true },
    :source => { kind: :property, name: "source", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



393
394
395
396
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 393

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



405
406
407
408
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 405

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



415
416
417
418
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 415

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



426
427
428
429
430
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 426

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


483
484
485
486
487
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 483

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



493
494
495
496
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 493

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



505
506
507
508
509
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 505

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



518
519
520
521
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 518

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



540
541
542
543
544
545
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 540

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN).

Returns:

  • (String) 


200
201
202
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 200

def attr_arn()
  jsii_get_property("attrArn")
end

#campaign_ref ⇒ AWSCDK::Interfaces::AWSConnectcampaignsv2::CampaignReference

A reference to a Campaign resource.

Returns:



207
208
209
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 207

def campaign_ref()
  jsii_get_property("campaignRef")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



214
215
216
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 214

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



146
147
148
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 146

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


549
550
551
552
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 549

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


156
157
158
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#channel_subtype_config ⇒ AWSCDK::IResolvable, ...

Contains channel subtype configuration for an outbound campaign.

Returns:



245
246
247
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 245

def channel_subtype_config()
  jsii_get_property("channelSubtypeConfig")
end

#channel_subtype_config=(value) ⇒ Object 



249
250
251
252
253
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 249

def channel_subtype_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::ChannelSubtypeConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uQ2hhbm5lbFN1YnR5cGVDb25maWdQcm9wZXJ0eSJ9XX19")), "channelSubtypeConfig") unless value.nil?
  jsii_set_property("channelSubtypeConfig", value)
end

#communication_limits_override ⇒ AWSCDK::IResolvable, ...

Communication limits configuration for an outbound campaign.

Returns:



258
259
260
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 258

def communication_limits_override()
  jsii_get_property("communicationLimitsOverride")
end

#communication_limits_override=(value) ⇒ Object 



262
263
264
265
266
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 262

def communication_limits_override=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::CommunicationLimitsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uQ29tbXVuaWNhdGlvbkxpbWl0c0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "communicationLimitsOverride") unless value.nil?
  jsii_set_property("communicationLimitsOverride", value)
end

#communication_time_config ⇒ AWSCDK::IResolvable, ...

Contains communication time configuration for an outbound campaign.

Returns:



271
272
273
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 271

def communication_time_config()
  jsii_get_property("communicationTimeConfig")
end

#communication_time_config=(value) ⇒ Object 



275
276
277
278
279
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 275

def communication_time_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::CommunicationTimeConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uQ29tbXVuaWNhdGlvblRpbWVDb25maWdQcm9wZXJ0eSJ9XX19")), "communicationTimeConfig") unless value.nil?
  jsii_set_property("communicationTimeConfig", value)
end

#connect_campaign_flow_arn ⇒ String?

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

Returns:

  • (String, nil) 


284
285
286
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 284

def connect_campaign_flow_arn()
  jsii_get_property("connectCampaignFlowArn")
end

#connect_campaign_flow_arn=(value) ⇒ Object 



288
289
290
291
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 288

def connect_campaign_flow_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectCampaignFlowArn") unless value.nil?
  jsii_set_property("connectCampaignFlowArn", value)
end

#connect_instance_id ⇒ String

The identifier of the Amazon Connect instance.

Returns:

  • (String) 


221
222
223
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 221

def connect_instance_id()
  jsii_get_property("connectInstanceId")
end

#connect_instance_id=(value) ⇒ Object 



225
226
227
228
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 225

def connect_instance_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectInstanceId")
  jsii_set_property("connectInstanceId", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#entry_limits_config ⇒ AWSCDK::IResolvable, ...

Entry limits config for a campaign.

Returns:



296
297
298
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 296

def entry_limits_config()
  jsii_get_property("entryLimitsConfig")
end

#entry_limits_config=(value) ⇒ Object 



300
301
302
303
304
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 300

def entry_limits_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::EntryLimitsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uRW50cnlMaW1pdHNDb25maWdQcm9wZXJ0eSJ9XX19")), "entryLimitsConfig") unless value.nil?
  jsii_set_property("entryLimitsConfig", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 168

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



562
563
564
565
566
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 562

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



573
574
575
576
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 573

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



643
644
645
646
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 643

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


120
121
122
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the outbound campaign.

Returns:

  • (String) 


233
234
235
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 233

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



237
238
239
240
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 237

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



584
585
586
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 584

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



591
592
593
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 591

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



384
385
386
387
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 384

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


139
140
141
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 139

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



602
603
604
605
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 602

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


609
610
611
612
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 609

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



619
620
621
622
623
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 619

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#schedule ⇒ AWSCDK::IResolvable, ...

Contains the schedule configuration.

Returns:



309
310
311
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 309

def schedule()
  jsii_get_property("schedule")
end

#schedule=(value) ⇒ Object 



313
314
315
316
317
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 313

def schedule=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::ScheduleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uU2NoZWR1bGVQcm9wZXJ0eSJ9XX19")), "schedule") unless value.nil?
  jsii_set_property("schedule", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



628
629
630
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 628

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source ⇒ AWSCDK::IResolvable, ...

Contains source configuration.

Returns:



322
323
324
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 322

def source()
  jsii_get_property("source")
end

#source=(value) ⇒ Object 



326
327
328
329
330
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 326

def source=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ConnectCampaignsv2::CfnCampaign::SourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0Y2FtcGFpZ25zdjIuQ2ZuQ2FtcGFpZ24uU291cmNlUHJvcGVydHkifV19fQ==")), "source") unless value.nil?
  jsii_set_property("source", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



129
130
131
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 129

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



335
336
337
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 335

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



339
340
341
342
343
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 339

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



360
361
362
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 360

def to_string()
  jsii_call_method("toString", [])
end

#type ⇒ String?

The type of campaign.

Returns:

  • (String, nil) 


348
349
350
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 348

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



352
353
354
355
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 352

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 176

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


634
635
636
637
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 634

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


373
374
375
376
377
378
 
# File 'connect_campaignsv2/cfn_campaign.rb', line 373

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end