Class: Aws::WorkMail::Types::CreateImpersonationRoleRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

The idempotency token for the client request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


455
456
457
458
459
460
461
462
463
464
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 455

class CreateImpersonationRoleRequest < Struct.new(
  :client_token,
  :organization_id,
  :name,
  :type,
  :description,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the new impersonation role.

Returns:

  • (String)


455
456
457
458
459
460
461
462
463
464
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 455

class CreateImpersonationRoleRequest < Struct.new(
  :client_token,
  :organization_id,
  :name,
  :type,
  :description,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the new impersonation role.

Returns:

  • (String)


455
456
457
458
459
460
461
462
463
464
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 455

class CreateImpersonationRoleRequest < Struct.new(
  :client_token,
  :organization_id,
  :name,
  :type,
  :description,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#organization_idString

The WorkMail organization to create the new impersonation role within.

Returns:

  • (String)


455
456
457
458
459
460
461
462
463
464
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 455

class CreateImpersonationRoleRequest < Struct.new(
  :client_token,
  :organization_id,
  :name,
  :type,
  :description,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#rulesArray<Types::ImpersonationRule>

The list of rules for the impersonation role.

Returns:



455
456
457
458
459
460
461
462
463
464
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 455

class CreateImpersonationRoleRequest < Struct.new(
  :client_token,
  :organization_id,
  :name,
  :type,
  :description,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

Returns:

  • (String)


455
456
457
458
459
460
461
462
463
464
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 455

class CreateImpersonationRoleRequest < Struct.new(
  :client_token,
  :organization_id,
  :name,
  :type,
  :description,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end