Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SMS.Types.ReplicationJob

Description

Synopsis

data ReplicationJob = ReplicationJob' {
- description :: Maybe Text
- encrypted :: Maybe Bool
- frequency :: Maybe Int
- kmsKeyId :: Maybe Text
- latestAmiId :: Maybe Text
- licenseType :: Maybe LicenseType
- nextReplicationRunStartTime :: Maybe POSIX
- numberOfRecentAmisToKeep :: Maybe Int
- replicationJobId :: Maybe Text
- replicationRunList :: Maybe [ReplicationRun]
- roleName :: Maybe Text
- runOnce :: Maybe Bool
- seedReplicationTime :: Maybe POSIX
- serverId :: Maybe Text
- serverType :: Maybe ServerType
- state :: Maybe ReplicationJobState
- statusMessage :: Maybe Text
- vmServer :: Maybe VmServer
}
newReplicationJob :: ReplicationJob
replicationJob_description :: Lens' ReplicationJob (Maybe Text)
replicationJob_encrypted :: Lens' ReplicationJob (Maybe Bool)
replicationJob_frequency :: Lens' ReplicationJob (Maybe Int)
replicationJob_kmsKeyId :: Lens' ReplicationJob (Maybe Text)
replicationJob_latestAmiId :: Lens' ReplicationJob (Maybe Text)
replicationJob_licenseType :: Lens' ReplicationJob (Maybe LicenseType)
replicationJob_nextReplicationRunStartTime :: Lens' ReplicationJob (Maybe UTCTime)
replicationJob_numberOfRecentAmisToKeep :: Lens' ReplicationJob (Maybe Int)
replicationJob_replicationJobId :: Lens' ReplicationJob (Maybe Text)
replicationJob_replicationRunList :: Lens' ReplicationJob (Maybe [ReplicationRun])
replicationJob_roleName :: Lens' ReplicationJob (Maybe Text)
replicationJob_runOnce :: Lens' ReplicationJob (Maybe Bool)
replicationJob_seedReplicationTime :: Lens' ReplicationJob (Maybe UTCTime)
replicationJob_serverId :: Lens' ReplicationJob (Maybe Text)
replicationJob_serverType :: Lens' ReplicationJob (Maybe ServerType)
replicationJob_state :: Lens' ReplicationJob (Maybe ReplicationJobState)
replicationJob_statusMessage :: Lens' ReplicationJob (Maybe Text)
replicationJob_vmServer :: Lens' ReplicationJob (Maybe VmServer)

Documentation

data ReplicationJob Source #

Represents a replication job.

See: newReplicationJob smart constructor.

Constructors

ReplicationJob'

Fields

description :: Maybe Text
The description of the replication job.
encrypted :: Maybe Bool
Indicates whether the replication job should produce 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 enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
latestAmiId :: Maybe Text
The ID of the latest Amazon Machine Image (AMI).
licenseType :: Maybe LicenseType
The license type to be used for the AMI created by a successful replication run.
nextReplicationRunStartTime :: Maybe POSIX
The start time of the next replication run.
numberOfRecentAmisToKeep :: Maybe Int
The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.
replicationJobId :: Maybe Text
The ID of the replication job.
replicationRunList :: Maybe [ReplicationRun]
Information about the replication runs.
roleName :: Maybe Text
The name of the IAM role to be used by Server Migration Service.
runOnce :: Maybe Bool
Indicates whether to run the replication job one time.
seedReplicationTime :: Maybe POSIX
The seed replication time.
serverId :: Maybe Text
The ID of the server.
serverType :: Maybe ServerType
The type of server.
state :: Maybe ReplicationJobState
The state of the replication job.
statusMessage :: Maybe Text
The description of the current status of the replication job.
vmServer :: Maybe VmServer
Information about the VM server.

Instances

Instances details

FromJSON ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob Methods parseJSON :: Value -> Parser ReplicationJob # parseJSONList :: Value -> Parser [ReplicationJob] #
Generic ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob Associated Types type Rep ReplicationJob :: Type -> Type # Methods from :: ReplicationJob -> Rep ReplicationJob x # to :: Rep ReplicationJob x -> ReplicationJob #
Read ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob Methods readsPrec :: Int -> ReadS ReplicationJob # readList :: ReadS [ReplicationJob] # readPrec :: ReadPrec ReplicationJob # readListPrec :: ReadPrec [ReplicationJob] #
Show ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob Methods showsPrec :: Int -> ReplicationJob -> ShowS # show :: ReplicationJob -> String # showList :: [ReplicationJob] -> ShowS #
NFData ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob Methods rnf :: ReplicationJob -> () #
Eq ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob Methods (==) :: ReplicationJob -> ReplicationJob -> Bool # (/=) :: ReplicationJob -> ReplicationJob -> Bool #
Hashable ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob Methods hashWithSalt :: Int -> ReplicationJob -> Int # hash :: ReplicationJob -> Int #
type Rep ReplicationJob Source #
Instance details Defined in Amazonka.SMS.Types.ReplicationJob type Rep ReplicationJob = D1 ('MetaData "ReplicationJob" "Amazonka.SMS.Types.ReplicationJob" "amazonka-sms-2.0-4YLznk7UFuE5VtyLFXmW6X" 'False) (C1 ('MetaCons "ReplicationJob'" '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 "latestAmiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "licenseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LicenseType))) :: (S1 ('MetaSel ('Just "nextReplicationRunStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "numberOfRecentAmisToKeep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "replicationJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "replicationRunList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationRun])) :: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "runOnce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "seedReplicationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serverType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerType))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationJobState)) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vmServer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VmServer))))))))

newReplicationJob :: ReplicationJob Source #

Create a value of ReplicationJob 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:

ReplicationJob, replicationJob_description - The description of the replication job.

ReplicationJob, replicationJob_encrypted - Indicates whether the replication job should produce encrypted AMIs.

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

ReplicationJob, replicationJob_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:latestAmiId:ReplicationJob', replicationJob_latestAmiId - The ID of the latest Amazon Machine Image (AMI).

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

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

$sel:numberOfRecentAmisToKeep:ReplicationJob', replicationJob_numberOfRecentAmisToKeep - The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

$sel:replicationJobId:ReplicationJob', replicationJob_replicationJobId - The ID of the replication job.

$sel:replicationRunList:ReplicationJob', replicationJob_replicationRunList - Information about the replication runs.

$sel:roleName:ReplicationJob', replicationJob_roleName - The name of the IAM role to be used by Server Migration Service.

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

$sel:seedReplicationTime:ReplicationJob', replicationJob_seedReplicationTime - The seed replication time.

$sel:serverId:ReplicationJob', replicationJob_serverId - The ID of the server.

$sel:serverType:ReplicationJob', replicationJob_serverType - The type of server.

ReplicationJob, replicationJob_state - The state of the replication job.

ReplicationJob, replicationJob_statusMessage - The description of the current status of the replication job.

$sel:vmServer:ReplicationJob', replicationJob_vmServer - Information about the VM server.

replicationJob_description :: Lens' ReplicationJob (Maybe Text) Source #

The description of the replication job.

replicationJob_encrypted :: Lens' ReplicationJob (Maybe Bool) Source #

Indicates whether the replication job should produce encrypted AMIs.

replicationJob_frequency :: Lens' ReplicationJob (Maybe Int) Source #

The time between consecutive replication runs, in hours.

replicationJob_kmsKeyId :: Lens' ReplicationJob (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.

replicationJob_latestAmiId :: Lens' ReplicationJob (Maybe Text) Source #

The ID of the latest Amazon Machine Image (AMI).

replicationJob_licenseType :: Lens' ReplicationJob (Maybe LicenseType) Source #

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

replicationJob_nextReplicationRunStartTime :: Lens' ReplicationJob (Maybe UTCTime) Source #

The start time of the next replication run.

replicationJob_numberOfRecentAmisToKeep :: Lens' ReplicationJob (Maybe Int) Source #

The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

replicationJob_replicationJobId :: Lens' ReplicationJob (Maybe Text) Source #

The ID of the replication job.

replicationJob_replicationRunList :: Lens' ReplicationJob (Maybe [ReplicationRun]) Source #

Information about the replication runs.

replicationJob_roleName :: Lens' ReplicationJob (Maybe Text) Source #

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

replicationJob_runOnce :: Lens' ReplicationJob (Maybe Bool) Source #

Indicates whether to run the replication job one time.

replicationJob_seedReplicationTime :: Lens' ReplicationJob (Maybe UTCTime) Source #

The seed replication time.

replicationJob_serverId :: Lens' ReplicationJob (Maybe Text) Source #

The ID of the server.