com.pulumi.aws.cognito.outputs.UserPoolSmsConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.66.3
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.cognito.outputs;

import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;

@CustomType
public final class UserPoolSmsConfiguration {
    /**
     * @return External ID used in IAM role trust relationships. For more information about using external IDs, see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).
     * 
     */
    private String externalId;
    /**
     * @return ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.
     * 
     */
    private String snsCallerArn;
    /**
     * @return 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](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html).
     * 
     */
    private @Nullable String snsRegion;

    private UserPoolSmsConfiguration() {}
    /**
     * @return External ID used in IAM role trust relationships. For more information about using external IDs, see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).
     * 
     */
    public String externalId() {
        return this.externalId;
    }
    /**
     * @return ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.
     * 
     */
    public String snsCallerArn() {
        return this.snsCallerArn;
    }
    /**
     * @return 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](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html).
     * 
     */
    public Optional snsRegion() {
        return Optional.ofNullable(this.snsRegion);
    }

    public static Builder builder() {
        return new Builder();
    }

    public static Builder builder(UserPoolSmsConfiguration defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private String externalId;
        private String snsCallerArn;
        private @Nullable String snsRegion;
        public Builder() {}
        public Builder(UserPoolSmsConfiguration defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.externalId = defaults.externalId;
    	      this.snsCallerArn = defaults.snsCallerArn;
    	      this.snsRegion = defaults.snsRegion;
        }

        @CustomType.Setter
        public Builder externalId(String externalId) {
            if (externalId == null) {
              throw new MissingRequiredPropertyException("UserPoolSmsConfiguration", "externalId");
            }
            this.externalId = externalId;
            return this;
        }
        @CustomType.Setter
        public Builder snsCallerArn(String snsCallerArn) {
            if (snsCallerArn == null) {
              throw new MissingRequiredPropertyException("UserPoolSmsConfiguration", "snsCallerArn");
            }
            this.snsCallerArn = snsCallerArn;
            return this;
        }
        @CustomType.Setter
        public Builder snsRegion(@Nullable String snsRegion) {

            this.snsRegion = snsRegion;
            return this;
        }
        public UserPoolSmsConfiguration build() {
            final var _resultValue = new UserPoolSmsConfiguration();
            _resultValue.externalId = externalId;
            _resultValue.snsCallerArn = snsCallerArn;
            _resultValue.snsRegion = snsRegion;
            return _resultValue;
        }
    }
}