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.Types.ReplicationJob
Description
Synopsis
- data ReplicationJob = ReplicationJob' {
- frequency :: Maybe Int
- numberOfRecentAmisToKeep :: Maybe Int
- state :: Maybe ReplicationJobState
- serverType :: Maybe ServerType
- serverId :: Maybe Text
- licenseType :: Maybe LicenseType
- roleName :: Maybe Text
- vmServer :: Maybe VmServer
- encrypted :: Maybe Bool
- replicationJobId :: Maybe Text
- replicationRunList :: Maybe [ReplicationRun]
- nextReplicationRunStartTime :: Maybe POSIX
- statusMessage :: Maybe Text
- kmsKeyId :: Maybe Text
- latestAmiId :: Maybe Text
- seedReplicationTime :: Maybe POSIX
- runOnce :: Maybe Bool
- description :: Maybe Text
- newReplicationJob :: ReplicationJob
- replicationJob_frequency :: Lens' ReplicationJob (Maybe Int)
- replicationJob_numberOfRecentAmisToKeep :: Lens' ReplicationJob (Maybe Int)
- replicationJob_state :: Lens' ReplicationJob (Maybe ReplicationJobState)
- replicationJob_serverType :: Lens' ReplicationJob (Maybe ServerType)
- replicationJob_serverId :: Lens' ReplicationJob (Maybe Text)
- replicationJob_licenseType :: Lens' ReplicationJob (Maybe LicenseType)
- replicationJob_roleName :: Lens' ReplicationJob (Maybe Text)
- replicationJob_vmServer :: Lens' ReplicationJob (Maybe VmServer)
- replicationJob_encrypted :: Lens' ReplicationJob (Maybe Bool)
- replicationJob_replicationJobId :: Lens' ReplicationJob (Maybe Text)
- replicationJob_replicationRunList :: Lens' ReplicationJob (Maybe [ReplicationRun])
- replicationJob_nextReplicationRunStartTime :: Lens' ReplicationJob (Maybe UTCTime)
- replicationJob_statusMessage :: Lens' ReplicationJob (Maybe Text)
- replicationJob_kmsKeyId :: Lens' ReplicationJob (Maybe Text)
- replicationJob_latestAmiId :: Lens' ReplicationJob (Maybe Text)
- replicationJob_seedReplicationTime :: Lens' ReplicationJob (Maybe UTCTime)
- replicationJob_runOnce :: Lens' ReplicationJob (Maybe Bool)
- replicationJob_description :: Lens' ReplicationJob (Maybe Text)
Documentation
data ReplicationJob Source #
Represents a replication job.
See: newReplicationJob
smart constructor.
Constructors
ReplicationJob' | |
Fields
|
Instances
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:
$sel:frequency:ReplicationJob'
, replicationJob_frequency
- The time between consecutive replication runs, in hours.
$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:state:ReplicationJob'
, replicationJob_state
- The state of the replication job.
$sel:serverType:ReplicationJob'
, replicationJob_serverType
- The type of server.
$sel:serverId:ReplicationJob'
, replicationJob_serverId
- The ID of the server.
$sel:licenseType:ReplicationJob'
, replicationJob_licenseType
- The license type to be used for the AMI created by a successful
replication run.
$sel:roleName:ReplicationJob'
, replicationJob_roleName
- The name of the IAM role to be used by AWS SMS.
$sel:vmServer:ReplicationJob'
, replicationJob_vmServer
- Information about the VM server.
$sel:encrypted:ReplicationJob'
, replicationJob_encrypted
- Indicates whether the replication job should produce encrypted AMIs.
$sel:replicationJobId:ReplicationJob'
, replicationJob_replicationJobId
- The ID of the replication job.
$sel:replicationRunList:ReplicationJob'
, replicationJob_replicationRunList
- Information about the replication runs.
$sel:nextReplicationRunStartTime:ReplicationJob'
, replicationJob_nextReplicationRunStartTime
- The start time of the next replication run.
$sel:statusMessage:ReplicationJob'
, replicationJob_statusMessage
- The description of the current status of the replication job.
$sel:kmsKeyId: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:seedReplicationTime:ReplicationJob'
, replicationJob_seedReplicationTime
- The seed replication time.
$sel:runOnce:ReplicationJob'
, replicationJob_runOnce
- Indicates whether to run the replication job one time.
$sel:description:ReplicationJob'
, replicationJob_description
- The description of the replication job.
replicationJob_frequency :: Lens' ReplicationJob (Maybe Int) Source #
The time between consecutive replication runs, in hours.
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_state :: Lens' ReplicationJob (Maybe ReplicationJobState) Source #
The state of the replication job.
replicationJob_serverType :: Lens' ReplicationJob (Maybe ServerType) Source #
The type of server.
replicationJob_serverId :: Lens' ReplicationJob (Maybe Text) Source #
The ID of the server.
replicationJob_licenseType :: Lens' ReplicationJob (Maybe LicenseType) Source #
The license type to be used for the AMI created by a successful replication run.
replicationJob_roleName :: Lens' ReplicationJob (Maybe Text) Source #
The name of the IAM role to be used by AWS SMS.
replicationJob_vmServer :: Lens' ReplicationJob (Maybe VmServer) Source #
Information about the VM server.
replicationJob_encrypted :: Lens' ReplicationJob (Maybe Bool) Source #
Indicates whether the replication job should produce encrypted AMIs.
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_nextReplicationRunStartTime :: Lens' ReplicationJob (Maybe UTCTime) Source #
The start time of the next replication run.
replicationJob_statusMessage :: Lens' ReplicationJob (Maybe Text) Source #
The description of the current status of the replication job.
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_seedReplicationTime :: Lens' ReplicationJob (Maybe UTCTime) Source #
The seed replication time.
replicationJob_runOnce :: Lens' ReplicationJob (Maybe Bool) Source #
Indicates whether to run the replication job one time.
replicationJob_description :: Lens' ReplicationJob (Maybe Text) Source #
The description of the replication job.