Struct rusoto_cognito_idp::SmsConfigurationType

pub struct SmsConfigurationType {
    pub external_id: Option<String>,
    pub sns_caller_arn: String,
}

The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account. The Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM role that you provide for your AWS account.

Fields

external_id: Option<String>

The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party

sns_caller_arn: String

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

Trait Implementations

impl Clone for SmsConfigurationType

fn clone(&self) -> SmsConfigurationType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SmsConfigurationType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SmsConfigurationType

fn default() -> SmsConfigurationType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SmsConfigurationType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SmsConfigurationType> for SmsConfigurationType

fn eq(&self, other: &SmsConfigurationType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SmsConfigurationType) -> bool

This method tests for !=.

impl Serialize for SmsConfigurationType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SmsConfigurationType