Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class CreateUserImportJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserImportJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserImportJobRequest.Builder,CreateUserImportJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateUserImportJobRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateUserImportJobRequest.Builder,CreateUserImportJobRequest>

Represents the request to create the user import job.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUserImportJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateUserImportJobRequest.Builder	builder()
final String	cloudWatchLogsRoleArn()	You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	jobName()	A friendly name for the user import job.
final PasswordHashingAlgorithmType	passwordHashingAlgorithm()	The password hashing algorithm used to generate the hashes in the CSV file for this import job.
final String	passwordHashingAlgorithmAsString()	The password hashing algorithm used to generate the hashes in the CSV file for this import job.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserImportJobRequest.Builder>	serializableBuilderClass()
CreateUserImportJobRequest.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final String	userPoolId()	The ID of the user pool that you want to import users into.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 Details

jobName

public final String jobName()

A friendly name for the user import job.

Returns:

A friendly name for the user import job.

userPoolId

public final String userPoolId()

The ID of the user pool that you want to import users into.

Returns:

The ID of the user pool that you want to import users into.

cloudWatchLogsRoleArn

public final String cloudWatchLogsRoleArn()

You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs. This parameter is the ARN of that role.

Returns:

You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs. This parameter is the ARN of that role.

passwordHashingAlgorithm

public final PasswordHashingAlgorithmType passwordHashingAlgorithm()

The password hashing algorithm used to generate the hashes in the CSV file for this import job.

Valid values: BCRYPT | SCRYPT | ARGON2ID | PBKDF2_SHA256

If the service returns an enum value that is not available in the current SDK version, passwordHashingAlgorithm will return PasswordHashingAlgorithmType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from passwordHashingAlgorithmAsString().

Returns:

The password hashing algorithm used to generate the hashes in the CSV file for this import job.

Valid values: BCRYPT | SCRYPT | ARGON2ID | PBKDF2_SHA256

See Also:

• PasswordHashingAlgorithmType

passwordHashingAlgorithmAsString

public final String passwordHashingAlgorithmAsString()

The password hashing algorithm used to generate the hashes in the CSV file for this import job.

Valid values: BCRYPT | SCRYPT | ARGON2ID | PBKDF2_SHA256

If the service returns an enum value that is not available in the current SDK version, passwordHashingAlgorithm will return PasswordHashingAlgorithmType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from passwordHashingAlgorithmAsString().

Returns:

The password hashing algorithm used to generate the hashes in the CSV file for this import job.

Valid values: BCRYPT | SCRYPT | ARGON2ID | PBKDF2_SHA256

See Also:

• PasswordHashingAlgorithmType

toBuilder

public CreateUserImportJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserImportJobRequest.Builder,CreateUserImportJobRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static CreateUserImportJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUserImportJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo