Class: Aws::CognitoIdentityProvider::Types::EumsSmsConfigurationType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The configuration that Amazon Cognito uses to send SMS messages through Amazon Web Services End User Messaging SMS. Provide this structure in the EumsSms member of SmsConfigurationType to use Amazon Web Services End User Messaging SMS instead of Amazon SNS.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#caller_arn ⇒ String

The ARN of the IAM role that Amazon Cognito assumes to send SMS messages through Amazon Web Services End User Messaging SMS. The role must grant permission to call the sms-voice:SendTextMessage operation.

Returns:

  • (String) 


6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6190

class EumsSmsConfigurationType < Struct.new(
  :caller_arn,
  :external_id,
  :origination_identity,
  :configuration_set_name,
  :in_entity_id,
  :in_template_id,
  :region)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_set_name ⇒ String

The name of the Amazon Web Services End User Messaging SMS configuration set that Amazon Cognito applies to messages, for logging and event destinations. If you omit this member, Amazon Cognito sends messages without applying a configuration set.

Returns:

  • (String) 


6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6190

class EumsSmsConfigurationType < Struct.new(
  :caller_arn,
  :external_id,
  :origination_identity,
  :configuration_set_name,
  :in_entity_id,
  :in_template_id,
  :region)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

The external ID that Amazon Cognito includes when it assumes the CallerArn role. Use this value as a condition in the role trust policy to prevent the confused deputy problem.

Returns:

  • (String) 


6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6190

class EumsSmsConfigurationType < Struct.new(
  :caller_arn,
  :external_id,
  :origination_identity,
  :configuration_set_name,
  :in_entity_id,
  :in_template_id,
  :region)
  SENSITIVE = []
  include Aws::Structure
end

#in_entity_id ⇒ String

The principal entity ID required by India's Distributed Ledger Technology (DLT) regulations for SMS messages.

Returns:

  • (String) 


6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6190

class EumsSmsConfigurationType < Struct.new(
  :caller_arn,
  :external_id,
  :origination_identity,
  :configuration_set_name,
  :in_entity_id,
  :in_template_id,
  :region)
  SENSITIVE = []
  include Aws::Structure
end

#in_template_id ⇒ String

The registered template ID for the message template required by India's DLT regulations for SMS messages.

Returns:

  • (String) 


6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6190

class EumsSmsConfigurationType < Struct.new(
  :caller_arn,
  :external_id,
  :origination_identity,
  :configuration_set_name,
  :in_entity_id,
  :in_template_id,
  :region)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identity ⇒ String

The origination identity that Amazon Web Services End User Messaging SMS uses to send messages to your users. This value can be one of the following:

  • A phone number – A long code, toll-free number, or short code that is assigned to your account.

  • A sender ID – An alphabetic name that identifies the message sender in supported countries.

  • A phone pool – A group of phone numbers that Amazon Web Services End User Messaging SMS selects from when it sends messages.

You can provide an E.164 phone number or the ARN of the phone number, sender ID, or phone pool. Amazon Web Services End User Messaging SMS evaluates IAM authorization with the value that you provide. If the permissions policy of your CallerArn role scopes the sms-voice:SendTextMessage resource to a specific ARN, provide that same ARN. If the formats do not match, requests fail with an InvalidSmsRoleAccessPolicyException.

Depending on the destination country, you must provide an origination identity. For country-specific requirements, see Supported countries and regions for SMS messaging in the Amazon Web Services End User Messaging SMS User Guide.

Returns:

  • (String) 


6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6190

class EumsSmsConfigurationType < Struct.new(
  :caller_arn,
  :external_id,
  :origination_identity,
  :configuration_set_name,
  :in_entity_id,
  :in_template_id,
  :region)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The Amazon Web Services Region of the Amazon Web Services End User Messaging SMS resources that Amazon Cognito uses to send messages. Amazon Web Services End User Messaging SMS must be available in your user pool's Region.

If you omit this parameter, Amazon Cognito uses the same Region as your user pool. You can also set this parameter to your user pool's Region explicitly. Amazon Cognito rejects any other value with an InvalidParameterException.

Returns:

  • (String) 


6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6190

class EumsSmsConfigurationType < Struct.new(
  :caller_arn,
  :external_id,
  :origination_identity,
  :configuration_set_name,
  :in_entity_id,
  :in_template_id,
  :region)
  SENSITIVE = []
  include Aws::Structure
end