Class: Aws::SESV2::Types::CloudWatchDimensionConfiguration

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

Overview

An object that defines the dimension configuration to use when you send 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:

  • Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).

  • It can contain no more than 256 characters.

Returns:

  • (String) 


513
514
515
516
517
518
519
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 513

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) 


513
514
515
516
517
518
519
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 513

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

#dimension_value_source ⇒ String

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

Returns:

  • (String) 


513
514
515
516
517
518
519
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 513

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