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.AppStream.CreateImageBuilder

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an image builder. An image builder is a virtual machine that is used to create an image.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Synopsis

data CreateImageBuilder = CreateImageBuilder' {
- accessEndpoints :: Maybe (NonEmpty AccessEndpoint)
- appstreamAgentVersion :: Maybe Text
- description :: Maybe Text
- displayName :: Maybe Text
- domainJoinInfo :: Maybe DomainJoinInfo
- enableDefaultInternetAccess :: Maybe Bool
- iamRoleArn :: Maybe Text
- imageArn :: Maybe Text
- imageName :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- vpcConfig :: Maybe VpcConfig
- name :: Text
- instanceType :: Text
}
newCreateImageBuilder :: Text -> Text -> CreateImageBuilder
createImageBuilder_accessEndpoints :: Lens' CreateImageBuilder (Maybe (NonEmpty AccessEndpoint))
createImageBuilder_appstreamAgentVersion :: Lens' CreateImageBuilder (Maybe Text)
createImageBuilder_description :: Lens' CreateImageBuilder (Maybe Text)
createImageBuilder_displayName :: Lens' CreateImageBuilder (Maybe Text)
createImageBuilder_domainJoinInfo :: Lens' CreateImageBuilder (Maybe DomainJoinInfo)
createImageBuilder_enableDefaultInternetAccess :: Lens' CreateImageBuilder (Maybe Bool)
createImageBuilder_iamRoleArn :: Lens' CreateImageBuilder (Maybe Text)
createImageBuilder_imageArn :: Lens' CreateImageBuilder (Maybe Text)
createImageBuilder_imageName :: Lens' CreateImageBuilder (Maybe Text)
createImageBuilder_tags :: Lens' CreateImageBuilder (Maybe (HashMap Text Text))
createImageBuilder_vpcConfig :: Lens' CreateImageBuilder (Maybe VpcConfig)
createImageBuilder_name :: Lens' CreateImageBuilder Text
createImageBuilder_instanceType :: Lens' CreateImageBuilder Text
data CreateImageBuilderResponse = CreateImageBuilderResponse' {
- imageBuilder :: Maybe ImageBuilder
- httpStatus :: Int
}
newCreateImageBuilderResponse :: Int -> CreateImageBuilderResponse
createImageBuilderResponse_imageBuilder :: Lens' CreateImageBuilderResponse (Maybe ImageBuilder)
createImageBuilderResponse_httpStatus :: Lens' CreateImageBuilderResponse Int

Creating a Request

data CreateImageBuilder Source #

See: newCreateImageBuilder smart constructor.

Constructors

CreateImageBuilder'

Fields

accessEndpoints :: Maybe (NonEmpty AccessEndpoint)
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
appstreamAgentVersion :: Maybe Text
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
description :: Maybe Text
The description to display.
displayName :: Maybe Text
The image builder name to display.
domainJoinInfo :: Maybe DomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enableDefaultInternetAccess :: Maybe Bool
Enables or disables default internet access for the image builder.
iamRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role to apply 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.
imageArn :: Maybe Text
The ARN of the public, private, or shared image to use.
imageName :: Maybe Text
The name of the image used to create the image builder.
tags :: Maybe (HashMap Text Text)
The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
vpcConfig :: Maybe VpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
name :: Text
A unique name for the image builder.
instanceType :: Text
The instance type to use when launching 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

Instances

Instances details

ToJSON CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods toJSON :: CreateImageBuilder -> Value # toEncoding :: CreateImageBuilder -> Encoding # toJSONList :: [CreateImageBuilder] -> Value # toEncodingList :: [CreateImageBuilder] -> Encoding #
ToHeaders CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods toHeaders :: CreateImageBuilder -> [Header] #
ToPath CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods toPath :: CreateImageBuilder -> ByteString #
ToQuery CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods toQuery :: CreateImageBuilder -> QueryString #
AWSRequest CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Associated Types type AWSResponse CreateImageBuilder # Methods request :: (Service -> Service) -> CreateImageBuilder -> Request CreateImageBuilder # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateImageBuilder -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateImageBuilder))) #
Generic CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Associated Types type Rep CreateImageBuilder :: Type -> Type # Methods from :: CreateImageBuilder -> Rep CreateImageBuilder x # to :: Rep CreateImageBuilder x -> CreateImageBuilder #
Read CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods readsPrec :: Int -> ReadS CreateImageBuilder # readList :: ReadS [CreateImageBuilder] # readPrec :: ReadPrec CreateImageBuilder # readListPrec :: ReadPrec [CreateImageBuilder] #
Show CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods showsPrec :: Int -> CreateImageBuilder -> ShowS # show :: CreateImageBuilder -> String # showList :: [CreateImageBuilder] -> ShowS #
NFData CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods rnf :: CreateImageBuilder -> () #
Eq CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods (==) :: CreateImageBuilder -> CreateImageBuilder -> Bool # (/=) :: CreateImageBuilder -> CreateImageBuilder -> Bool #
Hashable CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods hashWithSalt :: Int -> CreateImageBuilder -> Int # hash :: CreateImageBuilder -> Int #
type AWSResponse CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder type AWSResponse CreateImageBuilder = CreateImageBuilderResponse
type Rep CreateImageBuilder Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder type Rep CreateImageBuilder = D1 ('MetaData "CreateImageBuilder" "Amazonka.AppStream.CreateImageBuilder" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateImageBuilder'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AccessEndpoint))) :: (S1 ('MetaSel ('Just "appstreamAgentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "domainJoinInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainJoinInfo)) :: S1 ('MetaSel ('Just "enableDefaultInternetAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "imageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateImageBuilder Source #

Arguments

:: Text	`CreateImageBuilder`
-> Text	`CreateImageBuilder`
-> CreateImageBuilder

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

CreateImageBuilder, createImageBuilder_accessEndpoints - The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

CreateImageBuilder, createImageBuilder_appstreamAgentVersion - The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

CreateImageBuilder, createImageBuilder_description - The description to display.

CreateImageBuilder, createImageBuilder_displayName - The image builder name to display.

CreateImageBuilder, createImageBuilder_domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

CreateImageBuilder, createImageBuilder_enableDefaultInternetAccess - Enables or disables default internet access for the image builder.

CreateImageBuilder, createImageBuilder_iamRoleArn - The Amazon Resource Name (ARN) of the IAM role to apply 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.

CreateImageBuilder, createImageBuilder_imageArn - The ARN of the public, private, or shared image to use.

CreateImageBuilder, createImageBuilder_imageName - The name of the image used to create the image builder.

$sel:tags:CreateImageBuilder', createImageBuilder_tags - The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

CreateImageBuilder, createImageBuilder_vpcConfig - The VPC configuration for the image builder. You can specify only one subnet.

CreateImageBuilder, createImageBuilder_name - A unique name for the image builder.

CreateImageBuilder, createImageBuilder_instanceType - The instance type to use when launching 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

Request Lenses

createImageBuilder_accessEndpoints :: Lens' CreateImageBuilder (Maybe (NonEmpty AccessEndpoint)) Source #

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

createImageBuilder_appstreamAgentVersion :: Lens' CreateImageBuilder (Maybe Text) Source #

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

createImageBuilder_description :: Lens' CreateImageBuilder (Maybe Text) Source #

The description to display.

createImageBuilder_displayName :: Lens' CreateImageBuilder (Maybe Text) Source #

The image builder name to display.

createImageBuilder_domainJoinInfo :: Lens' CreateImageBuilder (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.

createImageBuilder_enableDefaultInternetAccess :: Lens' CreateImageBuilder (Maybe Bool) Source #

Enables or disables default internet access for the image builder.

createImageBuilder_iamRoleArn :: Lens' CreateImageBuilder (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role to apply 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.

createImageBuilder_imageArn :: Lens' CreateImageBuilder (Maybe Text) Source #

The ARN of the public, private, or shared image to use.

createImageBuilder_imageName :: Lens' CreateImageBuilder (Maybe Text) Source #

The name of the image used to create the image builder.

createImageBuilder_tags :: Lens' CreateImageBuilder (Maybe (HashMap Text Text)) Source #

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

createImageBuilder_vpcConfig :: Lens' CreateImageBuilder (Maybe VpcConfig) Source #

The VPC configuration for the image builder. You can specify only one subnet.

createImageBuilder_name :: Lens' CreateImageBuilder Text Source #

A unique name for the image builder.

createImageBuilder_instanceType :: Lens' CreateImageBuilder Text Source #

The instance type to use when launching 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

Destructuring the Response

data CreateImageBuilderResponse Source #

See: newCreateImageBuilderResponse smart constructor.

Constructors

CreateImageBuilderResponse'
Fields imageBuilder :: Maybe ImageBuilder Information about the image builder. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateImageBuilderResponse Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Associated Types type Rep CreateImageBuilderResponse :: Type -> Type # Methods from :: CreateImageBuilderResponse -> Rep CreateImageBuilderResponse x # to :: Rep CreateImageBuilderResponse x -> CreateImageBuilderResponse #
Read CreateImageBuilderResponse Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods readsPrec :: Int -> ReadS CreateImageBuilderResponse # readList :: ReadS [CreateImageBuilderResponse] # readPrec :: ReadPrec CreateImageBuilderResponse # readListPrec :: ReadPrec [CreateImageBuilderResponse] #
Show CreateImageBuilderResponse Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods showsPrec :: Int -> CreateImageBuilderResponse -> ShowS # show :: CreateImageBuilderResponse -> String # showList :: [CreateImageBuilderResponse] -> ShowS #
NFData CreateImageBuilderResponse Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods rnf :: CreateImageBuilderResponse -> () #
Eq CreateImageBuilderResponse Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder Methods (==) :: CreateImageBuilderResponse -> CreateImageBuilderResponse -> Bool # (/=) :: CreateImageBuilderResponse -> CreateImageBuilderResponse -> Bool #
type Rep CreateImageBuilderResponse Source #
Instance details Defined in Amazonka.AppStream.CreateImageBuilder type Rep CreateImageBuilderResponse = D1 ('MetaData "CreateImageBuilderResponse" "Amazonka.AppStream.CreateImageBuilder" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateImageBuilderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageBuilder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageBuilder)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateImageBuilderResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateImageBuilderResponse'`
-> CreateImageBuilderResponse

Create a value of CreateImageBuilderResponse 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:imageBuilder:CreateImageBuilderResponse', createImageBuilderResponse_imageBuilder - Information about the image builder.

$sel:httpStatus:CreateImageBuilderResponse', createImageBuilderResponse_httpStatus - The response's http status code.

Response Lenses

createImageBuilderResponse_imageBuilder :: Lens' CreateImageBuilderResponse (Maybe ImageBuilder) Source #

Information about the image builder.

createImageBuilderResponse_httpStatus :: Lens' CreateImageBuilderResponse Int Source #

The response's http status code.