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 |
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype GatewayType where
- GatewayType' { }
- pattern GatewayType_BACKUP_VM :: GatewayType
- newtype HypervisorState where
- HypervisorState' { }
- pattern HypervisorState_ERROR :: HypervisorState
- pattern HypervisorState_OFFLINE :: HypervisorState
- pattern HypervisorState_ONLINE :: HypervisorState
- pattern HypervisorState_PENDING :: HypervisorState
- newtype SyncMetadataStatus where
- SyncMetadataStatus' { }
- pattern SyncMetadataStatus_CREATED :: SyncMetadataStatus
- pattern SyncMetadataStatus_FAILED :: SyncMetadataStatus
- pattern SyncMetadataStatus_PARTIALLY_FAILED :: SyncMetadataStatus
- pattern SyncMetadataStatus_RUNNING :: SyncMetadataStatus
- pattern SyncMetadataStatus_SUCCEEDED :: SyncMetadataStatus
- data BandwidthRateLimitInterval = BandwidthRateLimitInterval' {}
- newBandwidthRateLimitInterval :: NonEmpty Natural -> Natural -> Natural -> Natural -> Natural -> BandwidthRateLimitInterval
- bandwidthRateLimitInterval_averageUploadRateLimitInBitsPerSec :: Lens' BandwidthRateLimitInterval (Maybe Natural)
- bandwidthRateLimitInterval_daysOfWeek :: Lens' BandwidthRateLimitInterval (NonEmpty Natural)
- bandwidthRateLimitInterval_endHourOfDay :: Lens' BandwidthRateLimitInterval Natural
- bandwidthRateLimitInterval_endMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural
- bandwidthRateLimitInterval_startHourOfDay :: Lens' BandwidthRateLimitInterval Natural
- bandwidthRateLimitInterval_startMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural
- data Gateway = Gateway' {}
- newGateway :: Gateway
- gateway_gatewayArn :: Lens' Gateway (Maybe Text)
- gateway_gatewayDisplayName :: Lens' Gateway (Maybe Text)
- gateway_gatewayType :: Lens' Gateway (Maybe GatewayType)
- gateway_hypervisorId :: Lens' Gateway (Maybe Text)
- gateway_lastSeenTime :: Lens' Gateway (Maybe UTCTime)
- data GatewayDetails = GatewayDetails' {}
- newGatewayDetails :: GatewayDetails
- gatewayDetails_gatewayArn :: Lens' GatewayDetails (Maybe Text)
- gatewayDetails_gatewayDisplayName :: Lens' GatewayDetails (Maybe Text)
- gatewayDetails_gatewayType :: Lens' GatewayDetails (Maybe GatewayType)
- gatewayDetails_hypervisorId :: Lens' GatewayDetails (Maybe Text)
- gatewayDetails_lastSeenTime :: Lens' GatewayDetails (Maybe UTCTime)
- gatewayDetails_maintenanceStartTime :: Lens' GatewayDetails (Maybe MaintenanceStartTime)
- gatewayDetails_nextUpdateAvailabilityTime :: Lens' GatewayDetails (Maybe UTCTime)
- gatewayDetails_vpcEndpoint :: Lens' GatewayDetails (Maybe Text)
- data Hypervisor = Hypervisor' {}
- newHypervisor :: Hypervisor
- hypervisor_host :: Lens' Hypervisor (Maybe Text)
- hypervisor_hypervisorArn :: Lens' Hypervisor (Maybe Text)
- hypervisor_kmsKeyArn :: Lens' Hypervisor (Maybe Text)
- hypervisor_name :: Lens' Hypervisor (Maybe Text)
- hypervisor_state :: Lens' Hypervisor (Maybe HypervisorState)
- data HypervisorDetails = HypervisorDetails' {}
- newHypervisorDetails :: HypervisorDetails
- hypervisorDetails_host :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_hypervisorArn :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_kmsKeyArn :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_lastSuccessfulMetadataSyncTime :: Lens' HypervisorDetails (Maybe UTCTime)
- hypervisorDetails_latestMetadataSyncStatus :: Lens' HypervisorDetails (Maybe SyncMetadataStatus)
- hypervisorDetails_latestMetadataSyncStatusMessage :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_logGroupArn :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_name :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_state :: Lens' HypervisorDetails (Maybe HypervisorState)
- data MaintenanceStartTime = MaintenanceStartTime' {}
- newMaintenanceStartTime :: Natural -> Natural -> MaintenanceStartTime
- maintenanceStartTime_dayOfMonth :: Lens' MaintenanceStartTime (Maybe Natural)
- maintenanceStartTime_dayOfWeek :: Lens' MaintenanceStartTime (Maybe Natural)
- maintenanceStartTime_hourOfDay :: Lens' MaintenanceStartTime Natural
- maintenanceStartTime_minuteOfHour :: Lens' MaintenanceStartTime Natural
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data VirtualMachine = VirtualMachine' {}
- newVirtualMachine :: VirtualMachine
- virtualMachine_hostName :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_hypervisorId :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_lastBackupDate :: Lens' VirtualMachine (Maybe UTCTime)
- virtualMachine_name :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_path :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_resourceArn :: Lens' VirtualMachine (Maybe Text)
- data VirtualMachineDetails = VirtualMachineDetails' {}
- newVirtualMachineDetails :: VirtualMachineDetails
- virtualMachineDetails_hostName :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_hypervisorId :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_lastBackupDate :: Lens' VirtualMachineDetails (Maybe UTCTime)
- virtualMachineDetails_name :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_path :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_resourceArn :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_vmwareTags :: Lens' VirtualMachineDetails (Maybe [VmwareTag])
- data VmwareTag = VmwareTag' {}
- newVmwareTag :: VmwareTag
- vmwareTag_vmwareCategory :: Lens' VmwareTag (Maybe Text)
- vmwareTag_vmwareTagDescription :: Lens' VmwareTag (Maybe Text)
- vmwareTag_vmwareTagName :: Lens' VmwareTag (Maybe Text)
- data VmwareToAwsTagMapping = VmwareToAwsTagMapping' {
- awsTagKey :: Text
- awsTagValue :: Text
- vmwareCategory :: Text
- vmwareTagName :: Text
- newVmwareToAwsTagMapping :: Text -> Text -> Text -> Text -> VmwareToAwsTagMapping
- vmwareToAwsTagMapping_awsTagKey :: Lens' VmwareToAwsTagMapping Text
- vmwareToAwsTagMapping_awsTagValue :: Lens' VmwareToAwsTagMapping Text
- vmwareToAwsTagMapping_vmwareCategory :: Lens' VmwareToAwsTagMapping Text
- vmwareToAwsTagMapping_vmwareTagName :: Lens' VmwareToAwsTagMapping Text
Service Configuration
defaultService :: Service Source #
API version 2021-01-01
of the Amazon Backup Gateway SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The operation cannot proceed because you have insufficient permissions.
_ConflictException :: AsError a => Fold a ServiceError Source #
The operation cannot proceed because it is not supported.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The operation did not succeed because an internal error occurred. Try again later.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource that is required for the action wasn't found.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
TPS has been limited to protect against intentional or unintentional high request volumes.
_ValidationException :: AsError a => Fold a ServiceError Source #
The operation did not succeed because a validation error occurred.
GatewayType
newtype GatewayType Source #
pattern GatewayType_BACKUP_VM :: GatewayType |
Instances
HypervisorState
newtype HypervisorState Source #
pattern HypervisorState_ERROR :: HypervisorState | |
pattern HypervisorState_OFFLINE :: HypervisorState | |
pattern HypervisorState_ONLINE :: HypervisorState | |
pattern HypervisorState_PENDING :: HypervisorState |
Instances
SyncMetadataStatus
newtype SyncMetadataStatus Source #
pattern SyncMetadataStatus_CREATED :: SyncMetadataStatus | |
pattern SyncMetadataStatus_FAILED :: SyncMetadataStatus | |
pattern SyncMetadataStatus_PARTIALLY_FAILED :: SyncMetadataStatus | |
pattern SyncMetadataStatus_RUNNING :: SyncMetadataStatus | |
pattern SyncMetadataStatus_SUCCEEDED :: SyncMetadataStatus |
Instances
BandwidthRateLimitInterval
data BandwidthRateLimitInterval Source #
Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
See: newBandwidthRateLimitInterval
smart constructor.
BandwidthRateLimitInterval' | |
|
Instances
newBandwidthRateLimitInterval Source #
Create a value of BandwidthRateLimitInterval
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:averageUploadRateLimitInBitsPerSec:BandwidthRateLimitInterval'
, bandwidthRateLimitInterval_averageUploadRateLimitInBitsPerSec
- The average upload rate limit component of the bandwidth rate limit
interval, in bits per second. This field does not appear in the response
if the upload rate limit is not set.
For Backup Gateway, the minimum value is (Value)
.
$sel:daysOfWeek:BandwidthRateLimitInterval'
, bandwidthRateLimitInterval_daysOfWeek
- The days of the week component of the bandwidth rate limit interval,
represented as ordinal numbers from 0 to 6, where 0 represents Sunday
and 6 represents Saturday.
$sel:endHourOfDay:BandwidthRateLimitInterval'
, bandwidthRateLimitInterval_endHourOfDay
- The hour of the day to end the bandwidth rate limit interval.
$sel:endMinuteOfHour:BandwidthRateLimitInterval'
, bandwidthRateLimitInterval_endMinuteOfHour
- The minute of the hour to end the bandwidth rate limit interval.
The bandwidth rate limit interval ends at the end of the minute. To end
an interval at the end of an hour, use the value 59
.
$sel:startHourOfDay:BandwidthRateLimitInterval'
, bandwidthRateLimitInterval_startHourOfDay
- The hour of the day to start the bandwidth rate limit interval.
$sel:startMinuteOfHour:BandwidthRateLimitInterval'
, bandwidthRateLimitInterval_startMinuteOfHour
- The minute of the hour to start the bandwidth rate limit interval. The
interval begins at the start of that minute. To begin an interval
exactly at the start of the hour, use the value 0
.
bandwidthRateLimitInterval_averageUploadRateLimitInBitsPerSec :: Lens' BandwidthRateLimitInterval (Maybe Natural) Source #
The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
For Backup Gateway, the minimum value is (Value)
.
bandwidthRateLimitInterval_daysOfWeek :: Lens' BandwidthRateLimitInterval (NonEmpty Natural) Source #
The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
bandwidthRateLimitInterval_endHourOfDay :: Lens' BandwidthRateLimitInterval Natural Source #
The hour of the day to end the bandwidth rate limit interval.
bandwidthRateLimitInterval_endMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural Source #
The minute of the hour to end the bandwidth rate limit interval.
The bandwidth rate limit interval ends at the end of the minute. To end
an interval at the end of an hour, use the value 59
.
bandwidthRateLimitInterval_startHourOfDay :: Lens' BandwidthRateLimitInterval Natural Source #
The hour of the day to start the bandwidth rate limit interval.
bandwidthRateLimitInterval_startMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural Source #
The minute of the hour to start the bandwidth rate limit interval. The
interval begins at the start of that minute. To begin an interval
exactly at the start of the hour, use the value 0
.
Gateway
A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.
See: newGateway
smart constructor.
Gateway' | |
|
Instances
newGateway :: Gateway Source #
Create a value of Gateway
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:gatewayArn:Gateway'
, gateway_gatewayArn
- The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Amazon Web
Services Region.
$sel:gatewayDisplayName:Gateway'
, gateway_gatewayDisplayName
- The display name of the gateway.
$sel:gatewayType:Gateway'
, gateway_gatewayType
- The type of the gateway.
$sel:hypervisorId:Gateway'
, gateway_hypervisorId
- The hypervisor ID of the gateway.
$sel:lastSeenTime:Gateway'
, gateway_lastSeenTime
- The last time Backup gateway communicated with the gateway, in Unix
format and UTC time.
gateway_gatewayArn :: Lens' Gateway (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Amazon Web
Services Region.
gateway_gatewayType :: Lens' Gateway (Maybe GatewayType) Source #
The type of the gateway.
gateway_lastSeenTime :: Lens' Gateway (Maybe UTCTime) Source #
The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
GatewayDetails
data GatewayDetails Source #
The details of gateway.
See: newGatewayDetails
smart constructor.
GatewayDetails' | |
|
Instances
newGatewayDetails :: GatewayDetails Source #
Create a value of GatewayDetails
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:gatewayArn:GatewayDetails'
, gatewayDetails_gatewayArn
- The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Amazon Web
Services Region.
$sel:gatewayDisplayName:GatewayDetails'
, gatewayDetails_gatewayDisplayName
- The display name of the gateway.
$sel:gatewayType:GatewayDetails'
, gatewayDetails_gatewayType
- The type of the gateway type.
$sel:hypervisorId:GatewayDetails'
, gatewayDetails_hypervisorId
- The hypervisor ID of the gateway.
$sel:lastSeenTime:GatewayDetails'
, gatewayDetails_lastSeenTime
- Details showing the last time Backup gateway communicated with the
cloud, in Unix format and UTC time.
$sel:maintenanceStartTime:GatewayDetails'
, gatewayDetails_maintenanceStartTime
- Returns your gateway's weekly maintenance start time including the day
and time of the week. Note that values are in terms of the gateway's
time zone. Can be weekly or monthly.
$sel:nextUpdateAvailabilityTime:GatewayDetails'
, gatewayDetails_nextUpdateAvailabilityTime
- Details showing the next update availability time of the gateway.
$sel:vpcEndpoint:GatewayDetails'
, gatewayDetails_vpcEndpoint
- The DNS name for the virtual private cloud (VPC) endpoint the gateway
uses to connect to the cloud for backup gateway.
gatewayDetails_gatewayArn :: Lens' GatewayDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Amazon Web
Services Region.
gatewayDetails_gatewayDisplayName :: Lens' GatewayDetails (Maybe Text) Source #
The display name of the gateway.
gatewayDetails_gatewayType :: Lens' GatewayDetails (Maybe GatewayType) Source #
The type of the gateway type.
gatewayDetails_hypervisorId :: Lens' GatewayDetails (Maybe Text) Source #
The hypervisor ID of the gateway.
gatewayDetails_lastSeenTime :: Lens' GatewayDetails (Maybe UTCTime) Source #
Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.
gatewayDetails_maintenanceStartTime :: Lens' GatewayDetails (Maybe MaintenanceStartTime) Source #
Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
gatewayDetails_nextUpdateAvailabilityTime :: Lens' GatewayDetails (Maybe UTCTime) Source #
Details showing the next update availability time of the gateway.
gatewayDetails_vpcEndpoint :: Lens' GatewayDetails (Maybe Text) Source #
The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.
Hypervisor
data Hypervisor Source #
Represents the hypervisor's permissions to which the gateway will connect.
A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
See: newHypervisor
smart constructor.
Hypervisor' | |
|
Instances
newHypervisor :: Hypervisor Source #
Create a value of Hypervisor
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:host:Hypervisor'
, hypervisor_host
- The server host of the hypervisor. This can be either an IP address or a
fully-qualified domain name (FQDN).
$sel:hypervisorArn:Hypervisor'
, hypervisor_hypervisorArn
- The Amazon Resource Name (ARN) of the hypervisor.
$sel:kmsKeyArn:Hypervisor'
, hypervisor_kmsKeyArn
- The Amazon Resource Name (ARN) of the Key Management Service used to
encrypt the hypervisor.
$sel:name:Hypervisor'
, hypervisor_name
- The name of the hypervisor.
$sel:state:Hypervisor'
, hypervisor_state
- The state of the hypervisor.
hypervisor_host :: Lens' Hypervisor (Maybe Text) Source #
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
hypervisor_hypervisorArn :: Lens' Hypervisor (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor.
hypervisor_kmsKeyArn :: Lens' Hypervisor (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.
hypervisor_name :: Lens' Hypervisor (Maybe Text) Source #
The name of the hypervisor.
hypervisor_state :: Lens' Hypervisor (Maybe HypervisorState) Source #
The state of the hypervisor.
HypervisorDetails
data HypervisorDetails Source #
These are the details of the specified hypervisor. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
See: newHypervisorDetails
smart constructor.
HypervisorDetails' | |
|
Instances
newHypervisorDetails :: HypervisorDetails Source #
Create a value of HypervisorDetails
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:host:HypervisorDetails'
, hypervisorDetails_host
- The server host of the hypervisor. This can be either an IP address or a
fully-qualified domain name (FQDN).
$sel:hypervisorArn:HypervisorDetails'
, hypervisorDetails_hypervisorArn
- The Amazon Resource Name (ARN) of the hypervisor.
$sel:kmsKeyArn:HypervisorDetails'
, hypervisorDetails_kmsKeyArn
- The Amazon Resource Name (ARN) of the KMS used to encrypt the
hypervisor.
$sel:lastSuccessfulMetadataSyncTime:HypervisorDetails'
, hypervisorDetails_lastSuccessfulMetadataSyncTime
- This is the time when the most recent successful sync of metadata
occurred.
$sel:latestMetadataSyncStatus:HypervisorDetails'
, hypervisorDetails_latestMetadataSyncStatus
- This is the most recent status for the indicated metadata sync.
$sel:latestMetadataSyncStatusMessage:HypervisorDetails'
, hypervisorDetails_latestMetadataSyncStatusMessage
- This is the most recent status for the indicated metadata sync.
$sel:logGroupArn:HypervisorDetails'
, hypervisorDetails_logGroupArn
- The Amazon Resource Name (ARN) of the group of gateways within the
requested log.
$sel:name:HypervisorDetails'
, hypervisorDetails_name
- This is the name of the specified hypervisor.
$sel:state:HypervisorDetails'
, hypervisorDetails_state
- This is the current state of the specified hypervisor.
The possible states are PENDING
, ONLINE
, OFFLINE
, or ERROR
.
hypervisorDetails_host :: Lens' HypervisorDetails (Maybe Text) Source #
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
hypervisorDetails_hypervisorArn :: Lens' HypervisorDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor.
hypervisorDetails_kmsKeyArn :: Lens' HypervisorDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.
hypervisorDetails_lastSuccessfulMetadataSyncTime :: Lens' HypervisorDetails (Maybe UTCTime) Source #
This is the time when the most recent successful sync of metadata occurred.
hypervisorDetails_latestMetadataSyncStatus :: Lens' HypervisorDetails (Maybe SyncMetadataStatus) Source #
This is the most recent status for the indicated metadata sync.
hypervisorDetails_latestMetadataSyncStatusMessage :: Lens' HypervisorDetails (Maybe Text) Source #
This is the most recent status for the indicated metadata sync.
hypervisorDetails_logGroupArn :: Lens' HypervisorDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
hypervisorDetails_name :: Lens' HypervisorDetails (Maybe Text) Source #
This is the name of the specified hypervisor.
hypervisorDetails_state :: Lens' HypervisorDetails (Maybe HypervisorState) Source #
This is the current state of the specified hypervisor.
The possible states are PENDING
, ONLINE
, OFFLINE
, or ERROR
.
MaintenanceStartTime
data MaintenanceStartTime Source #
This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
See: newMaintenanceStartTime
smart constructor.
MaintenanceStartTime' | |
|
Instances
newMaintenanceStartTime Source #
:: Natural | |
-> Natural | |
-> MaintenanceStartTime |
Create a value of MaintenanceStartTime
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:dayOfMonth:MaintenanceStartTime'
, maintenanceStartTime_dayOfMonth
- The day of the month component of the maintenance start time represented
as an ordinal number from 1 to 28, where 1 represents the first day of
the month and 28 represents the last day of the month.
$sel:dayOfWeek:MaintenanceStartTime'
, maintenanceStartTime_dayOfWeek
- An ordinal number between 0 and 6 that represents the day of the week,
where 0 represents Sunday and 6 represents Saturday. The day of week is
in the time zone of the gateway.
$sel:hourOfDay:MaintenanceStartTime'
, maintenanceStartTime_hourOfDay
- The hour component of the maintenance start time represented as hh,
where hh is the hour (0 to 23). The hour of the day is in the time
zone of the gateway.
$sel:minuteOfHour:MaintenanceStartTime'
, maintenanceStartTime_minuteOfHour
- The minute component of the maintenance start time represented as mm,
where mm is the minute (0 to 59). The minute of the hour is in the
time zone of the gateway.
maintenanceStartTime_dayOfMonth :: Lens' MaintenanceStartTime (Maybe Natural) Source #
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
maintenanceStartTime_dayOfWeek :: Lens' MaintenanceStartTime (Maybe Natural) Source #
An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
maintenanceStartTime_hourOfDay :: Lens' MaintenanceStartTime Natural Source #
The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
maintenanceStartTime_minuteOfHour :: Lens' MaintenanceStartTime Natural Source #
The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
Tag
A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.BackupGateway.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.BackupGateway.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.BackupGateway.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.BackupGateway.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.BackupGateway.Types.Tag" "amazonka-backup-gateway-2.0-Ee3gVOmXMeV2r3uv4sRO9" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
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:key:Tag'
, tag_key
- The key part of a tag's key-value pair. The key can't start with
aws:
.
$sel:value:Tag'
, tag_value
- The value part of a tag's key-value pair.
tag_key :: Lens' Tag Text Source #
The key part of a tag's key-value pair. The key can't start with
aws:
.
VirtualMachine
data VirtualMachine Source #
A virtual machine that is on a hypervisor.
See: newVirtualMachine
smart constructor.
VirtualMachine' | |
|
Instances
newVirtualMachine :: VirtualMachine Source #
Create a value of VirtualMachine
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:hostName:VirtualMachine'
, virtualMachine_hostName
- The host name of the virtual machine.
$sel:hypervisorId:VirtualMachine'
, virtualMachine_hypervisorId
- The ID of the virtual machine's hypervisor.
$sel:lastBackupDate:VirtualMachine'
, virtualMachine_lastBackupDate
- The most recent date a virtual machine was backed up, in Unix format and
UTC time.
$sel:name:VirtualMachine'
, virtualMachine_name
- The name of the virtual machine.
$sel:path:VirtualMachine'
, virtualMachine_path
- The path of the virtual machine.
$sel:resourceArn:VirtualMachine'
, virtualMachine_resourceArn
- The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
virtualMachine_hostName :: Lens' VirtualMachine (Maybe Text) Source #
The host name of the virtual machine.
virtualMachine_hypervisorId :: Lens' VirtualMachine (Maybe Text) Source #
The ID of the virtual machine's hypervisor.
virtualMachine_lastBackupDate :: Lens' VirtualMachine (Maybe UTCTime) Source #
The most recent date a virtual machine was backed up, in Unix format and UTC time.
virtualMachine_name :: Lens' VirtualMachine (Maybe Text) Source #
The name of the virtual machine.
virtualMachine_path :: Lens' VirtualMachine (Maybe Text) Source #
The path of the virtual machine.
virtualMachine_resourceArn :: Lens' VirtualMachine (Maybe Text) Source #
The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
VirtualMachineDetails
data VirtualMachineDetails Source #
Your VirtualMachine
objects, ordered by their Amazon Resource Names
(ARNs).
See: newVirtualMachineDetails
smart constructor.
VirtualMachineDetails' | |
|
Instances
newVirtualMachineDetails :: VirtualMachineDetails Source #
Create a value of VirtualMachineDetails
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:hostName:VirtualMachineDetails'
, virtualMachineDetails_hostName
- The host name of the virtual machine.
$sel:hypervisorId:VirtualMachineDetails'
, virtualMachineDetails_hypervisorId
- The ID of the virtual machine's hypervisor.
$sel:lastBackupDate:VirtualMachineDetails'
, virtualMachineDetails_lastBackupDate
- The most recent date a virtual machine was backed up, in Unix format and
UTC time.
$sel:name:VirtualMachineDetails'
, virtualMachineDetails_name
- The name of the virtual machine.
$sel:path:VirtualMachineDetails'
, virtualMachineDetails_path
- The path of the virtual machine.
$sel:resourceArn:VirtualMachineDetails'
, virtualMachineDetails_resourceArn
- The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
$sel:vmwareTags:VirtualMachineDetails'
, virtualMachineDetails_vmwareTags
- These are the details of the VMware tags associated with the specified
virtual machine.
virtualMachineDetails_hostName :: Lens' VirtualMachineDetails (Maybe Text) Source #
The host name of the virtual machine.
virtualMachineDetails_hypervisorId :: Lens' VirtualMachineDetails (Maybe Text) Source #
The ID of the virtual machine's hypervisor.
virtualMachineDetails_lastBackupDate :: Lens' VirtualMachineDetails (Maybe UTCTime) Source #
The most recent date a virtual machine was backed up, in Unix format and UTC time.
virtualMachineDetails_name :: Lens' VirtualMachineDetails (Maybe Text) Source #
The name of the virtual machine.
virtualMachineDetails_path :: Lens' VirtualMachineDetails (Maybe Text) Source #
The path of the virtual machine.
virtualMachineDetails_resourceArn :: Lens' VirtualMachineDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
virtualMachineDetails_vmwareTags :: Lens' VirtualMachineDetails (Maybe [VmwareTag]) Source #
These are the details of the VMware tags associated with the specified virtual machine.
VmwareTag
A VMware tag is a tag attached to a specific virtual machine. A tag is a key-value pair you can use to manage, filter, and search for your resources.
The content of VMware tags can be matched to Amazon Web Services tags.
See: newVmwareTag
smart constructor.
VmwareTag' | |
|
Instances
FromJSON VmwareTag Source # | |
Generic VmwareTag Source # | |
Read VmwareTag Source # | |
Show VmwareTag Source # | |
NFData VmwareTag Source # | |
Defined in Amazonka.BackupGateway.Types.VmwareTag | |
Eq VmwareTag Source # | |
Hashable VmwareTag Source # | |
Defined in Amazonka.BackupGateway.Types.VmwareTag | |
type Rep VmwareTag Source # | |
Defined in Amazonka.BackupGateway.Types.VmwareTag type Rep VmwareTag = D1 ('MetaData "VmwareTag" "Amazonka.BackupGateway.Types.VmwareTag" "amazonka-backup-gateway-2.0-Ee3gVOmXMeV2r3uv4sRO9" 'False) (C1 ('MetaCons "VmwareTag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vmwareCategory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vmwareTagDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vmwareTagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newVmwareTag :: VmwareTag Source #
Create a value of VmwareTag
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:vmwareCategory:VmwareTag'
, vmwareTag_vmwareCategory
- The is the category of VMware.
$sel:vmwareTagDescription:VmwareTag'
, vmwareTag_vmwareTagDescription
- This is a user-defined description of a VMware tag.
$sel:vmwareTagName:VmwareTag'
, vmwareTag_vmwareTagName
- This is the user-defined name of a VMware tag.
vmwareTag_vmwareTagDescription :: Lens' VmwareTag (Maybe Text) Source #
This is a user-defined description of a VMware tag.
vmwareTag_vmwareTagName :: Lens' VmwareTag (Maybe Text) Source #
This is the user-defined name of a VMware tag.
VmwareToAwsTagMapping
data VmwareToAwsTagMapping Source #
This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.
See: newVmwareToAwsTagMapping
smart constructor.
VmwareToAwsTagMapping' | |
|
Instances
newVmwareToAwsTagMapping Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> VmwareToAwsTagMapping |
Create a value of VmwareToAwsTagMapping
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:awsTagKey:VmwareToAwsTagMapping'
, vmwareToAwsTagMapping_awsTagKey
- The key part of the Amazon Web Services tag's key-value pair.
$sel:awsTagValue:VmwareToAwsTagMapping'
, vmwareToAwsTagMapping_awsTagValue
- The value part of the Amazon Web Services tag's key-value pair.
$sel:vmwareCategory:VmwareToAwsTagMapping'
, vmwareToAwsTagMapping_vmwareCategory
- The is the category of VMware.
$sel:vmwareTagName:VmwareToAwsTagMapping'
, vmwareToAwsTagMapping_vmwareTagName
- This is the user-defined name of a VMware tag.
vmwareToAwsTagMapping_awsTagKey :: Lens' VmwareToAwsTagMapping Text Source #
The key part of the Amazon Web Services tag's key-value pair.
vmwareToAwsTagMapping_awsTagValue :: Lens' VmwareToAwsTagMapping Text Source #
The value part of the Amazon Web Services tag's key-value pair.
vmwareToAwsTagMapping_vmwareCategory :: Lens' VmwareToAwsTagMapping Text Source #
The is the category of VMware.
vmwareToAwsTagMapping_vmwareTagName :: Lens' VmwareToAwsTagMapping Text Source #
This is the user-defined name of a VMware tag.