Amazonka.SMS.CreateReplicationJob

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).

Creating a Request

data CreateReplicationJob

See: newCreateReplicationJob smart constructor.

Constructors

CreateReplicationJob'

Fields

• description :: Maybe Text

  The description of the replication job.

• encrypted :: Maybe Bool

  Indicates whether the replication job produces encrypted AMIs.

• frequency :: Maybe Int

  The time between consecutive replication runs, in hours.

• kmsKeyId :: Maybe Text

  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.

• licenseType :: Maybe LicenseType

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

• numberOfRecentAmisToKeep :: Maybe Int

  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.

• roleName :: Maybe Text

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

• runOnce :: Maybe Bool

  Indicates whether to run the replication job one time.

• serverId :: Text

  The ID of the server.

• seedReplicationTime :: POSIX

  The seed replication time.

Instances

ToJSON CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

toJSON :: CreateReplicationJob -> Value

toEncoding :: CreateReplicationJob -> Encoding

toJSONList :: [CreateReplicationJob] -> Value

toEncodingList :: [CreateReplicationJob] -> Encoding

ToHeaders CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

toHeaders :: CreateReplicationJob -> [Header]

ToPath CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

toPath :: CreateReplicationJob -> ByteString

ToQuery CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

toQuery :: CreateReplicationJob -> QueryString

AWSRequest CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Associated Types

type AWSResponse CreateReplicationJob

Methods

request :: (Service -> Service) -> CreateReplicationJob -> Request CreateReplicationJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateReplicationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateReplicationJob)))

Generic CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Associated Types

type Rep CreateReplicationJob :: Type -> Type

Methods

from :: CreateReplicationJob -> Rep CreateReplicationJob x

to :: Rep CreateReplicationJob x -> CreateReplicationJob

Read CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

readsPrec :: Int -> ReadS CreateReplicationJob

readList :: ReadS [CreateReplicationJob]

readPrec :: ReadPrec CreateReplicationJob

readListPrec :: ReadPrec [CreateReplicationJob]

Show CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

showsPrec :: Int -> CreateReplicationJob -> ShowS

show :: CreateReplicationJob -> String

showList :: [CreateReplicationJob] -> ShowS

NFData CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

rnf :: CreateReplicationJob -> ()

Eq CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

(==) :: CreateReplicationJob -> CreateReplicationJob -> Bool

(/=) :: CreateReplicationJob -> CreateReplicationJob -> Bool

Hashable CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

Methods

hashWithSalt :: Int -> CreateReplicationJob -> Int

hash :: CreateReplicationJob -> Int

type AWSResponse CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

type AWSResponse CreateReplicationJob = CreateReplicationJobResponse

type Rep CreateReplicationJob

Defined in Amazonka.SMS.CreateReplicationJob

type Rep CreateReplicationJob = D1 ('MetaData "CreateReplicationJob" "Amazonka.SMS.CreateReplicationJob" "amazonka-sms-2.0-4YLznk7UFuE5VtyLFXmW6X" 'False) (C1 ('MetaCons "CreateReplicationJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "frequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "licenseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LicenseType))))) :*: ((S1 ('MetaSel ('Just "numberOfRecentAmisToKeep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "runOnce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "seedReplicationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newCreateReplicationJob

Arguments

:: Text

CreateReplicationJob

-> UTCTime

CreateReplicationJob

-> CreateReplicationJob

Create a value of CreateReplicationJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateReplicationJob, createReplicationJob_description - The description of the replication job.

CreateReplicationJob, createReplicationJob_encrypted - Indicates whether the replication job produces encrypted AMIs.

CreateReplicationJob, createReplicationJob_frequency - The time between consecutive replication runs, in hours.

CreateReplicationJob, createReplicationJob_kmsKeyId - 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.

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

CreateReplicationJob, createReplicationJob_numberOfRecentAmisToKeep - 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.

CreateReplicationJob, createReplicationJob_roleName - The name of the IAM role to be used by the Server Migration Service.

CreateReplicationJob, createReplicationJob_runOnce - Indicates whether to run the replication job one time.

CreateReplicationJob, createReplicationJob_serverId - The ID of the server.

CreateReplicationJob, createReplicationJob_seedReplicationTime - The seed replication time.

Request Lenses

createReplicationJob_description :: Lens' CreateReplicationJob (Maybe Text)

The description of the replication job.

createReplicationJob_encrypted :: Lens' CreateReplicationJob (Maybe Bool)

Indicates whether the replication job produces encrypted AMIs.

createReplicationJob_frequency :: Lens' CreateReplicationJob (Maybe Int)

The time between consecutive replication runs, in hours.

createReplicationJob_kmsKeyId :: Lens' CreateReplicationJob (Maybe Text)

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.

createReplicationJob_licenseType :: Lens' CreateReplicationJob (Maybe LicenseType)

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

createReplicationJob_numberOfRecentAmisToKeep :: Lens' CreateReplicationJob (Maybe Int)

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.

createReplicationJob_roleName :: Lens' CreateReplicationJob (Maybe Text)

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

createReplicationJob_runOnce :: Lens' CreateReplicationJob (Maybe Bool)

Indicates whether to run the replication job one time.

createReplicationJob_serverId :: Lens' CreateReplicationJob Text

The ID of the server.

createReplicationJob_seedReplicationTime :: Lens' CreateReplicationJob UTCTime

The seed replication time.

Destructuring the Response

data CreateReplicationJobResponse

See: newCreateReplicationJobResponse smart constructor.

Constructors

CreateReplicationJobResponse'

Fields

• replicationJobId :: Maybe Text

  The unique identifier of the replication job.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateReplicationJobResponse

Defined in Amazonka.SMS.CreateReplicationJob

Associated Types

type Rep CreateReplicationJobResponse :: Type -> Type

Methods

from :: CreateReplicationJobResponse -> Rep CreateReplicationJobResponse x

to :: Rep CreateReplicationJobResponse x -> CreateReplicationJobResponse

Read CreateReplicationJobResponse

Defined in Amazonka.SMS.CreateReplicationJob

Methods

readsPrec :: Int -> ReadS CreateReplicationJobResponse

readList :: ReadS [CreateReplicationJobResponse]

readPrec :: ReadPrec CreateReplicationJobResponse

readListPrec :: ReadPrec [CreateReplicationJobResponse]

Show CreateReplicationJobResponse

Defined in Amazonka.SMS.CreateReplicationJob

Methods

showsPrec :: Int -> CreateReplicationJobResponse -> ShowS

show :: CreateReplicationJobResponse -> String

showList :: [CreateReplicationJobResponse] -> ShowS

NFData CreateReplicationJobResponse

Defined in Amazonka.SMS.CreateReplicationJob

Methods

rnf :: CreateReplicationJobResponse -> ()

Eq CreateReplicationJobResponse

Defined in Amazonka.SMS.CreateReplicationJob

Methods

(==) :: CreateReplicationJobResponse -> CreateReplicationJobResponse -> Bool

(/=) :: CreateReplicationJobResponse -> CreateReplicationJobResponse -> Bool

type Rep CreateReplicationJobResponse

Defined in Amazonka.SMS.CreateReplicationJob

type Rep CreateReplicationJobResponse = D1 ('MetaData "CreateReplicationJobResponse" "Amazonka.SMS.CreateReplicationJob" "amazonka-sms-2.0-4YLznk7UFuE5VtyLFXmW6X" 'False) (C1 ('MetaCons "CreateReplicationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateReplicationJobResponse

Arguments

:: Int

$sel:httpStatus:CreateReplicationJobResponse'

-> CreateReplicationJobResponse

Create a value of CreateReplicationJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateReplicationJobResponse, createReplicationJobResponse_replicationJobId - The unique identifier of the replication job.

$sel:httpStatus:CreateReplicationJobResponse', createReplicationJobResponse_httpStatus - The response's http status code.

Response Lenses

createReplicationJobResponse_replicationJobId :: Lens' CreateReplicationJobResponse (Maybe Text)

The unique identifier of the replication job.

createReplicationJobResponse_httpStatus :: Lens' CreateReplicationJobResponse Int

The response's http status code.