Class: AWSCDK::Pinpoint::CfnCampaign

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSPinpoint::ICampaignRef
Defined in:
pinpoint/cfn_campaign.rb

Overview

Specifies the settings for a campaign.

A campaign is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCampaign

Create a new AWS::Pinpoint::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::Pinpoint::CfnCampaignProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'pinpoint/cfn_campaign.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Pinpoint::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGlucG9pbnQuQ2ZuQ2FtcGFpZ25Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_campaign(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'pinpoint/cfn_campaign.rb', line 92

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


199
200
201
 
# File 'pinpoint/cfn_campaign.rb', line 199

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

.is_cfn_campaign(x) ⇒ Boolean

Checks whether the given object is a CfnCampaign.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


101
102
103
104
 
# File 'pinpoint/cfn_campaign.rb', line 101

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_pinpoint.CfnCampaign", "isCfnCampaign", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
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
83
84
85
86
87
88
 
# File 'pinpoint/cfn_campaign.rb', line 28

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 },
    :attr_campaign_id => { kind: :property, name: "attrCampaignId", is_optional: false },
    :campaign_ref => { kind: :property, name: "campaignRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :application_id => { kind: :property, name: "applicationId", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :schedule => { kind: :property, name: "schedule", is_optional: false },
    :segment_id => { kind: :property, name: "segmentId", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :additional_treatments => { kind: :property, name: "additionalTreatments", is_optional: true },
    :campaign_hook => { kind: :property, name: "campaignHook", is_optional: true },
    :custom_delivery_configuration => { kind: :property, name: "customDeliveryConfiguration", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :holdout_percent => { kind: :property, name: "holdoutPercent", is_optional: true },
    :is_paused => { kind: :property, name: "isPaused", is_optional: true },
    :limits => { kind: :property, name: "limits", is_optional: true },
    :message_configuration => { kind: :property, name: "messageConfiguration", is_optional: true },
    :priority => { kind: :property, name: "priority", is_optional: true },
    :segment_version => { kind: :property, name: "segmentVersion", is_optional: true },
    :template_configuration => { kind: :property, name: "templateConfiguration", is_optional: true },
    :treatment_description => { kind: :property, name: "treatmentDescription", is_optional: true },
    :treatment_name => { kind: :property, name: "treatmentName", 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.



489
490
491
492
 
# File 'pinpoint/cfn_campaign.rb', line 489

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:



501
502
503
504
 
# File 'pinpoint/cfn_campaign.rb', line 501

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:



511
512
513
514
 
# File 'pinpoint/cfn_campaign.rb', line 511

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:



522
523
524
525
526
 
# File 'pinpoint/cfn_campaign.rb', line 522

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.


579
580
581
582
583
 
# File 'pinpoint/cfn_campaign.rb', line 579

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.



589
590
591
592
 
# File 'pinpoint/cfn_campaign.rb', line 589

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.



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

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

#additional_treatments ⇒ AWSCDK::IResolvable, ...

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

Returns:



295
296
297
 
# File 'pinpoint/cfn_campaign.rb', line 295

def additional_treatments()
  jsii_get_property("additionalTreatments")
end

#additional_treatments=(value) ⇒ Object 



299
300
301
302
 
# File 'pinpoint/cfn_campaign.rb', line 299

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

#application_id ⇒ String

The unique identifier for the Amazon Pinpoint application that the campaign is associated with.

Returns:

  • (String) 


234
235
236
 
# File 'pinpoint/cfn_campaign.rb', line 234

def application_id()
  jsii_get_property("applicationId")
end

#application_id=(value) ⇒ Object 



238
239
240
241
 
# File 'pinpoint/cfn_campaign.rb', line 238

def application_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  jsii_set_property("applicationId", 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:



614
615
616
617
 
# File 'pinpoint/cfn_campaign.rb', line 614

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:



636
637
638
639
640
641
 
# File 'pinpoint/cfn_campaign.rb', line 636

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) of the campaign.

Returns:

  • (String) 


206
207
208
 
# File 'pinpoint/cfn_campaign.rb', line 206

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_campaign_id ⇒ String

The unique identifier for the campaign.

Returns:

  • (String) 


213
214
215
 
# File 'pinpoint/cfn_campaign.rb', line 213

def attr_campaign_id()
  jsii_get_property("attrCampaignId")
end

#campaign_hook ⇒ AWSCDK::IResolvable, ...

Specifies the Lambda function to use as a code hook for a campaign.

Returns:



307
308
309
 
# File 'pinpoint/cfn_campaign.rb', line 307

def campaign_hook()
  jsii_get_property("campaignHook")
end

#campaign_hook=(value) ⇒ Object 



311
312
313
314
315
 
# File 'pinpoint/cfn_campaign.rb', line 311

def campaign_hook=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::CampaignHookProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5DYW1wYWlnbkhvb2tQcm9wZXJ0eSJ9XX19")), "campaignHook") unless value.nil?
  jsii_set_property("campaignHook", value)
end

#campaign_ref ⇒ AWSCDK::Interfaces::AWSPinpoint::CampaignReference

A reference to a Campaign resource.

Returns:



220
221
222
 
# File 'pinpoint/cfn_campaign.rb', line 220

def campaign_ref()
  jsii_get_property("campaignRef")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



152
153
154
 
# File 'pinpoint/cfn_campaign.rb', line 152

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


157
158
159
 
# File 'pinpoint/cfn_campaign.rb', line 157

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


645
646
647
648
 
# File 'pinpoint/cfn_campaign.rb', line 645

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}) 


162
163
164
 
# File 'pinpoint/cfn_campaign.rb', line 162

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


169
170
171
 
# File 'pinpoint/cfn_campaign.rb', line 169

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


114
115
116
 
# File 'pinpoint/cfn_campaign.rb', line 114

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_delivery_configuration ⇒ AWSCDK::IResolvable, ...

The delivery configuration settings for sending the treatment through a custom channel.

Returns:



320
321
322
 
# File 'pinpoint/cfn_campaign.rb', line 320

def custom_delivery_configuration()
  jsii_get_property("customDeliveryConfiguration")
end

#custom_delivery_configuration=(value) ⇒ Object 



324
325
326
327
328
 
# File 'pinpoint/cfn_campaign.rb', line 324

def custom_delivery_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::CustomDeliveryConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5DdXN0b21EZWxpdmVyeUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "customDeliveryConfiguration") unless value.nil?
  jsii_set_property("customDeliveryConfiguration", value)
end

#description ⇒ String?

A custom description of the campaign.

Returns:

  • (String, nil) 


333
334
335
 
# File 'pinpoint/cfn_campaign.rb', line 333

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



337
338
339
340
 
# File 'pinpoint/cfn_campaign.rb', line 337

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



174
175
176
 
# File 'pinpoint/cfn_campaign.rb', line 174

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:



658
659
660
661
662
 
# File 'pinpoint/cfn_campaign.rb', line 658

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:



669
670
671
672
 
# File 'pinpoint/cfn_campaign.rb', line 669

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

#holdout_percent ⇒ Numeric?

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

Returns:

  • (Numeric, nil) 


345
346
347
 
# File 'pinpoint/cfn_campaign.rb', line 345

def holdout_percent()
  jsii_get_property("holdoutPercent")
end

#holdout_percent=(value) ⇒ Object 



349
350
351
352
 
# File 'pinpoint/cfn_campaign.rb', line 349

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



739
740
741
742
 
# File 'pinpoint/cfn_campaign.rb', line 739

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

#is_paused ⇒ Boolean, ...

Specifies whether to pause the campaign.

Returns:



357
358
359
 
# File 'pinpoint/cfn_campaign.rb', line 357

def is_paused()
  jsii_get_property("isPaused")
end

#is_paused=(value) ⇒ Object 



361
362
363
364
 
# File 'pinpoint/cfn_campaign.rb', line 361

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

#limits ⇒ AWSCDK::IResolvable, ...

The messaging limits for the campaign.

Returns:



369
370
371
 
# File 'pinpoint/cfn_campaign.rb', line 369

def limits()
  jsii_get_property("limits")
end

#limits=(value) ⇒ Object 



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

def limits=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::LimitsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5MaW1pdHNQcm9wZXJ0eSJ9XX19")), "limits") unless value.nil?
  jsii_set_property("limits", value)
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) 


126
127
128
 
# File 'pinpoint/cfn_campaign.rb', line 126

def logical_id()
  jsii_get_property("logicalId")
end

#message_configuration ⇒ AWSCDK::IResolvable, ...

The message configuration settings for the treatment.

Returns:



382
383
384
 
# File 'pinpoint/cfn_campaign.rb', line 382

def message_configuration()
  jsii_get_property("messageConfiguration")
end

#message_configuration=(value) ⇒ Object 



386
387
388
389
390
 
# File 'pinpoint/cfn_campaign.rb', line 386

def message_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::MessageConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5NZXNzYWdlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "messageConfiguration") unless value.nil?
  jsii_set_property("messageConfiguration", value)
end

#name ⇒ String

The name of the campaign.

Returns:

  • (String) 


246
247
248
 
# File 'pinpoint/cfn_campaign.rb', line 246

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


109
110
111
 
# File 'pinpoint/cfn_campaign.rb', line 109

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:



680
681
682
 
# File 'pinpoint/cfn_campaign.rb', line 680

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:



687
688
689
 
# File 'pinpoint/cfn_campaign.rb', line 687

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.



480
481
482
483
 
# File 'pinpoint/cfn_campaign.rb', line 480

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

#priority ⇒ Numeric?

An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.

Returns:

  • (Numeric, nil) 


395
396
397
 
# File 'pinpoint/cfn_campaign.rb', line 395

def priority()
  jsii_get_property("priority")
end

#priority=(value) ⇒ Object 



399
400
401
402
 
# File 'pinpoint/cfn_campaign.rb', line 399

def priority=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "priority") unless value.nil?
  jsii_set_property("priority", value)
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) 


145
146
147
 
# File 'pinpoint/cfn_campaign.rb', line 145

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:



698
699
700
701
 
# File 'pinpoint/cfn_campaign.rb', line 698

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}) 


705
706
707
708
 
# File 'pinpoint/cfn_campaign.rb', line 705

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:



715
716
717
718
719
 
# File 'pinpoint/cfn_campaign.rb', line 715

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, AWSCDK::Pinpoint::CfnCampaign::ScheduleProperty

The schedule settings for the treatment.

Returns:



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

def schedule()
  jsii_get_property("schedule")
end

#schedule=(value) ⇒ Object 



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

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

#segment_id ⇒ String

The unique identifier for the segment to associate with the campaign.

Returns:

  • (String) 


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

def segment_id()
  jsii_get_property("segmentId")
end

#segment_id=(value) ⇒ Object 



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

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

#segment_version ⇒ Numeric?

The version of the segment to associate with the campaign.

Returns:

  • (Numeric, nil) 


407
408
409
 
# File 'pinpoint/cfn_campaign.rb', line 407

def segment_version()
  jsii_get_property("segmentVersion")
end

#segment_version=(value) ⇒ Object 



411
412
413
414
 
# File 'pinpoint/cfn_campaign.rb', line 411

def segment_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "segmentVersion") unless value.nil?
  jsii_set_property("segmentVersion", 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.



724
725
726
 
# File 'pinpoint/cfn_campaign.rb', line 724

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



135
136
137
 
# File 'pinpoint/cfn_campaign.rb', line 135

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



227
228
229
 
# File 'pinpoint/cfn_campaign.rb', line 227

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

An array of key-value pairs to apply to this resource.

Returns:

  • (Object) 


283
284
285
 
# File 'pinpoint/cfn_campaign.rb', line 283

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



287
288
289
290
 
# File 'pinpoint/cfn_campaign.rb', line 287

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw")
  jsii_set_property("tagsRaw", value)
end

#template_configuration ⇒ AWSCDK::IResolvable, ...

The message template to use for the treatment.

Returns:



419
420
421
 
# File 'pinpoint/cfn_campaign.rb', line 419

def template_configuration()
  jsii_get_property("templateConfiguration")
end

#template_configuration=(value) ⇒ Object 



423
424
425
426
427
 
# File 'pinpoint/cfn_campaign.rb', line 423

def template_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::TemplateConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5UZW1wbGF0ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "templateConfiguration") unless value.nil?
  jsii_set_property("templateConfiguration", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



456
457
458
 
# File 'pinpoint/cfn_campaign.rb', line 456

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

#treatment_description ⇒ String?

A custom description of the treatment.

Returns:

  • (String, nil) 


432
433
434
 
# File 'pinpoint/cfn_campaign.rb', line 432

def treatment_description()
  jsii_get_property("treatmentDescription")
end

#treatment_description=(value) ⇒ Object 



436
437
438
439
 
# File 'pinpoint/cfn_campaign.rb', line 436

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

#treatment_name ⇒ String?

A custom name for the treatment.

Returns:

  • (String, nil) 


444
445
446
 
# File 'pinpoint/cfn_campaign.rb', line 444

def treatment_name()
  jsii_get_property("treatmentName")
end

#treatment_name=(value) ⇒ Object 



448
449
450
451
 
# File 'pinpoint/cfn_campaign.rb', line 448

def treatment_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "treatmentName") unless value.nil?
  jsii_set_property("treatmentName", 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}) 


182
183
184
 
# File 'pinpoint/cfn_campaign.rb', line 182

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}) 


192
193
194
 
# File 'pinpoint/cfn_campaign.rb', line 192

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


730
731
732
733
 
# File 'pinpoint/cfn_campaign.rb', line 730

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) 


469
470
471
472
473
474
 
# File 'pinpoint/cfn_campaign.rb', line 469

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