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.WorkSpacesWeb.CreateNetworkSettings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

Synopsis

data CreateNetworkSettings = CreateNetworkSettings' {
- clientToken :: Maybe Text
- tags :: Maybe [Sensitive Tag]
- securityGroupIds :: NonEmpty Text
- subnetIds :: NonEmpty Text
- vpcId :: Text
}
newCreateNetworkSettings :: NonEmpty Text -> NonEmpty Text -> Text -> CreateNetworkSettings
createNetworkSettings_clientToken :: Lens' CreateNetworkSettings (Maybe Text)
createNetworkSettings_tags :: Lens' CreateNetworkSettings (Maybe [Tag])
createNetworkSettings_securityGroupIds :: Lens' CreateNetworkSettings (NonEmpty Text)
createNetworkSettings_subnetIds :: Lens' CreateNetworkSettings (NonEmpty Text)
createNetworkSettings_vpcId :: Lens' CreateNetworkSettings Text
data CreateNetworkSettingsResponse = CreateNetworkSettingsResponse' {
- httpStatus :: Int
- networkSettingsArn :: Text
}
newCreateNetworkSettingsResponse :: Int -> Text -> CreateNetworkSettingsResponse
createNetworkSettingsResponse_httpStatus :: Lens' CreateNetworkSettingsResponse Int
createNetworkSettingsResponse_networkSettingsArn :: Lens' CreateNetworkSettingsResponse Text

Creating a Request

data CreateNetworkSettings Source #

See: newCreateNetworkSettings smart constructor.

Constructors

CreateNetworkSettings'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
tags :: Maybe [Sensitive Tag]
The tags to add to the network settings resource. A tag is a key-value pair.
securityGroupIds :: NonEmpty Text
One or more security groups used to control access from streaming instances to your VPC.
subnetIds :: NonEmpty Text
The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
vpcId :: Text
The VPC that streaming instances will connect to.

Instances

Instances details

ToJSON CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods toJSON :: CreateNetworkSettings -> Value # toEncoding :: CreateNetworkSettings -> Encoding # toJSONList :: [CreateNetworkSettings] -> Value # toEncodingList :: [CreateNetworkSettings] -> Encoding #
ToHeaders CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods toHeaders :: CreateNetworkSettings -> [Header] #
ToPath CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods toPath :: CreateNetworkSettings -> ByteString #
ToQuery CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods toQuery :: CreateNetworkSettings -> QueryString #
AWSRequest CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Associated Types type AWSResponse CreateNetworkSettings # Methods request :: (Service -> Service) -> CreateNetworkSettings -> Request CreateNetworkSettings # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateNetworkSettings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateNetworkSettings))) #
Generic CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Associated Types type Rep CreateNetworkSettings :: Type -> Type # Methods from :: CreateNetworkSettings -> Rep CreateNetworkSettings x # to :: Rep CreateNetworkSettings x -> CreateNetworkSettings #
Show CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods showsPrec :: Int -> CreateNetworkSettings -> ShowS # show :: CreateNetworkSettings -> String # showList :: [CreateNetworkSettings] -> ShowS #
NFData CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods rnf :: CreateNetworkSettings -> () #
Eq CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods (==) :: CreateNetworkSettings -> CreateNetworkSettings -> Bool # (/=) :: CreateNetworkSettings -> CreateNetworkSettings -> Bool #
Hashable CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods hashWithSalt :: Int -> CreateNetworkSettings -> Int # hash :: CreateNetworkSettings -> Int #
type AWSResponse CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings type AWSResponse CreateNetworkSettings = CreateNetworkSettingsResponse
type Rep CreateNetworkSettings Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings type Rep CreateNetworkSettings = D1 ('MetaData "CreateNetworkSettings" "Amazonka.WorkSpacesWeb.CreateNetworkSettings" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "CreateNetworkSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sensitive Tag]))) :: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateNetworkSettings Source #

Arguments

:: NonEmpty Text	`CreateNetworkSettings`
-> NonEmpty Text	`CreateNetworkSettings`
-> Text	`CreateNetworkSettings`
-> CreateNetworkSettings

Create a value of CreateNetworkSettings 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:clientToken:CreateNetworkSettings', createNetworkSettings_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

$sel:tags:CreateNetworkSettings', createNetworkSettings_tags - The tags to add to the network settings resource. A tag is a key-value pair.

CreateNetworkSettings, createNetworkSettings_securityGroupIds - One or more security groups used to control access from streaming instances to your VPC.

CreateNetworkSettings, createNetworkSettings_subnetIds - The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

CreateNetworkSettings, createNetworkSettings_vpcId - The VPC that streaming instances will connect to.

Request Lenses

createNetworkSettings_clientToken :: Lens' CreateNetworkSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createNetworkSettings_tags :: Lens' CreateNetworkSettings (Maybe [Tag]) Source #

The tags to add to the network settings resource. A tag is a key-value pair.

createNetworkSettings_securityGroupIds :: Lens' CreateNetworkSettings (NonEmpty Text) Source #

One or more security groups used to control access from streaming instances to your VPC.

createNetworkSettings_subnetIds :: Lens' CreateNetworkSettings (NonEmpty Text) Source #

The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

createNetworkSettings_vpcId :: Lens' CreateNetworkSettings Text Source #

The VPC that streaming instances will connect to.

Destructuring the Response

data CreateNetworkSettingsResponse Source #

See: newCreateNetworkSettingsResponse smart constructor.

Constructors

CreateNetworkSettingsResponse'
Fields httpStatus :: Int The response's http status code. networkSettingsArn :: Text The ARN of the network settings.

Instances

Instances details

Generic CreateNetworkSettingsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Associated Types type Rep CreateNetworkSettingsResponse :: Type -> Type # Methods from :: CreateNetworkSettingsResponse -> Rep CreateNetworkSettingsResponse x # to :: Rep CreateNetworkSettingsResponse x -> CreateNetworkSettingsResponse #
Read CreateNetworkSettingsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods readsPrec :: Int -> ReadS CreateNetworkSettingsResponse # readList :: ReadS [CreateNetworkSettingsResponse] # readPrec :: ReadPrec CreateNetworkSettingsResponse # readListPrec :: ReadPrec [CreateNetworkSettingsResponse] #
Show CreateNetworkSettingsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods showsPrec :: Int -> CreateNetworkSettingsResponse -> ShowS # show :: CreateNetworkSettingsResponse -> String # showList :: [CreateNetworkSettingsResponse] -> ShowS #
NFData CreateNetworkSettingsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods rnf :: CreateNetworkSettingsResponse -> () #
Eq CreateNetworkSettingsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings Methods (==) :: CreateNetworkSettingsResponse -> CreateNetworkSettingsResponse -> Bool # (/=) :: CreateNetworkSettingsResponse -> CreateNetworkSettingsResponse -> Bool #
type Rep CreateNetworkSettingsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateNetworkSettings type Rep CreateNetworkSettingsResponse = D1 ('MetaData "CreateNetworkSettingsResponse" "Amazonka.WorkSpacesWeb.CreateNetworkSettings" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "CreateNetworkSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "networkSettingsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateNetworkSettingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateNetworkSettingsResponse'`
-> Text	`CreateNetworkSettingsResponse`
-> CreateNetworkSettingsResponse

Create a value of CreateNetworkSettingsResponse 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:httpStatus:CreateNetworkSettingsResponse', createNetworkSettingsResponse_httpStatus - The response's http status code.

CreateNetworkSettingsResponse, createNetworkSettingsResponse_networkSettingsArn - The ARN of the network settings.

Response Lenses

createNetworkSettingsResponse_httpStatus :: Lens' CreateNetworkSettingsResponse Int Source #

The response's http status code.

createNetworkSettingsResponse_networkSettingsArn :: Lens' CreateNetworkSettingsResponse Text Source #

The ARN of the network settings.