amazonka-appstream-2.0: gen/Amazonka/AppStream/Types/ImageBuilder.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.AppStream.Types.ImageBuilder
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.AppStream.Types.ImageBuilder where
import Amazonka.AppStream.Types.AccessEndpoint
import Amazonka.AppStream.Types.DomainJoinInfo
import Amazonka.AppStream.Types.ImageBuilderState
import Amazonka.AppStream.Types.ImageBuilderStateChangeReason
import Amazonka.AppStream.Types.NetworkAccessConfiguration
import Amazonka.AppStream.Types.PlatformType
import Amazonka.AppStream.Types.ResourceError
import Amazonka.AppStream.Types.VpcConfig
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
-- | Describes a virtual machine that is used to create an image.
--
-- /See:/ 'newImageBuilder' smart constructor.
data ImageBuilder = ImageBuilder'
{ -- | The list of virtual private cloud (VPC) interface endpoint objects.
-- Administrators can connect to the image builder only through the
-- specified endpoints.
accessEndpoints :: Prelude.Maybe (Prelude.NonEmpty AccessEndpoint),
-- | The version of the AppStream 2.0 agent that is currently being used by
-- the image builder.
appstreamAgentVersion :: Prelude.Maybe Prelude.Text,
-- | The ARN for the image builder.
arn :: Prelude.Maybe Prelude.Text,
-- | The time stamp when the image builder was created.
createdTime :: Prelude.Maybe Data.POSIX,
-- | The description to display.
description :: Prelude.Maybe Prelude.Text,
-- | The image builder name to display.
displayName :: Prelude.Maybe Prelude.Text,
-- | The name of the directory and organizational unit (OU) to use to join
-- the image builder to a Microsoft Active Directory domain.
domainJoinInfo :: Prelude.Maybe DomainJoinInfo,
-- | Enables or disables default internet access for the image builder.
enableDefaultInternetAccess :: Prelude.Maybe Prelude.Bool,
-- | The ARN of the IAM role that is applied to the image builder. To assume
-- a role, the image builder calls the AWS Security Token Service (STS)
-- @AssumeRole@ API operation and passes the ARN of the role to use. The
-- operation creates a new session with temporary credentials. AppStream
-- 2.0 retrieves the temporary credentials and creates the
-- __appstream_machine_role__ credential profile on the instance.
--
-- For more information, see
-- <https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances>
-- in the /Amazon AppStream 2.0 Administration Guide/.
iamRoleArn :: Prelude.Maybe Prelude.Text,
-- | The ARN of the image from which this builder was created.
imageArn :: Prelude.Maybe Prelude.Text,
-- | The image builder errors.
imageBuilderErrors :: Prelude.Maybe [ResourceError],
-- | The instance type for the image builder. The following instance types
-- are available:
--
-- - stream.standard.small
--
-- - stream.standard.medium
--
-- - stream.standard.large
--
-- - stream.compute.large
--
-- - stream.compute.xlarge
--
-- - stream.compute.2xlarge
--
-- - stream.compute.4xlarge
--
-- - stream.compute.8xlarge
--
-- - stream.memory.large
--
-- - stream.memory.xlarge
--
-- - stream.memory.2xlarge
--
-- - stream.memory.4xlarge
--
-- - stream.memory.8xlarge
--
-- - stream.memory.z1d.large
--
-- - stream.memory.z1d.xlarge
--
-- - stream.memory.z1d.2xlarge
--
-- - stream.memory.z1d.3xlarge
--
-- - stream.memory.z1d.6xlarge
--
-- - stream.memory.z1d.12xlarge
--
-- - stream.graphics-design.large
--
-- - stream.graphics-design.xlarge
--
-- - stream.graphics-design.2xlarge
--
-- - stream.graphics-design.4xlarge
--
-- - stream.graphics-desktop.2xlarge
--
-- - stream.graphics.g4dn.xlarge
--
-- - stream.graphics.g4dn.2xlarge
--
-- - stream.graphics.g4dn.4xlarge
--
-- - stream.graphics.g4dn.8xlarge
--
-- - stream.graphics.g4dn.12xlarge
--
-- - stream.graphics.g4dn.16xlarge
--
-- - stream.graphics-pro.4xlarge
--
-- - stream.graphics-pro.8xlarge
--
-- - stream.graphics-pro.16xlarge
instanceType :: Prelude.Maybe Prelude.Text,
networkAccessConfiguration :: Prelude.Maybe NetworkAccessConfiguration,
-- | The operating system platform of the image builder.
platform :: Prelude.Maybe PlatformType,
-- | The state of the image builder.
state :: Prelude.Maybe ImageBuilderState,
-- | The reason why the last state change occurred.
stateChangeReason :: Prelude.Maybe ImageBuilderStateChangeReason,
-- | The VPC configuration of the image builder.
vpcConfig :: Prelude.Maybe VpcConfig,
-- | The name of the image builder.
name :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'ImageBuilder' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'accessEndpoints', 'imageBuilder_accessEndpoints' - The list of virtual private cloud (VPC) interface endpoint objects.
-- Administrators can connect to the image builder only through the
-- specified endpoints.
--
-- 'appstreamAgentVersion', 'imageBuilder_appstreamAgentVersion' - The version of the AppStream 2.0 agent that is currently being used by
-- the image builder.
--
-- 'arn', 'imageBuilder_arn' - The ARN for the image builder.
--
-- 'createdTime', 'imageBuilder_createdTime' - The time stamp when the image builder was created.
--
-- 'description', 'imageBuilder_description' - The description to display.
--
-- 'displayName', 'imageBuilder_displayName' - The image builder name to display.
--
-- 'domainJoinInfo', 'imageBuilder_domainJoinInfo' - The name of the directory and organizational unit (OU) to use to join
-- the image builder to a Microsoft Active Directory domain.
--
-- 'enableDefaultInternetAccess', 'imageBuilder_enableDefaultInternetAccess' - Enables or disables default internet access for the image builder.
--
-- 'iamRoleArn', 'imageBuilder_iamRoleArn' - The ARN of the IAM role that is applied to the image builder. To assume
-- a role, the image builder calls the AWS Security Token Service (STS)
-- @AssumeRole@ API operation and passes the ARN of the role to use. The
-- operation creates a new session with temporary credentials. AppStream
-- 2.0 retrieves the temporary credentials and creates the
-- __appstream_machine_role__ credential profile on the instance.
--
-- For more information, see
-- <https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances>
-- in the /Amazon AppStream 2.0 Administration Guide/.
--
-- 'imageArn', 'imageBuilder_imageArn' - The ARN of the image from which this builder was created.
--
-- 'imageBuilderErrors', 'imageBuilder_imageBuilderErrors' - The image builder errors.
--
-- 'instanceType', 'imageBuilder_instanceType' - The instance type for the image builder. The following instance types
-- are available:
--
-- - stream.standard.small
--
-- - stream.standard.medium
--
-- - stream.standard.large
--
-- - stream.compute.large
--
-- - stream.compute.xlarge
--
-- - stream.compute.2xlarge
--
-- - stream.compute.4xlarge
--
-- - stream.compute.8xlarge
--
-- - stream.memory.large
--
-- - stream.memory.xlarge
--
-- - stream.memory.2xlarge
--
-- - stream.memory.4xlarge
--
-- - stream.memory.8xlarge
--
-- - stream.memory.z1d.large
--
-- - stream.memory.z1d.xlarge
--
-- - stream.memory.z1d.2xlarge
--
-- - stream.memory.z1d.3xlarge
--
-- - stream.memory.z1d.6xlarge
--
-- - stream.memory.z1d.12xlarge
--
-- - stream.graphics-design.large
--
-- - stream.graphics-design.xlarge
--
-- - stream.graphics-design.2xlarge
--
-- - stream.graphics-design.4xlarge
--
-- - stream.graphics-desktop.2xlarge
--
-- - stream.graphics.g4dn.xlarge
--
-- - stream.graphics.g4dn.2xlarge
--
-- - stream.graphics.g4dn.4xlarge
--
-- - stream.graphics.g4dn.8xlarge
--
-- - stream.graphics.g4dn.12xlarge
--
-- - stream.graphics.g4dn.16xlarge
--
-- - stream.graphics-pro.4xlarge
--
-- - stream.graphics-pro.8xlarge
--
-- - stream.graphics-pro.16xlarge
--
-- 'networkAccessConfiguration', 'imageBuilder_networkAccessConfiguration' - Undocumented member.
--
-- 'platform', 'imageBuilder_platform' - The operating system platform of the image builder.
--
-- 'state', 'imageBuilder_state' - The state of the image builder.
--
-- 'stateChangeReason', 'imageBuilder_stateChangeReason' - The reason why the last state change occurred.
--
-- 'vpcConfig', 'imageBuilder_vpcConfig' - The VPC configuration of the image builder.
--
-- 'name', 'imageBuilder_name' - The name of the image builder.
newImageBuilder ::
-- | 'name'
Prelude.Text ->
ImageBuilder
newImageBuilder pName_ =
ImageBuilder'
{ accessEndpoints = Prelude.Nothing,
appstreamAgentVersion = Prelude.Nothing,
arn = Prelude.Nothing,
createdTime = Prelude.Nothing,
description = Prelude.Nothing,
displayName = Prelude.Nothing,
domainJoinInfo = Prelude.Nothing,
enableDefaultInternetAccess = Prelude.Nothing,
iamRoleArn = Prelude.Nothing,
imageArn = Prelude.Nothing,
imageBuilderErrors = Prelude.Nothing,
instanceType = Prelude.Nothing,
networkAccessConfiguration = Prelude.Nothing,
platform = Prelude.Nothing,
state = Prelude.Nothing,
stateChangeReason = Prelude.Nothing,
vpcConfig = Prelude.Nothing,
name = pName_
}
-- | The list of virtual private cloud (VPC) interface endpoint objects.
-- Administrators can connect to the image builder only through the
-- specified endpoints.
imageBuilder_accessEndpoints :: Lens.Lens' ImageBuilder (Prelude.Maybe (Prelude.NonEmpty AccessEndpoint))
imageBuilder_accessEndpoints = Lens.lens (\ImageBuilder' {accessEndpoints} -> accessEndpoints) (\s@ImageBuilder' {} a -> s {accessEndpoints = a} :: ImageBuilder) Prelude.. Lens.mapping Lens.coerced
-- | The version of the AppStream 2.0 agent that is currently being used by
-- the image builder.
imageBuilder_appstreamAgentVersion :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Text)
imageBuilder_appstreamAgentVersion = Lens.lens (\ImageBuilder' {appstreamAgentVersion} -> appstreamAgentVersion) (\s@ImageBuilder' {} a -> s {appstreamAgentVersion = a} :: ImageBuilder)
-- | The ARN for the image builder.
imageBuilder_arn :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Text)
imageBuilder_arn = Lens.lens (\ImageBuilder' {arn} -> arn) (\s@ImageBuilder' {} a -> s {arn = a} :: ImageBuilder)
-- | The time stamp when the image builder was created.
imageBuilder_createdTime :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.UTCTime)
imageBuilder_createdTime = Lens.lens (\ImageBuilder' {createdTime} -> createdTime) (\s@ImageBuilder' {} a -> s {createdTime = a} :: ImageBuilder) Prelude.. Lens.mapping Data._Time
-- | The description to display.
imageBuilder_description :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Text)
imageBuilder_description = Lens.lens (\ImageBuilder' {description} -> description) (\s@ImageBuilder' {} a -> s {description = a} :: ImageBuilder)
-- | The image builder name to display.
imageBuilder_displayName :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Text)
imageBuilder_displayName = Lens.lens (\ImageBuilder' {displayName} -> displayName) (\s@ImageBuilder' {} a -> s {displayName = a} :: ImageBuilder)
-- | The name of the directory and organizational unit (OU) to use to join
-- the image builder to a Microsoft Active Directory domain.
imageBuilder_domainJoinInfo :: Lens.Lens' ImageBuilder (Prelude.Maybe DomainJoinInfo)
imageBuilder_domainJoinInfo = Lens.lens (\ImageBuilder' {domainJoinInfo} -> domainJoinInfo) (\s@ImageBuilder' {} a -> s {domainJoinInfo = a} :: ImageBuilder)
-- | Enables or disables default internet access for the image builder.
imageBuilder_enableDefaultInternetAccess :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Bool)
imageBuilder_enableDefaultInternetAccess = Lens.lens (\ImageBuilder' {enableDefaultInternetAccess} -> enableDefaultInternetAccess) (\s@ImageBuilder' {} a -> s {enableDefaultInternetAccess = a} :: ImageBuilder)
-- | The ARN of the IAM role that is applied to the image builder. To assume
-- a role, the image builder calls the AWS Security Token Service (STS)
-- @AssumeRole@ API operation and passes the ARN of the role to use. The
-- operation creates a new session with temporary credentials. AppStream
-- 2.0 retrieves the temporary credentials and creates the
-- __appstream_machine_role__ credential profile on the instance.
--
-- For more information, see
-- <https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances>
-- in the /Amazon AppStream 2.0 Administration Guide/.
imageBuilder_iamRoleArn :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Text)
imageBuilder_iamRoleArn = Lens.lens (\ImageBuilder' {iamRoleArn} -> iamRoleArn) (\s@ImageBuilder' {} a -> s {iamRoleArn = a} :: ImageBuilder)
-- | The ARN of the image from which this builder was created.
imageBuilder_imageArn :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Text)
imageBuilder_imageArn = Lens.lens (\ImageBuilder' {imageArn} -> imageArn) (\s@ImageBuilder' {} a -> s {imageArn = a} :: ImageBuilder)
-- | The image builder errors.
imageBuilder_imageBuilderErrors :: Lens.Lens' ImageBuilder (Prelude.Maybe [ResourceError])
imageBuilder_imageBuilderErrors = Lens.lens (\ImageBuilder' {imageBuilderErrors} -> imageBuilderErrors) (\s@ImageBuilder' {} a -> s {imageBuilderErrors = a} :: ImageBuilder) Prelude.. Lens.mapping Lens.coerced
-- | The instance type for the image builder. The following instance types
-- are available:
--
-- - stream.standard.small
--
-- - stream.standard.medium
--
-- - stream.standard.large
--
-- - stream.compute.large
--
-- - stream.compute.xlarge
--
-- - stream.compute.2xlarge
--
-- - stream.compute.4xlarge
--
-- - stream.compute.8xlarge
--
-- - stream.memory.large
--
-- - stream.memory.xlarge
--
-- - stream.memory.2xlarge
--
-- - stream.memory.4xlarge
--
-- - stream.memory.8xlarge
--
-- - stream.memory.z1d.large
--
-- - stream.memory.z1d.xlarge
--
-- - stream.memory.z1d.2xlarge
--
-- - stream.memory.z1d.3xlarge
--
-- - stream.memory.z1d.6xlarge
--
-- - stream.memory.z1d.12xlarge
--
-- - stream.graphics-design.large
--
-- - stream.graphics-design.xlarge
--
-- - stream.graphics-design.2xlarge
--
-- - stream.graphics-design.4xlarge
--
-- - stream.graphics-desktop.2xlarge
--
-- - stream.graphics.g4dn.xlarge
--
-- - stream.graphics.g4dn.2xlarge
--
-- - stream.graphics.g4dn.4xlarge
--
-- - stream.graphics.g4dn.8xlarge
--
-- - stream.graphics.g4dn.12xlarge
--
-- - stream.graphics.g4dn.16xlarge
--
-- - stream.graphics-pro.4xlarge
--
-- - stream.graphics-pro.8xlarge
--
-- - stream.graphics-pro.16xlarge
imageBuilder_instanceType :: Lens.Lens' ImageBuilder (Prelude.Maybe Prelude.Text)
imageBuilder_instanceType = Lens.lens (\ImageBuilder' {instanceType} -> instanceType) (\s@ImageBuilder' {} a -> s {instanceType = a} :: ImageBuilder)
-- | Undocumented member.
imageBuilder_networkAccessConfiguration :: Lens.Lens' ImageBuilder (Prelude.Maybe NetworkAccessConfiguration)
imageBuilder_networkAccessConfiguration = Lens.lens (\ImageBuilder' {networkAccessConfiguration} -> networkAccessConfiguration) (\s@ImageBuilder' {} a -> s {networkAccessConfiguration = a} :: ImageBuilder)
-- | The operating system platform of the image builder.
imageBuilder_platform :: Lens.Lens' ImageBuilder (Prelude.Maybe PlatformType)
imageBuilder_platform = Lens.lens (\ImageBuilder' {platform} -> platform) (\s@ImageBuilder' {} a -> s {platform = a} :: ImageBuilder)
-- | The state of the image builder.
imageBuilder_state :: Lens.Lens' ImageBuilder (Prelude.Maybe ImageBuilderState)
imageBuilder_state = Lens.lens (\ImageBuilder' {state} -> state) (\s@ImageBuilder' {} a -> s {state = a} :: ImageBuilder)
-- | The reason why the last state change occurred.
imageBuilder_stateChangeReason :: Lens.Lens' ImageBuilder (Prelude.Maybe ImageBuilderStateChangeReason)
imageBuilder_stateChangeReason = Lens.lens (\ImageBuilder' {stateChangeReason} -> stateChangeReason) (\s@ImageBuilder' {} a -> s {stateChangeReason = a} :: ImageBuilder)
-- | The VPC configuration of the image builder.
imageBuilder_vpcConfig :: Lens.Lens' ImageBuilder (Prelude.Maybe VpcConfig)
imageBuilder_vpcConfig = Lens.lens (\ImageBuilder' {vpcConfig} -> vpcConfig) (\s@ImageBuilder' {} a -> s {vpcConfig = a} :: ImageBuilder)
-- | The name of the image builder.
imageBuilder_name :: Lens.Lens' ImageBuilder Prelude.Text
imageBuilder_name = Lens.lens (\ImageBuilder' {name} -> name) (\s@ImageBuilder' {} a -> s {name = a} :: ImageBuilder)
instance Data.FromJSON ImageBuilder where
parseJSON =
Data.withObject
"ImageBuilder"
( \x ->
ImageBuilder'
Prelude.<$> (x Data..:? "AccessEndpoints")
Prelude.<*> (x Data..:? "AppstreamAgentVersion")
Prelude.<*> (x Data..:? "Arn")
Prelude.<*> (x Data..:? "CreatedTime")
Prelude.<*> (x Data..:? "Description")
Prelude.<*> (x Data..:? "DisplayName")
Prelude.<*> (x Data..:? "DomainJoinInfo")
Prelude.<*> (x Data..:? "EnableDefaultInternetAccess")
Prelude.<*> (x Data..:? "IamRoleArn")
Prelude.<*> (x Data..:? "ImageArn")
Prelude.<*> ( x
Data..:? "ImageBuilderErrors"
Data..!= Prelude.mempty
)
Prelude.<*> (x Data..:? "InstanceType")
Prelude.<*> (x Data..:? "NetworkAccessConfiguration")
Prelude.<*> (x Data..:? "Platform")
Prelude.<*> (x Data..:? "State")
Prelude.<*> (x Data..:? "StateChangeReason")
Prelude.<*> (x Data..:? "VpcConfig")
Prelude.<*> (x Data..: "Name")
)
instance Prelude.Hashable ImageBuilder where
hashWithSalt _salt ImageBuilder' {..} =
_salt
`Prelude.hashWithSalt` accessEndpoints
`Prelude.hashWithSalt` appstreamAgentVersion
`Prelude.hashWithSalt` arn
`Prelude.hashWithSalt` createdTime
`Prelude.hashWithSalt` description
`Prelude.hashWithSalt` displayName
`Prelude.hashWithSalt` domainJoinInfo
`Prelude.hashWithSalt` enableDefaultInternetAccess
`Prelude.hashWithSalt` iamRoleArn
`Prelude.hashWithSalt` imageArn
`Prelude.hashWithSalt` imageBuilderErrors
`Prelude.hashWithSalt` instanceType
`Prelude.hashWithSalt` networkAccessConfiguration
`Prelude.hashWithSalt` platform
`Prelude.hashWithSalt` state
`Prelude.hashWithSalt` stateChangeReason
`Prelude.hashWithSalt` vpcConfig
`Prelude.hashWithSalt` name
instance Prelude.NFData ImageBuilder where
rnf ImageBuilder' {..} =
Prelude.rnf accessEndpoints
`Prelude.seq` Prelude.rnf appstreamAgentVersion
`Prelude.seq` Prelude.rnf arn
`Prelude.seq` Prelude.rnf createdTime
`Prelude.seq` Prelude.rnf description
`Prelude.seq` Prelude.rnf displayName
`Prelude.seq` Prelude.rnf domainJoinInfo
`Prelude.seq` Prelude.rnf enableDefaultInternetAccess
`Prelude.seq` Prelude.rnf iamRoleArn
`Prelude.seq` Prelude.rnf imageArn
`Prelude.seq` Prelude.rnf imageBuilderErrors
`Prelude.seq` Prelude.rnf instanceType
`Prelude.seq` Prelude.rnf networkAccessConfiguration
`Prelude.seq` Prelude.rnf platform
`Prelude.seq` Prelude.rnf state
`Prelude.seq` Prelude.rnf stateChangeReason
`Prelude.seq` Prelude.rnf vpcConfig
`Prelude.seq` Prelude.rnf name