com.amazonaws.services.cognitoidentityprovider.model

Class CreateUserImportJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.CreateUserImportJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateUserImportJobRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Creates a user import job.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateUserImportJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCloudWatchLogsRoleArn() The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
java.lang.String	getJobName() The job name for the user import job.
java.lang.String	getUserPoolId() The user pool ID for the user pool that the users are being imported into.
int	hashCode()
void	setCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn) The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
void	setJobName(java.lang.String jobName) The job name for the user import job.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool that the users are being imported into.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateUserImportJobRequest	withCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn) The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
CreateUserImportJobRequest	withJobName(java.lang.String jobName) The job name for the user import job.
CreateUserImportJobRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool that the users are being imported into.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUserImportJobRequest

public CreateUserImportJobRequest()

Method Detail

getJobName

public java.lang.String getJobName()

The job name for the user import job.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

Returns:

The job name for the user import job.

setJobName

public void setJobName(java.lang.String jobName)

The job name for the user import job.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

Parameters:

jobName -

The job name for the user import job.

withJobName

public CreateUserImportJobRequest withJobName(java.lang.String jobName)

The job name for the user import job.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

Parameters:

jobName -

The job name for the user import job.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID for the user pool that the users are being imported into.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool that the users are being imported into.

withUserPoolId

public CreateUserImportJobRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool that the users are being imported into.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool that the users are being imported into.

Returns:

A reference to this updated object so that method calls can be chained together.

getCloudWatchLogsRoleArn

public java.lang.String getCloudWatchLogsRoleArn()

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Returns:

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

setCloudWatchLogsRoleArn

public void setCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn)

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

cloudWatchLogsRoleArn -

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

withCloudWatchLogsRoleArn

public CreateUserImportJobRequest withCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn)

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

cloudWatchLogsRoleArn -

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object