Package software.amazon.awscdk.services.cognito

Class CfnUserPool.SmsConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.CfnUserPool.SmsConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnUserPool.SmsConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnUserPool.SmsConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnUserPool.SmsConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnUserPool.SmsConfigurationProperty

An implementation for CfnUserPool.SmsConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPool.SmsConfigurationProperty

CfnUserPool.SmsConfigurationProperty.Builder, CfnUserPool.SmsConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnUserPool.SmsConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnUserPool.SmsConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getExternalId()	The external ID provides additional security for your IAM role.
final String	getSnsCallerArn()	The Amazon Resource Name (ARN) of the Amazon SNS caller.
final String	getSnsRegion()	The AWS Region to use with Amazon SNS integration.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnUserPool.SmsConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnUserPool.SmsConfigurationProperty.Builder.

Method Details

getExternalId

public final String getExternalId()

Description copied from interface: CfnUserPool.SmsConfigurationProperty

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

Specified by:

getExternalId in interface CfnUserPool.SmsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-externalid

getSnsCallerArn

public final String getSnsCallerArn()

Description copied from interface: CfnUserPool.SmsConfigurationProperty

The Amazon Resource Name (ARN) of the Amazon SNS caller.

This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit .

Specified by:

getSnsCallerArn in interface CfnUserPool.SmsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snscallerarn

getSnsRegion

public final String getSnsRegion()

Description copied from interface: CfnUserPool.SmsConfigurationProperty

The AWS 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) AWS 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 .

Specified by:

getSnsRegion in interface CfnUserPool.SmsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snsregion

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object