Class: Aws::SMS::Types::ReplicationJob

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

Overview

Represents a replication job.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description of the replication job.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Indicates whether the replication job should produce encrypted AMIs.

Returns:

  • (Boolean) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#frequency ⇒ Integer

The time between consecutive replication runs, in hours.

Returns:

  • (Integer) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#latest_ami_id ⇒ String

The ID of the latest Amazon Machine Image (AMI).

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#license_type ⇒ String

The license type to be used for the AMI created by a successful replication run.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#next_replication_run_start_time ⇒ Time

The start time of the next replication run.

Returns:

  • (Time) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_recent_amis_to_keep ⇒ Integer

The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

Returns:

  • (Integer) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#replication_job_id ⇒ String

The ID of the replication job.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#replication_run_list ⇒ Array<Types::ReplicationRun>

Information about the replication runs.

Returns:



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#role_name ⇒ String

The name of the IAM role to be used by AWS SMS.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#run_once ⇒ Boolean

Indicates whether to run the replication job one time.

Returns:

  • (Boolean) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#seed_replication_time ⇒ Time

The seed replication time.

Returns:

  • (Time) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#server_id ⇒ String

The ID of the server.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#server_type ⇒ String

The type of server.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the replication job.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

The description of the current status of the replication job.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end

#vm_server ⇒ Types::VmServer

Information about the VM server.

Returns:



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 1702

class ReplicationJob < Struct.new(
  :replication_job_id,
  :server_id,
  :server_type,
  :vm_server,
  :seed_replication_time,
  :frequency,
  :run_once,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :latest_ami_id,
  :state,
  :status_message,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id,
  :replication_run_list)
  SENSITIVE = []
  include Aws::Structure
end