Class: AWSCDK::PinpointEmail::CfnConfigurationSetProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint_email/cfn_configuration_set_props.rb

Overview

Properties for defining a CfnConfigurationSet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, delivery_options: nil, reputation_options: nil, sending_options: nil, tags: nil, tracking_options: nil) ⇒ CfnConfigurationSetProps

Returns a new instance of CfnConfigurationSetProps.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 15

def initialize(name:, delivery_options: nil, reputation_options: nil, sending_options: nil, tags: nil, tracking_options: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @delivery_options = delivery_options.is_a?(Hash) ? ::AWSCDK::PinpointEmail::CfnConfigurationSet::DeliveryOptionsProperty.new(**delivery_options.transform_keys(&:to_sym)) : delivery_options
  Jsii::Type.check_type(@delivery_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludGVtYWlsLkNmbkNvbmZpZ3VyYXRpb25TZXQuRGVsaXZlcnlPcHRpb25zUHJvcGVydHkifV19fQ==")), "deliveryOptions") unless @delivery_options.nil?
  @reputation_options = reputation_options.is_a?(Hash) ? ::AWSCDK::PinpointEmail::CfnConfigurationSet::ReputationOptionsProperty.new(**reputation_options.transform_keys(&:to_sym)) : reputation_options
  Jsii::Type.check_type(@reputation_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludGVtYWlsLkNmbkNvbmZpZ3VyYXRpb25TZXQuUmVwdXRhdGlvbk9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "reputationOptions") unless @reputation_options.nil?
  @sending_options = sending_options.is_a?(Hash) ? ::AWSCDK::PinpointEmail::CfnConfigurationSet::SendingOptionsProperty.new(**sending_options.transform_keys(&:to_sym)) : sending_options
  Jsii::Type.check_type(@sending_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludGVtYWlsLkNmbkNvbmZpZ3VyYXRpb25TZXQuU2VuZGluZ09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "sendingOptions") unless @sending_options.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?
  @tracking_options = tracking_options.is_a?(Hash) ? ::AWSCDK::PinpointEmail::CfnConfigurationSet::TrackingOptionsProperty.new(**tracking_options.transform_keys(&:to_sym)) : tracking_options
  Jsii::Type.check_type(@tracking_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludGVtYWlsLkNmbkNvbmZpZ3VyYXRpb25TZXQuVHJhY2tpbmdPcHRpb25zUHJvcGVydHkifV19fQ==")), "trackingOptions") unless @tracking_options.nil?
end

Instance Attribute Details

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

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

Returns:

See Also:



39
40
41
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 39

def delivery_options
  @delivery_options
end

#name ⇒ String (readonly)

The name of the configuration set.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 34

def name
  @name
end

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

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

Returns:

See Also:



44
45
46
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 44

def reputation_options
  @reputation_options
end

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

An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

Returns:

See Also:



49
50
51
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 49

def sending_options
  @sending_options
end

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

An object that defines the tags (keys and values) that you want to associate with the configuration set.

Returns:

See Also:



54
55
56
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 54

def tags
  @tags
end

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

An object that defines the open and click tracking options for emails that you send using the configuration set.

Returns:

See Also:



59
60
61
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 59

def tracking_options
  @tracking_options
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 61

def self.jsii_properties
  {
    :name => "name",
    :delivery_options => "deliveryOptions",
    :reputation_options => "reputationOptions",
    :sending_options => "sendingOptions",
    :tags => "tags",
    :tracking_options => "trackingOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'pinpoint_email/cfn_configuration_set_props.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "deliveryOptions" => @delivery_options,
    "reputationOptions" => @reputation_options,
    "sendingOptions" => @sending_options,
    "tags" => @tags,
    "trackingOptions" => @tracking_options,
  })
  result.compact
end