Class: Aws::SMS::Types::UpdateReplicationJobRequest

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 UpdateReplicationJobRequest data as a hash:

{
  replication_job_id: "ReplicationJobId", # required
  frequency: 1,
  next_replication_run_start_time: Time.now,
  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)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#encryptedBoolean

When true, the replication job produces encrypted AMIs. For more information, KmsKeyId.

Returns:

  • (Boolean)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :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)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :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 enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Returns:

  • (String)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :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)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_replication_run_start_timeTime

The start time of the next replication run.

Returns:

  • (Time)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :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)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#replication_job_idString

The ID of the replication job.

Returns:

  • (String)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :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 AWS SMS.

Returns:

  • (String)


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2954

class UpdateReplicationJobRequest < Struct.new(
  :replication_job_id,
  :frequency,
  :next_replication_run_start_time,
  :license_type,
  :role_name,
  :description,
  :number_of_recent_amis_to_keep,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end