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.UpdateReplicationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified settings for the specified replication job.

Synopsis

data UpdateReplicationJob = UpdateReplicationJob' {
- frequency :: Maybe Int
- numberOfRecentAmisToKeep :: Maybe Int
- licenseType :: Maybe LicenseType
- roleName :: Maybe Text
- encrypted :: Maybe Bool
- nextReplicationRunStartTime :: Maybe POSIX
- kmsKeyId :: Maybe Text
- description :: Maybe Text
- replicationJobId :: Text
}
newUpdateReplicationJob :: Text -> UpdateReplicationJob
updateReplicationJob_frequency :: Lens' UpdateReplicationJob (Maybe Int)
updateReplicationJob_numberOfRecentAmisToKeep :: Lens' UpdateReplicationJob (Maybe Int)
updateReplicationJob_licenseType :: Lens' UpdateReplicationJob (Maybe LicenseType)
updateReplicationJob_roleName :: Lens' UpdateReplicationJob (Maybe Text)
updateReplicationJob_encrypted :: Lens' UpdateReplicationJob (Maybe Bool)
updateReplicationJob_nextReplicationRunStartTime :: Lens' UpdateReplicationJob (Maybe UTCTime)
updateReplicationJob_kmsKeyId :: Lens' UpdateReplicationJob (Maybe Text)
updateReplicationJob_description :: Lens' UpdateReplicationJob (Maybe Text)
updateReplicationJob_replicationJobId :: Lens' UpdateReplicationJob Text
data UpdateReplicationJobResponse = UpdateReplicationJobResponse' {
- httpStatus :: Int
}
newUpdateReplicationJobResponse :: Int -> UpdateReplicationJobResponse
updateReplicationJobResponse_httpStatus :: Lens' UpdateReplicationJobResponse Int

Creating a Request

data UpdateReplicationJob Source #

See: newUpdateReplicationJob smart constructor.

Constructors

UpdateReplicationJob'

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 AWS SMS.
encrypted :: Maybe Bool
When true, the replication job produces encrypted AMIs. For more information, KmsKeyId.
nextReplicationRunStartTime :: Maybe POSIX
The start time of the next replication run.
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 enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
description :: Maybe Text
The description of the replication job.
replicationJobId :: Text
The ID of the replication job.

Instances

Instances details

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

newUpdateReplicationJob Source #

Arguments

:: Text	`$sel:replicationJobId:UpdateReplicationJob'`
-> UpdateReplicationJob

Create a value of UpdateReplicationJob 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:UpdateReplicationJob', updateReplicationJob_frequency - The time between consecutive replication runs, in hours.

$sel:numberOfRecentAmisToKeep:UpdateReplicationJob', updateReplicationJob_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:UpdateReplicationJob', updateReplicationJob_licenseType - The license type to be used for the AMI created by a successful replication run.

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

$sel:encrypted:UpdateReplicationJob', updateReplicationJob_encrypted - When true, the replication job produces encrypted AMIs. For more information, KmsKeyId.

$sel:nextReplicationRunStartTime:UpdateReplicationJob', updateReplicationJob_nextReplicationRunStartTime - The start time of the next replication run.

$sel:kmsKeyId:UpdateReplicationJob', updateReplicationJob_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 enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

$sel:description:UpdateReplicationJob', updateReplicationJob_description - The description of the replication job.

$sel:replicationJobId:UpdateReplicationJob', updateReplicationJob_replicationJobId - The ID of the replication job.

Request Lenses

updateReplicationJob_frequency :: Lens' UpdateReplicationJob (Maybe Int) Source #

The time between consecutive replication runs, in hours.

updateReplicationJob_numberOfRecentAmisToKeep :: Lens' UpdateReplicationJob (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.

updateReplicationJob_licenseType :: Lens' UpdateReplicationJob (Maybe LicenseType) Source #

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

updateReplicationJob_roleName :: Lens' UpdateReplicationJob (Maybe Text) Source #

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

updateReplicationJob_encrypted :: Lens' UpdateReplicationJob (Maybe Bool) Source #

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

updateReplicationJob_nextReplicationRunStartTime :: Lens' UpdateReplicationJob (Maybe UTCTime) Source #

The start time of the next replication run.

updateReplicationJob_kmsKeyId :: Lens' UpdateReplicationJob (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 enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

updateReplicationJob_description :: Lens' UpdateReplicationJob (Maybe Text) Source #

The description of the replication job.

updateReplicationJob_replicationJobId :: Lens' UpdateReplicationJob Text Source #

The ID of the replication job.

Destructuring the Response

data UpdateReplicationJobResponse Source #

See: newUpdateReplicationJobResponse smart constructor.

Constructors

UpdateReplicationJobResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.UpdateReplicationJob Methods (==) :: UpdateReplicationJobResponse -> UpdateReplicationJobResponse -> Bool # (/=) :: UpdateReplicationJobResponse -> UpdateReplicationJobResponse -> Bool #
Read UpdateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.UpdateReplicationJob Methods readsPrec :: Int -> ReadS UpdateReplicationJobResponse # readList :: ReadS [UpdateReplicationJobResponse] # readPrec :: ReadPrec UpdateReplicationJobResponse # readListPrec :: ReadPrec [UpdateReplicationJobResponse] #
Show UpdateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.UpdateReplicationJob Methods showsPrec :: Int -> UpdateReplicationJobResponse -> ShowS # show :: UpdateReplicationJobResponse -> String # showList :: [UpdateReplicationJobResponse] -> ShowS #
Generic UpdateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.UpdateReplicationJob Associated Types type Rep UpdateReplicationJobResponse :: Type -> Type # Methods from :: UpdateReplicationJobResponse -> Rep UpdateReplicationJobResponse x # to :: Rep UpdateReplicationJobResponse x -> UpdateReplicationJobResponse #
NFData UpdateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.UpdateReplicationJob Methods rnf :: UpdateReplicationJobResponse -> () #
type Rep UpdateReplicationJobResponse Source #
Instance details Defined in Amazonka.SMS.UpdateReplicationJob type Rep UpdateReplicationJobResponse = D1 ('MetaData "UpdateReplicationJobResponse" "Amazonka.SMS.UpdateReplicationJob" "libZSservicesZSamazonka-smsZSamazonka-sms" 'False) (C1 ('MetaCons "UpdateReplicationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateReplicationJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateReplicationJobResponse'`
-> UpdateReplicationJobResponse

Create a value of UpdateReplicationJobResponse 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:httpStatus:UpdateReplicationJobResponse', updateReplicationJobResponse_httpStatus - The response's http status code.

Response Lenses

updateReplicationJobResponse_httpStatus :: Lens' UpdateReplicationJobResponse Int Source #

The response's http status code.