software.amazon.awscdk.services.appstream.CfnUserProps Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appstream Show documentation
Show all versions of appstream Show documentation
The CDK Construct Library for AWS::AppStream
package software.amazon.awscdk.services.appstream;
/**
* Properties for defining a `CfnUser`.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.appstream.*;
* CfnUserProps cfnUserProps = CfnUserProps.builder()
* .authenticationType("authenticationType")
* .userName("userName")
* // the properties below are optional
* .firstName("firstName")
* .lastName("lastName")
* .messageAction("messageAction")
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.73.0 (build 6faeda3)", date = "2023-01-31T18:36:45.672Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.appstream.$Module.class, fqn = "@aws-cdk/aws-appstream.CfnUserProps")
@software.amazon.jsii.Jsii.Proxy(CfnUserProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface CfnUserProps extends software.amazon.jsii.JsiiSerializable {
/**
* The authentication type for the user.
*
* You must specify USERPOOL.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getAuthenticationType();
/**
* The email address of the user.
*
* Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getUserName();
/**
* The first name, or given name, of the user.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getFirstName() {
return null;
}
/**
* The last name, or surname, of the user.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getLastName() {
return null;
}
/**
* The action to take for the welcome email that is sent to a user after the user is created in the user pool.
*
* If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
*
*
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
*
*
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getMessageAction() {
return null;
}
/**
* @return a {@link Builder} of {@link CfnUserProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link CfnUserProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String authenticationType;
java.lang.String userName;
java.lang.String firstName;
java.lang.String lastName;
java.lang.String messageAction;
/**
* Sets the value of {@link CfnUserProps#getAuthenticationType}
* @param authenticationType The authentication type for the user. This parameter is required.
* You must specify USERPOOL.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder authenticationType(java.lang.String authenticationType) {
this.authenticationType = authenticationType;
return this;
}
/**
* Sets the value of {@link CfnUserProps#getUserName}
* @param userName The email address of the user. This parameter is required.
* Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder userName(java.lang.String userName) {
this.userName = userName;
return this;
}
/**
* Sets the value of {@link CfnUserProps#getFirstName}
* @param firstName The first name, or given name, of the user.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder firstName(java.lang.String firstName) {
this.firstName = firstName;
return this;
}
/**
* Sets the value of {@link CfnUserProps#getLastName}
* @param lastName The last name, or surname, of the user.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder lastName(java.lang.String lastName) {
this.lastName = lastName;
return this;
}
/**
* Sets the value of {@link CfnUserProps#getMessageAction}
* @param messageAction The action to take for the welcome email that is sent to a user after the user is created in the user pool.
* If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
*
*
*
* The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
*
*
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder messageAction(java.lang.String messageAction) {
this.messageAction = messageAction;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link CfnUserProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public CfnUserProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link CfnUserProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnUserProps {
private final java.lang.String authenticationType;
private final java.lang.String userName;
private final java.lang.String firstName;
private final java.lang.String lastName;
private final java.lang.String messageAction;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.authenticationType = software.amazon.jsii.Kernel.get(this, "authenticationType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.userName = software.amazon.jsii.Kernel.get(this, "userName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.firstName = software.amazon.jsii.Kernel.get(this, "firstName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.lastName = software.amazon.jsii.Kernel.get(this, "lastName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.messageAction = software.amazon.jsii.Kernel.get(this, "messageAction", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.authenticationType = java.util.Objects.requireNonNull(builder.authenticationType, "authenticationType is required");
this.userName = java.util.Objects.requireNonNull(builder.userName, "userName is required");
this.firstName = builder.firstName;
this.lastName = builder.lastName;
this.messageAction = builder.messageAction;
}
@Override
public final java.lang.String getAuthenticationType() {
return this.authenticationType;
}
@Override
public final java.lang.String getUserName() {
return this.userName;
}
@Override
public final java.lang.String getFirstName() {
return this.firstName;
}
@Override
public final java.lang.String getLastName() {
return this.lastName;
}
@Override
public final java.lang.String getMessageAction() {
return this.messageAction;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("authenticationType", om.valueToTree(this.getAuthenticationType()));
data.set("userName", om.valueToTree(this.getUserName()));
if (this.getFirstName() != null) {
data.set("firstName", om.valueToTree(this.getFirstName()));
}
if (this.getLastName() != null) {
data.set("lastName", om.valueToTree(this.getLastName()));
}
if (this.getMessageAction() != null) {
data.set("messageAction", om.valueToTree(this.getMessageAction()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-appstream.CfnUserProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CfnUserProps.Jsii$Proxy that = (CfnUserProps.Jsii$Proxy) o;
if (!authenticationType.equals(that.authenticationType)) return false;
if (!userName.equals(that.userName)) return false;
if (this.firstName != null ? !this.firstName.equals(that.firstName) : that.firstName != null) return false;
if (this.lastName != null ? !this.lastName.equals(that.lastName) : that.lastName != null) return false;
return this.messageAction != null ? this.messageAction.equals(that.messageAction) : that.messageAction == null;
}
@Override
public final int hashCode() {
int result = this.authenticationType.hashCode();
result = 31 * result + (this.userName.hashCode());
result = 31 * result + (this.firstName != null ? this.firstName.hashCode() : 0);
result = 31 * result + (this.lastName != null ? this.lastName.hashCode() : 0);
result = 31 * result + (this.messageAction != null ? this.messageAction.hashCode() : 0);
return result;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy