Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType

Description

Documentation

data SmsConfigurationType Source #

The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

See: newSmsConfigurationType smart constructor.

Constructors

SmsConfigurationType'

Fields

externalId :: Maybe Text
The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates 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
snsRegion :: Maybe Text
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported __Legacy Amazon SNS alternate Region__.
Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
snsCallerArn :: Text
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

Instances

Instances details

FromJSON SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods parseJSON :: Value -> Parser SmsConfigurationType # parseJSONList :: Value -> Parser [SmsConfigurationType] #
ToJSON SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods toJSON :: SmsConfigurationType -> Value # toEncoding :: SmsConfigurationType -> Encoding # toJSONList :: [SmsConfigurationType] -> Value # toEncodingList :: [SmsConfigurationType] -> Encoding #
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 #
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 #
NFData SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods rnf :: SmsConfigurationType -> () #
Eq SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods (==) :: SmsConfigurationType -> SmsConfigurationType -> Bool # (/=) :: SmsConfigurationType -> SmsConfigurationType -> Bool #
Hashable SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType Methods hashWithSalt :: Int -> SmsConfigurationType -> Int # hash :: SmsConfigurationType -> Int #
type Rep SmsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType type Rep SmsConfigurationType = D1 ('MetaData "SmsConfigurationType" "Amazonka.CognitoIdentityProvider.Types.SmsConfigurationType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "SmsConfigurationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "snsRegion") '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 provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates 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:snsRegion:SmsConfigurationType', smsConfigurationType_snsRegion - The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported __Legacy Amazon SNS alternate Region__.

Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

$sel:snsCallerArn:SmsConfigurationType', smsConfigurationType_snsCallerArn - The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon 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 provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates 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_snsRegion :: Lens' SmsConfigurationType (Maybe Text) Source #

The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported __Legacy Amazon SNS alternate Region__.

Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

smsConfigurationType_snsCallerArn :: Lens' SmsConfigurationType Text Source #

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