You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CloudWatchDimensionConfiguration data as a hash:

{
  dimension_name: "DimensionName", # required
  dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
  default_dimension_value: "DefaultDimensionValue", # required
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#default_dimension_valueString

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)


148
149
150
151
152
153
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 148

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

#dimension_nameString

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)


148
149
150
151
152
153
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 148

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

#dimension_value_sourceString

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)


148
149
150
151
152
153
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 148

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