AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateReplicationJobRequest as input to an Aws::Client method, you can use a vanilla 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the replication job.

Returns:

  • (String)

    The description of the replication job.

#encryptedBoolean

Indicates whether the replication job produces encrypted AMIs.

Returns:

  • (Boolean)

    Indicates whether the replication job produces encrypted AMIs.

#frequencyInteger

The time between consecutive replication runs, in hours.

Returns:

  • (Integer)

    The time between consecutive replication runs, in hours.

#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)

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

#license_typeString

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

Possible values:

  • AWS
  • BYOL

Returns:

  • (String)

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

#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)

    The maximum number of SMS-created AMIs to retain.

#role_nameString

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

Returns:

  • (String)

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

#run_onceBoolean

Indicates whether to run the replication job one time.

Returns:

  • (Boolean)

    Indicates whether to run the replication job one time.

#seed_replication_timeTime

The seed replication time.

Returns:

  • (Time)

    The seed replication time.

#server_idString

The ID of the server.

Returns:

  • (String)

    The ID of the server.