You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::CreateUserImportJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass CreateUserImportJobRequest data as a hash:

{
  job_name: "UserImportJobNameType", # required
  user_pool_id: "UserPoolIdType", # required
  cloud_watch_logs_role_arn: "ArnType", # required
}

Represents the request to create the user import job.

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logs_role_arnString

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

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1872

class CreateUserImportJobRequest < Struct.new(
  :job_name,
  :user_pool_id,
  :cloud_watch_logs_role_arn)
  include Aws::Structure
end

#job_nameString

The job name for the user import job.

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1872

class CreateUserImportJobRequest < Struct.new(
  :job_name,
  :user_pool_id,
  :cloud_watch_logs_role_arn)
  include Aws::Structure
end

#user_pool_idString

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

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1872

class CreateUserImportJobRequest < Struct.new(
  :job_name,
  :user_pool_id,
  :cloud_watch_logs_role_arn)
  include Aws::Structure
end