software.amazon.awssdk.services.cognitoidentityprovider.model

Class SmsConfigurationType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.SmsConfigurationType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>

@Generated(value="software.amazon.awssdk:codegen")
public final class SmsConfigurationType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SmsConfigurationType.Builder

Method Summary

Modifier and Type	Method and Description
static SmsConfigurationType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SmsConfigurationType.Builder>	serializableBuilderClass()
String	snsCallerArn() The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.
SmsConfigurationType.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

snsCallerArn

public final String snsCallerArn()

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. SMS messages are subject to a spending limit.

Returns:

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. SMS messages are subject to a spending limit.

externalId

public final String 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 AWS resources to a third party

Returns:

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 AWS resources to a third party

toBuilder

public SmsConfigurationType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>

builder

public static SmsConfigurationType.Builder builder()

serializableBuilderClass

public static Class<? extends SmsConfigurationType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo