Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SMS.CreateReplicationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data CreateReplicationJob = CreateReplicationJob' {
- frequency :: Maybe Int
- numberOfRecentAmisToKeep :: Maybe Int
- licenseType :: Maybe LicenseType
- roleName :: Maybe Text
- encrypted :: Maybe Bool
- kmsKeyId :: Maybe Text
- runOnce :: Maybe Bool
- description :: Maybe Text
- serverId :: Text
- seedReplicationTime :: POSIX
}
newCreateReplicationJob :: Text -> UTCTime -> CreateReplicationJob
createReplicationJob_frequency :: Lens' CreateReplicationJob (Maybe Int)
createReplicationJob_numberOfRecentAmisToKeep :: Lens' CreateReplicationJob (Maybe Int)
createReplicationJob_licenseType :: Lens' CreateReplicationJob (Maybe LicenseType)
createReplicationJob_roleName :: Lens' CreateReplicationJob (Maybe Text)
createReplicationJob_encrypted :: Lens' CreateReplicationJob (Maybe Bool)
createReplicationJob_kmsKeyId :: Lens' CreateReplicationJob (Maybe Text)
createReplicationJob_runOnce :: Lens' CreateReplicationJob (Maybe Bool)
createReplicationJob_description :: Lens' CreateReplicationJob (Maybe Text)
createReplicationJob_serverId :: Lens' CreateReplicationJob Text
createReplicationJob_seedReplicationTime :: Lens' CreateReplicationJob UTCTime
data CreateReplicationJobResponse = CreateReplicationJobResponse' {
- replicationJobId :: Maybe Text
- httpStatus :: Int
}
newCreateReplicationJobResponse :: Int -> CreateReplicationJobResponse
createReplicationJobResponse_replicationJobId :: Lens' CreateReplicationJobResponse (Maybe Text)
createReplicationJobResponse_httpStatus :: Lens' CreateReplicationJobResponse Int

Creating a Request

data CreateReplicationJob Source #

See: newCreateReplicationJob smart constructor.

Constructors

CreateReplicationJob'

Fields

frequency :: Maybe Int
The time between consecutive replication runs, in hours.
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.
licenseType :: Maybe LicenseType
The license type to be used for the AMI created by a successful replication run.
roleName :: Maybe Text
The name of the IAM role to be used by the AWS SMS.
encrypted :: Maybe Bool
Indicates whether the replication job produces encrypted AMIs.
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.
runOnce :: Maybe Bool
Indicates whether to run the replication job one time.
description :: Maybe Text
The description of the replication job.
serverId :: Text
The ID of the server.
seedReplicationTime :: POSIX
The seed replication time.

Instances

Instances details

Eq CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods (==) :: CreateReplicationJob -> CreateReplicationJob -> Bool # (/=) :: CreateReplicationJob -> CreateReplicationJob -> Bool #
Read CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods readsPrec :: Int -> ReadS CreateReplicationJob # readList :: ReadS [CreateReplicationJob] # readPrec :: ReadPrec CreateReplicationJob # readListPrec :: ReadPrec [CreateReplicationJob] #
Show CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods showsPrec :: Int -> CreateReplicationJob -> ShowS # show :: CreateReplicationJob -> String # showList :: [CreateReplicationJob] -> ShowS #
Generic CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Associated Types type Rep CreateReplicationJob :: Type -> Type # Methods from :: CreateReplicationJob -> Rep CreateReplicationJob x # to :: Rep CreateReplicationJob x -> CreateReplicationJob #
NFData CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods rnf :: CreateReplicationJob -> () #
Hashable CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods hashWithSalt :: Int -> CreateReplicationJob -> Int # hash :: CreateReplicationJob -> Int #
ToJSON CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods toJSON :: CreateReplicationJob -> Value # toEncoding :: CreateReplicationJob -> Encoding # toJSONList :: [CreateReplicationJob] -> Value # toEncodingList :: [CreateReplicationJob] -> Encoding #
AWSRequest CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Associated Types type AWSResponse CreateReplicationJob # Methods request :: CreateReplicationJob -> Request CreateReplicationJob # response :: MonadResource m => Logger -> Service -> Proxy CreateReplicationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateReplicationJob))) #
ToHeaders CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods toHeaders :: CreateReplicationJob -> [Header] #
ToPath CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods toPath :: CreateReplicationJob -> ByteString #
ToQuery CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods toQuery :: CreateReplicationJob -> QueryString #
type Rep CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob type Rep CreateReplicationJob = D1 ('MetaData "CreateReplicationJob" "Amazonka.SMS.CreateReplicationJob" "libZSservicesZSamazonka-smsZSamazonka-sms" 'False) (C1 ('MetaCons "CreateReplicationJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "frequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "numberOfRecentAmisToKeep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "licenseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LicenseType)) :: (S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "runOnce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "seedReplicationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))
type AWSResponse CreateReplicationJob Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob type AWSResponse CreateReplicationJob = CreateReplicationJobResponse

newCreateReplicationJob Source #

Arguments

:: Text	`$sel:serverId:CreateReplicationJob'`
-> UTCTime	`$sel:seedReplicationTime: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:

$sel:frequency:CreateReplicationJob', createReplicationJob_frequency - The time between consecutive replication runs, in hours.

$sel:numberOfRecentAmisToKeep: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.

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

$sel:roleName:CreateReplicationJob', createReplicationJob_roleName - The name of the IAM role to be used by the AWS SMS.

$sel:encrypted:CreateReplicationJob', createReplicationJob_encrypted - Indicates whether the replication job produces encrypted AMIs.

$sel:kmsKeyId: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.

$sel:runOnce:CreateReplicationJob', createReplicationJob_runOnce - Indicates whether to run the replication job one time.

$sel:description:CreateReplicationJob', createReplicationJob_description - The description of the replication job.

$sel:serverId:CreateReplicationJob', createReplicationJob_serverId - The ID of the server.

$sel:seedReplicationTime:CreateReplicationJob', createReplicationJob_seedReplicationTime - The seed replication time.

Request Lenses

createReplicationJob_frequency :: Lens' CreateReplicationJob (Maybe Int) Source #

The time between consecutive replication runs, in hours.

createReplicationJob_numberOfRecentAmisToKeep :: Lens' CreateReplicationJob (Maybe Int) Source #

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_licenseType :: Lens' CreateReplicationJob (Maybe LicenseType) Source #

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

createReplicationJob_roleName :: Lens' CreateReplicationJob (Maybe Text) Source #

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

createReplicationJob_encrypted :: Lens' CreateReplicationJob (Maybe Bool) Source #

Indicates whether the replication job produces encrypted AMIs.

createReplicationJob_kmsKeyId :: Lens' CreateReplicationJob (Maybe Text) Source #

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_runOnce :: Lens' CreateReplicationJob (Maybe Bool) Source #

Indicates whether to run the replication job one time.

createReplicationJob_description :: Lens' CreateReplicationJob (Maybe Text) Source #

The description of the replication job.

createReplicationJob_serverId :: Lens' CreateReplicationJob Text Source #

The ID of the server.

createReplicationJob_seedReplicationTime :: Lens' CreateReplicationJob UTCTime Source #

The seed replication time.

Destructuring the Response

data CreateReplicationJobResponse Source #

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

Instances details

Eq CreateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods (==) :: CreateReplicationJobResponse -> CreateReplicationJobResponse -> Bool # (/=) :: CreateReplicationJobResponse -> CreateReplicationJobResponse -> Bool #
Read CreateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods readsPrec :: Int -> ReadS CreateReplicationJobResponse # readList :: ReadS [CreateReplicationJobResponse] # readPrec :: ReadPrec CreateReplicationJobResponse # readListPrec :: ReadPrec [CreateReplicationJobResponse] #
Show CreateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods showsPrec :: Int -> CreateReplicationJobResponse -> ShowS # show :: CreateReplicationJobResponse -> String # showList :: [CreateReplicationJobResponse] -> ShowS #
Generic CreateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Associated Types type Rep CreateReplicationJobResponse :: Type -> Type # Methods from :: CreateReplicationJobResponse -> Rep CreateReplicationJobResponse x # to :: Rep CreateReplicationJobResponse x -> CreateReplicationJobResponse #
NFData CreateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob Methods rnf :: CreateReplicationJobResponse -> () #
type Rep CreateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.CreateReplicationJob type Rep CreateReplicationJobResponse = D1 ('MetaData "CreateReplicationJobResponse" "Amazonka.SMS.CreateReplicationJob" "libZSservicesZSamazonka-smsZSamazonka-sms" '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 Source #

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:

$sel:replicationJobId: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) Source #

The unique identifier of the replication job.

createReplicationJobResponse_httpStatus :: Lens' CreateReplicationJobResponse Int Source #

The response's http status code.