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

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

Overview

Note:

When making an API call, you may pass CreateReplicationJobRequest data as a hash:

{
  server_id: "ServerId", # required
  seed_replication_time: Time.now, # required
  frequency: 1,
  run_once: false,
  license_type: "AWS", # accepts AWS, BYOL
  role_name: "RoleName",
  description: "Description",
  number_of_recent_amis_to_keep: 1,
  encrypted: false,
  kms_key_id: "KmsKeyId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the replication job.

Returns:

  • (String)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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

#encryptedBoolean

Indicates whether the replication job produces encrypted AMIs.

Returns:

  • (Boolean)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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

#frequencyInteger

The time between consecutive replication runs, in hours.

Returns:

  • (Integer)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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_idString

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)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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_typeString

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

Returns:

  • (String)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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_keepInteger

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)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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_nameString

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

Returns:

  • (String)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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_onceBoolean

Indicates whether to run the replication job one time.

Returns:

  • (Boolean)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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_timeTime

The seed replication time.

Returns:

  • (Time)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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_idString

The ID of the server.

Returns:

  • (String)


417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 417

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