Class: Aws::SES::Types::CloudWatchDimensionConfiguration

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

Overview

Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

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 do not provide the value of the dimension when you send an email. The default value must meet the following requirements:

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

  • Contain 256 characters or fewer.

Returns:

  • (String) 


456
457
458
459
460
461
462
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 456

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 must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).

  • Contain 256 characters or fewer.

Returns:

  • (String) 


456
457
458
459
460
461
462
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 456

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

#dimension_value_source ⇒ String

The place where Amazon SES 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/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.

Returns:

  • (String) 


456
457
458
459
460
461
462
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 456

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