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
- data ImageBuilder = ImageBuilder' {
- accessEndpoints :: Maybe (NonEmpty AccessEndpoint)
- appstreamAgentVersion :: Maybe Text
- arn :: Maybe Text
- createdTime :: Maybe POSIX
- description :: Maybe Text
- displayName :: Maybe Text
- domainJoinInfo :: Maybe DomainJoinInfo
- enableDefaultInternetAccess :: Maybe Bool
- iamRoleArn :: Maybe Text
- imageArn :: Maybe Text
- imageBuilderErrors :: Maybe [ResourceError]
- instanceType :: Maybe Text
- networkAccessConfiguration :: Maybe NetworkAccessConfiguration
- platform :: Maybe PlatformType
- state :: Maybe ImageBuilderState
- stateChangeReason :: Maybe ImageBuilderStateChangeReason
- vpcConfig :: Maybe VpcConfig
- name :: Text
- newImageBuilder :: Text -> ImageBuilder
- imageBuilder_accessEndpoints :: Lens' ImageBuilder (Maybe (NonEmpty AccessEndpoint))
- imageBuilder_appstreamAgentVersion :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_arn :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_createdTime :: Lens' ImageBuilder (Maybe UTCTime)
- imageBuilder_description :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_displayName :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_domainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo)
- imageBuilder_enableDefaultInternetAccess :: Lens' ImageBuilder (Maybe Bool)
- imageBuilder_iamRoleArn :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_imageArn :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_imageBuilderErrors :: Lens' ImageBuilder (Maybe [ResourceError])
- imageBuilder_instanceType :: Lens' ImageBuilder (Maybe Text)
- imageBuilder_networkAccessConfiguration :: Lens' ImageBuilder (Maybe NetworkAccessConfiguration)
- imageBuilder_platform :: Lens' ImageBuilder (Maybe PlatformType)
- imageBuilder_state :: Lens' ImageBuilder (Maybe ImageBuilderState)
- imageBuilder_stateChangeReason :: Lens' ImageBuilder (Maybe ImageBuilderStateChangeReason)
- imageBuilder_vpcConfig :: Lens' ImageBuilder (Maybe VpcConfig)
- imageBuilder_name :: Lens' ImageBuilder Text
Documentation
data ImageBuilder Source #
Describes a virtual machine that is used to create an image.
See: newImageBuilder
smart constructor.
ImageBuilder' | |
|
Instances
Create a value of ImageBuilder
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:accessEndpoints:ImageBuilder'
, imageBuilder_accessEndpoints
- The list of virtual private cloud (VPC) interface endpoint objects.
Administrators can connect to the image builder only through the
specified endpoints.
$sel:appstreamAgentVersion:ImageBuilder'
, imageBuilder_appstreamAgentVersion
- The version of the AppStream 2.0 agent that is currently being used by
the image builder.
$sel:arn:ImageBuilder'
, imageBuilder_arn
- The ARN for the image builder.
$sel:createdTime:ImageBuilder'
, imageBuilder_createdTime
- The time stamp when the image builder was created.
$sel:description:ImageBuilder'
, imageBuilder_description
- The description to display.
$sel:displayName:ImageBuilder'
, imageBuilder_displayName
- The image builder name to display.
$sel:domainJoinInfo:ImageBuilder'
, imageBuilder_domainJoinInfo
- The name of the directory and organizational unit (OU) to use to join
the image builder to a Microsoft Active Directory domain.
$sel:enableDefaultInternetAccess:ImageBuilder'
, imageBuilder_enableDefaultInternetAccess
- Enables or disables default internet access for the image builder.
$sel:iamRoleArn:ImageBuilder'
, 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 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.
$sel:imageArn:ImageBuilder'
, imageBuilder_imageArn
- The ARN of the image from which this builder was created.
$sel:imageBuilderErrors:ImageBuilder'
, imageBuilder_imageBuilderErrors
- The image builder errors.
$sel:instanceType:ImageBuilder'
, 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
$sel:networkAccessConfiguration:ImageBuilder'
, imageBuilder_networkAccessConfiguration
- Undocumented member.
$sel:platform:ImageBuilder'
, imageBuilder_platform
- The operating system platform of the image builder.
$sel:state:ImageBuilder'
, imageBuilder_state
- The state of the image builder.
$sel:stateChangeReason:ImageBuilder'
, imageBuilder_stateChangeReason
- The reason why the last state change occurred.
$sel:vpcConfig:ImageBuilder'
, imageBuilder_vpcConfig
- The VPC configuration of the image builder.
$sel:name:ImageBuilder'
, imageBuilder_name
- The name of the image builder.
imageBuilder_accessEndpoints :: Lens' ImageBuilder (Maybe (NonEmpty AccessEndpoint)) Source #
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
imageBuilder_appstreamAgentVersion :: Lens' ImageBuilder (Maybe Text) Source #
The version of the AppStream 2.0 agent that is currently being used by the image builder.
imageBuilder_arn :: Lens' ImageBuilder (Maybe Text) Source #
The ARN for the image builder.
imageBuilder_createdTime :: Lens' ImageBuilder (Maybe UTCTime) Source #
The time stamp when the image builder was created.
imageBuilder_description :: Lens' ImageBuilder (Maybe Text) Source #
The description to display.
imageBuilder_displayName :: Lens' ImageBuilder (Maybe Text) Source #
The image builder name to display.
imageBuilder_domainJoinInfo :: Lens' ImageBuilder (Maybe DomainJoinInfo) Source #
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
imageBuilder_enableDefaultInternetAccess :: Lens' ImageBuilder (Maybe Bool) Source #
Enables or disables default internet access for the image builder.
imageBuilder_iamRoleArn :: Lens' ImageBuilder (Maybe Text) Source #
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 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_imageArn :: Lens' ImageBuilder (Maybe Text) Source #
The ARN of the image from which this builder was created.
imageBuilder_imageBuilderErrors :: Lens' ImageBuilder (Maybe [ResourceError]) Source #
The image builder errors.
imageBuilder_instanceType :: Lens' ImageBuilder (Maybe Text) Source #
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_networkAccessConfiguration :: Lens' ImageBuilder (Maybe NetworkAccessConfiguration) Source #
Undocumented member.
imageBuilder_platform :: Lens' ImageBuilder (Maybe PlatformType) Source #
The operating system platform of the image builder.
imageBuilder_state :: Lens' ImageBuilder (Maybe ImageBuilderState) Source #
The state of the image builder.
imageBuilder_stateChangeReason :: Lens' ImageBuilder (Maybe ImageBuilderStateChangeReason) Source #
The reason why the last state change occurred.
imageBuilder_vpcConfig :: Lens' ImageBuilder (Maybe VpcConfig) Source #
The VPC configuration of the image builder.
imageBuilder_name :: Lens' ImageBuilder Text Source #
The name of the image builder.