Paws::CognitoIdp::SetUserPoolMfaConfig - Arguments for method SetUserPoolMfaConfig on Paws::CognitoIdp
This class represents the parameters used for calling the method SetUserPoolMfaConfig on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method SetUserPoolMfaConfig.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetUserPoolMfaConfig.
my $cognito-idp = Paws->service('CognitoIdp'); my $SetUserPoolMfaConfigResponse = $cognito -idp->SetUserPoolMfaConfig( UserPoolId => 'MyUserPoolIdType', MfaConfiguration => 'OFF', # OPTIONAL SmsMfaConfiguration => { SmsAuthenticationMessage => 'MySmsVerificationMessageType', # min: 6, max: 140; OPTIONAL SmsConfiguration => { SnsCallerArn => 'MyArnType', # min: 20, max: 2048 ExternalId => 'MyStringType', # OPTIONAL }, # OPTIONAL }, # OPTIONAL SoftwareTokenMfaConfiguration => { Enabled => 1, # OPTIONAL }, # OPTIONAL ); # Results: my $MfaConfiguration = $SetUserPoolMfaConfigResponse->MfaConfiguration; my $SmsMfaConfiguration = $SetUserPoolMfaConfigResponse->SmsMfaConfiguration; my $SoftwareTokenMfaConfiguration = $SetUserPoolMfaConfigResponse->SoftwareTokenMfaConfiguration; # Returns a L<Paws::CognitoIdp::SetUserPoolMfaConfigResponse> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/SetUserPoolMfaConfig
The MFA configuration.
Valid values are: "OFF", "ON", "OPTIONAL"
"OFF"
"ON"
"OPTIONAL"
The SMS text message MFA configuration.
The software token MFA configuration.
The user pool ID.
This class forms part of Paws, documenting arguments for method SetUserPoolMfaConfig in Paws::CognitoIdp
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.