Class: Aws::PinpointEmail::Types::CloudWatchDimensionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb

Overview

An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_dimension_value ⇒ String

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

Returns:

  • (String) 


136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 136

class CloudWatchDimensionConfiguration < Struct.new(
  :dimension_name,
  :dimension_value_source,
  :default_dimension_value)
  SENSITIVE = []
  include Aws::Structure
end

#dimension_name ⇒ String

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

Returns:

  • (String) 


136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 136

class CloudWatchDimensionConfiguration < Struct.new(
  :dimension_name,
  :dimension_value_source,
  :default_dimension_value)
  SENSITIVE = []
  include Aws::Structure
end

#dimension_value_source ⇒ String

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

Returns:

  • (String) 


136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 136

class CloudWatchDimensionConfiguration < Struct.new(
  :dimension_name,
  :dimension_value_source,
  :default_dimension_value)
  SENSITIVE = []
  include Aws::Structure
end