Class: Aws::SMS::Types::CreateReplicationJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::SMS::Types::CreateReplicationJobRequest

Defined in:

gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the replication job.

• #encrypted ⇒ Boolean

  Indicates whether the replication job produces encrypted AMIs.

• #frequency ⇒ Integer

  The time between consecutive replication runs, in hours.

• #kms_key_id ⇒ String

  The ID of the KMS key for replication jobs that produce encrypted AMIs.

• #license_type ⇒ String

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

• #number_of_recent_amis_to_keep ⇒ Integer

  The maximum number of SMS-created AMIs to retain.

• #role_name ⇒ String

  The name of the IAM role to be used by the Server Migration Service.

• #run_once ⇒ Boolean

  Indicates whether to run the replication job one time.

• #seed_replication_time ⇒ Time

  The seed replication time.

• #server_id ⇒ String

  The ID of the server.

Instance Attribute Details

#description ⇒ String

The description of the replication job.

Returns:

• (String)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Indicates whether the replication job produces encrypted AMIs.

Returns:

• (Boolean)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#frequency ⇒ Integer

The time between consecutive replication runs, in hours.

Returns:

• (Integer)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  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 true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Returns:

• (String)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  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)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_recent_amis_to_keep ⇒ Integer

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

Returns:

• (Integer)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#role_name ⇒ String

The name of the IAM role to be used by the Server Migration Service.

Returns:

• (String)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#run_once ⇒ Boolean

Indicates whether to run the replication job one time.

Returns:

• (Boolean)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#seed_replication_time ⇒ Time

The seed replication time.

Returns:

• (Time)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#server_id ⇒ String

The ID of the server.

Returns:

• (String)

# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 339

class CreateReplicationJobRequest < Struct.new(
  :server_id,
  :seed_replication_time,
  :frequency,
  :run_once,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end