Class SmsConfigurationType
- java.lang.Object
-
- software.amazon.awssdk.services.cognitoidentityprovider.model.SmsConfigurationType
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>
@Generated("software.amazon.awssdk:codegen") public final class SmsConfigurationType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>
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 Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SmsConfigurationType.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SmsConfigurationType.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
externalId()
The external ID provides additional security for your IAM role.<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 SNS caller.String
snsRegion()
The Amazon Web Services Region to use with Amazon SNS integration.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 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.
- Returns:
- 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.
-
externalId
public final String 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 anExternalId
, 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 theExternalID
. 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 theExternalId
.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- Returns:
- 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 anExternalId
, 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 theExternalID
. 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 theExternalId
.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
public final String 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.
- Returns:
- 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.
-
toBuilder
public SmsConfigurationType.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>
-
builder
public static SmsConfigurationType.Builder builder()
-
serializableBuilderClass
public static Class<? extends SmsConfigurationType.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-