UserPoolSmsConfiguration class

Constructors

UserPoolSmsConfiguration({required Input<String> externalId, required Input<String> snsCallerArn, Input<String?>? snsRegion})
Creates a new UserPoolSmsConfiguration. externalId External ID used in IAM role trust relationships. For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party. snsCallerArn ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume. snsRegion The AWS 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) AWS 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.
const
UserPoolSmsConfiguration.fromMap(Map<String, dynamic> map)
factory

Properties

externalId → Input<String>
External ID used in IAM role trust relationships. For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snsCallerArn → Input<String>
ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.
final
snsRegion → Input<String?>?
The AWS 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) AWS 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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited