SmsConfigurationType

public struct SmsConfigurationType : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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.

    Declaration

    Swift

    public let externalId: 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.

    Declaration

    Swift

    public let snsCallerArn: String

  • Undocumented

    Declaration

    Swift

    public init(externalId: String? = nil, snsCallerArn: String)

  • Declaration

    Swift

    public func validate(name: String) throws