@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SmsConfigurationType extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
SmsConfigurationType() |
Modifier and Type | Method and Description |
---|---|
SmsConfigurationType |
clone() |
boolean |
equals(Object obj) |
String |
getExternalId()
The external ID provides additional security for your IAM role.
|
String |
getSnsCallerArn()
The Amazon Resource Name (ARN) of the Amazon SNS caller.
|
String |
getSnsRegion()
The Amazon Web Services Region to use with Amazon SNS integration.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setExternalId(String externalId)
The external ID provides additional security for your IAM role.
|
void |
setSnsCallerArn(String snsCallerArn)
The Amazon Resource Name (ARN) of the Amazon SNS caller.
|
void |
setSnsRegion(String snsRegion)
The Amazon Web Services Region to use with Amazon SNS integration.
|
String |
toString()
Returns a string representation of this object.
|
SmsConfigurationType |
withExternalId(String externalId)
The external ID provides additional security for your IAM role.
|
SmsConfigurationType |
withSnsCallerArn(String snsCallerArn)
The Amazon Resource Name (ARN) of the Amazon SNS caller.
|
SmsConfigurationType |
withSnsRegion(String snsRegion)
The Amazon Web Services Region to use with Amazon SNS integration.
|
public void setSnsCallerArn(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.
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.public String getSnsCallerArn()
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.
public SmsConfigurationType withSnsCallerArn(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.
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.public void setExternalId(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 an
ExternalId
, 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 the
ExternalID
. 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 the ExternalId
.
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
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 an
ExternalId
, 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 the
ExternalID
. 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 the ExternalId
.
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
public String getExternalId()
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 an
ExternalId
, 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 the
ExternalID
. 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 the ExternalId
.
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
ExternalId
with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an
ExternalId
, 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
the ExternalID
. 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 the ExternalId
.
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
public SmsConfigurationType withExternalId(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 an
ExternalId
, 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 the
ExternalID
. 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 the ExternalId
.
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
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 an
ExternalId
, 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 the
ExternalID
. 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 the ExternalId
.
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
public void setSnsRegion(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.
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.
public String getSnsRegion()
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.
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.
public SmsConfigurationType withSnsRegion(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.
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.
public String toString()
toString
in class Object
Object.toString()
public SmsConfigurationType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.