Class: Aws::MailManager::Types::CreateArchiveRequest

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

Overview

The request to create a new email archive.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archive_name ⇒ String

A unique name for the new archive.

Returns:

  • (String) 


481
482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 481

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :client_token,
  :kms_key_arn,
  :retention,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique token Amazon SES uses to recognize retries of this request.

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

Returns:

  • (String) 


481
482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 481

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :client_token,
  :kms_key_arn,
  :retention,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

Returns:

  • (String) 


481
482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 481

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :client_token,
  :kms_key_arn,
  :retention,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#retention ⇒ Types::ArchiveRetention

The period for retaining emails in the archive before automatic deletion.

Returns:



481
482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 481

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :client_token,
  :kms_key_arn,
  :retention,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:



481
482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 481

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :client_token,
  :kms_key_arn,
  :retention,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end