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.CreateStack

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Synopsis

data CreateStack = CreateStack' {
- accessEndpoints :: Maybe (NonEmpty AccessEndpoint)
- applicationSettings :: Maybe ApplicationSettings
- description :: Maybe Text
- displayName :: Maybe Text
- embedHostDomains :: Maybe (NonEmpty Text)
- feedbackURL :: Maybe Text
- redirectURL :: Maybe Text
- storageConnectors :: Maybe [StorageConnector]
- streamingExperienceSettings :: Maybe StreamingExperienceSettings
- tags :: Maybe (HashMap Text Text)
- userSettings :: Maybe (NonEmpty UserSetting)
- name :: Text
}
newCreateStack :: Text -> CreateStack
createStack_accessEndpoints :: Lens' CreateStack (Maybe (NonEmpty AccessEndpoint))
createStack_applicationSettings :: Lens' CreateStack (Maybe ApplicationSettings)
createStack_description :: Lens' CreateStack (Maybe Text)
createStack_displayName :: Lens' CreateStack (Maybe Text)
createStack_embedHostDomains :: Lens' CreateStack (Maybe (NonEmpty Text))
createStack_feedbackURL :: Lens' CreateStack (Maybe Text)
createStack_redirectURL :: Lens' CreateStack (Maybe Text)
createStack_storageConnectors :: Lens' CreateStack (Maybe [StorageConnector])
createStack_streamingExperienceSettings :: Lens' CreateStack (Maybe StreamingExperienceSettings)
createStack_tags :: Lens' CreateStack (Maybe (HashMap Text Text))
createStack_userSettings :: Lens' CreateStack (Maybe (NonEmpty UserSetting))
createStack_name :: Lens' CreateStack Text
data CreateStackResponse = CreateStackResponse' {
- stack :: Maybe Stack
- httpStatus :: Int
}
newCreateStackResponse :: Int -> CreateStackResponse
createStackResponse_stack :: Lens' CreateStackResponse (Maybe Stack)
createStackResponse_httpStatus :: Lens' CreateStackResponse Int

Creating a Request

data CreateStack Source #

See: newCreateStack smart constructor.

Constructors

CreateStack'

Fields

accessEndpoints :: Maybe (NonEmpty AccessEndpoint)
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
applicationSettings :: Maybe ApplicationSettings
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
description :: Maybe Text
The description to display.
displayName :: Maybe Text
The stack name to display.
embedHostDomains :: Maybe (NonEmpty Text)
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
feedbackURL :: Maybe Text
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
redirectURL :: Maybe Text
The URL that users are redirected to after their streaming session ends.
storageConnectors :: Maybe [StorageConnector]
The storage connectors to enable.
streamingExperienceSettings :: Maybe StreamingExperienceSettings
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
tags :: Maybe (HashMap Text Text)
The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
If you do not specify a value, the value is set to an empty string.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
userSettings :: Maybe (NonEmpty UserSetting)
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
name :: Text
The name of the stack.

Instances

Instances details

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

newCreateStack Source #

Arguments

:: Text	`CreateStack`
-> CreateStack

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

CreateStack, createStack_accessEndpoints - The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

CreateStack, createStack_applicationSettings - The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

CreateStack, createStack_description - The description to display.

CreateStack, createStack_displayName - The stack name to display.

CreateStack, createStack_embedHostDomains - The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

CreateStack, createStack_feedbackURL - The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

CreateStack, createStack_redirectURL - The URL that users are redirected to after their streaming session ends.

CreateStack, createStack_storageConnectors - The storage connectors to enable.

CreateStack, createStack_streamingExperienceSettings - The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

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

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

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

_ . : / = + \ - @

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

CreateStack, createStack_userSettings - The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

CreateStack, createStack_name - The name of the stack.

Request Lenses

createStack_accessEndpoints :: Lens' CreateStack (Maybe (NonEmpty AccessEndpoint)) Source #

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

createStack_applicationSettings :: Lens' CreateStack (Maybe ApplicationSettings) Source #

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

createStack_description :: Lens' CreateStack (Maybe Text) Source #

The description to display.

createStack_displayName :: Lens' CreateStack (Maybe Text) Source #

The stack name to display.

createStack_embedHostDomains :: Lens' CreateStack (Maybe (NonEmpty Text)) Source #

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

createStack_feedbackURL :: Lens' CreateStack (Maybe Text) Source #

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

createStack_redirectURL :: Lens' CreateStack (Maybe Text) Source #

The URL that users are redirected to after their streaming session ends.

createStack_storageConnectors :: Lens' CreateStack (Maybe [StorageConnector]) Source #

The storage connectors to enable.

createStack_streamingExperienceSettings :: Lens' CreateStack (Maybe StreamingExperienceSettings) Source #

The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

createStack_tags :: Lens' CreateStack (Maybe (HashMap Text Text)) Source #

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

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

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

_ . : / = + \ - @

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

createStack_userSettings :: Lens' CreateStack (Maybe (NonEmpty UserSetting)) Source #

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

createStack_name :: Lens' CreateStack Text Source #

The name of the stack.

Destructuring the Response

data CreateStackResponse Source #

See: newCreateStackResponse smart constructor.

Constructors

CreateStackResponse'
Fields stack :: Maybe Stack Information about the stack. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateStackResponse Source #

Arguments

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

Create a value of CreateStackResponse 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:stack:CreateStackResponse', createStackResponse_stack - Information about the stack.

$sel:httpStatus:CreateStackResponse', createStackResponse_httpStatus - The response's http status code.

Response Lenses

createStackResponse_stack :: Lens' CreateStackResponse (Maybe Stack) Source #

Information about the stack.

createStackResponse_httpStatus :: Lens' CreateStackResponse Int Source #

The response's http status code.