Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType

Description

Synopsis

data SmsConfigurationType = SmsConfigurationType' {
- externalId :: Maybe Text
- snsCallerArn :: Text
}
newSmsConfigurationType :: Text -> SmsConfigurationType
smsConfigurationType_externalId :: Lens' SmsConfigurationType (Maybe Text)
smsConfigurationType_snsCallerArn :: Lens' SmsConfigurationType Text

Documentation

data SmsConfigurationType Source #

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 account. The Cognito User Pool makes the request to the Amazon SNS Service by using an IAM role that you provide for your account.

See: newSmsConfigurationType smart constructor.

Constructors

SmsConfigurationType'

Fields

externalId :: Maybe Text
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 Amazon Web Services resources to a third party
snsCallerArn :: Text
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your account which Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

Instances

Instances details

Eq SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods (==) :: SmsConfigurationType -> SmsConfigurationType -> Bool # (/=) :: SmsConfigurationType -> SmsConfigurationType -> Bool #
Read SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods readsPrec :: Int -> ReadS SmsConfigurationType # readList :: ReadS [SmsConfigurationType] # readPrec :: ReadPrec SmsConfigurationType # readListPrec :: ReadPrec [SmsConfigurationType] #
Show SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods showsPrec :: Int -> SmsConfigurationType -> ShowS # show :: SmsConfigurationType -> String # showList :: [SmsConfigurationType] -> ShowS #
Generic SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Associated Types type Rep SmsConfigurationType :: Type -> Type # Methods from :: SmsConfigurationType -> Rep SmsConfigurationType x # to :: Rep SmsConfigurationType x -> SmsConfigurationType #
NFData SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods rnf :: SmsConfigurationType -> () #
Hashable SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods hashWithSalt :: Int -> SmsConfigurationType -> Int # hash :: SmsConfigurationType -> Int #
ToJSON SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods toJSON :: SmsConfigurationType -> Value # toEncoding :: SmsConfigurationType -> Encoding # toJSONList :: [SmsConfigurationType] -> Value # toEncodingList :: [SmsConfigurationType] -> Encoding #
FromJSON SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods parseJSON :: Value -> Parser SmsConfigurationType # parseJSONList :: Value -> Parser [SmsConfigurationType] #
type Rep SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType type Rep SmsConfigurationType = D1 ('MetaData "SmsConfigurationType" "Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "SmsConfigurationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snsCallerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSmsConfigurationType Source #

Arguments

:: Text	`$sel:snsCallerArn:SmsConfigurationType'`
-> SmsConfigurationType

Create a value of SmsConfigurationType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:externalId:SmsConfigurationType', smsConfigurationType_externalId - 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 Amazon Web Services resources to a third party

$sel:snsCallerArn:SmsConfigurationType', smsConfigurationType_snsCallerArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your account which Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

smsConfigurationType_externalId :: Lens' SmsConfigurationType (Maybe Text) Source #

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 Amazon Web Services resources to a third party

smsConfigurationType_snsCallerArn :: Lens' SmsConfigurationType Text Source #

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