Class: Aws::PinpointEmail::Types::CreateConfigurationSetRequest

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 CreateConfigurationSetRequest data as a hash:

{
  configuration_set_name: "ConfigurationSetName", # required
  tracking_options: {
    custom_redirect_domain: "CustomRedirectDomain", # required
  },
  delivery_options: {
    tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
    sending_pool_name: "PoolName",
  },
  reputation_options: {
    reputation_metrics_enabled: false,
    last_fresh_start: Time.now,
  },
  sending_options: {
    sending_enabled: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

A request to create a configuration set.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_nameString

The name of the configuration set.

Returns:

  • (String)


343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 343

class CreateConfigurationSetRequest < Struct.new(
  :configuration_set_name,
  :tracking_options,
  :delivery_options,
  :reputation_options,
  :sending_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_optionsTypes::DeliveryOptions

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



343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 343

class CreateConfigurationSetRequest < Struct.new(
  :configuration_set_name,
  :tracking_options,
  :delivery_options,
  :reputation_options,
  :sending_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reputation_optionsTypes::ReputationOptions

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



343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 343

class CreateConfigurationSetRequest < Struct.new(
  :configuration_set_name,
  :tracking_options,
  :delivery_options,
  :reputation_options,
  :sending_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#sending_optionsTypes::SendingOptions

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



343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 343

class CreateConfigurationSetRequest < Struct.new(
  :configuration_set_name,
  :tracking_options,
  :delivery_options,
  :reputation_options,
  :sending_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

An array of objects that define the tags (keys and values) that you want to associate with the configuration set.

Returns:



343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 343

class CreateConfigurationSetRequest < Struct.new(
  :configuration_set_name,
  :tracking_options,
  :delivery_options,
  :reputation_options,
  :sending_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tracking_optionsTypes::TrackingOptions

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



343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 343

class CreateConfigurationSetRequest < Struct.new(
  :configuration_set_name,
  :tracking_options,
  :delivery_options,
  :reputation_options,
  :sending_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end