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

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::CreateImpersonationRoleRequest

Includes:

Structure

Defined in:

lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  The idempotency token for the client request.

• #description ⇒ String

  The description of the new impersonation role.

• #name ⇒ String

  The name of the new impersonation role.

• #organization_id ⇒ String

  The WorkMail organization to create the new impersonation role within.

• #rules ⇒ Array<Types::ImpersonationRule>

  The list of rules for the impersonation role.

• #type ⇒ String

  The impersonation role’s type.

Instance Attribute Details

#client_token ⇒ String

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)

# File 'lib/aws-sdk-workmail/types.rb', line 492

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

#description ⇒ String

The description of the new impersonation role.

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 492

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

#name ⇒ String

The name of the new impersonation role.

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 492

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

#organization_id ⇒ String

The WorkMail organization to create the new impersonation role within.

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 492

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

#rules ⇒ Array<Types::ImpersonationRule>

The list of rules for the impersonation role.

Returns:

• (Array<Types::ImpersonationRule>)

# File 'lib/aws-sdk-workmail/types.rb', line 492

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

#type ⇒ String

The impersonation role’s type. The available impersonation role types are ‘READ_ONLY` or `FULL_ACCESS`.

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 492

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