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.OpenSearchServerless.CreateVpcEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Synopsis

data CreateVpcEndpoint = CreateVpcEndpoint' {
- clientToken :: Maybe Text
- securityGroupIds :: Maybe (NonEmpty Text)
- name :: Text
- subnetIds :: NonEmpty Text
- vpcId :: Text
}
newCreateVpcEndpoint :: Text -> NonEmpty Text -> Text -> CreateVpcEndpoint
createVpcEndpoint_clientToken :: Lens' CreateVpcEndpoint (Maybe Text)
createVpcEndpoint_securityGroupIds :: Lens' CreateVpcEndpoint (Maybe (NonEmpty Text))
createVpcEndpoint_name :: Lens' CreateVpcEndpoint Text
createVpcEndpoint_subnetIds :: Lens' CreateVpcEndpoint (NonEmpty Text)
createVpcEndpoint_vpcId :: Lens' CreateVpcEndpoint Text
data CreateVpcEndpointResponse = CreateVpcEndpointResponse' {
- createVpcEndpointDetail :: Maybe CreateVpcEndpointDetail
- httpStatus :: Int
}
newCreateVpcEndpointResponse :: Int -> CreateVpcEndpointResponse
createVpcEndpointResponse_createVpcEndpointDetail :: Lens' CreateVpcEndpointResponse (Maybe CreateVpcEndpointDetail)
createVpcEndpointResponse_httpStatus :: Lens' CreateVpcEndpointResponse Int

Creating a Request

data CreateVpcEndpoint Source #

See: newCreateVpcEndpoint smart constructor.

Constructors

CreateVpcEndpoint'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier to ensure idempotency of the request.
securityGroupIds :: Maybe (NonEmpty Text)
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
name :: Text
The name of the interface endpoint.
subnetIds :: NonEmpty Text
The ID of one or more subnets from which you'll access OpenSearch Serverless.
vpcId :: Text
The ID of the VPC from which you'll access OpenSearch Serverless.

Instances

Instances details

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

newCreateVpcEndpoint Source #

Arguments

:: Text	`CreateVpcEndpoint`
-> NonEmpty Text	`CreateVpcEndpoint`
-> Text	`CreateVpcEndpoint`
-> CreateVpcEndpoint

Create a value of CreateVpcEndpoint 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:CreateVpcEndpoint', createVpcEndpoint_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

CreateVpcEndpoint, createVpcEndpoint_securityGroupIds - The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

CreateVpcEndpoint, createVpcEndpoint_name - The name of the interface endpoint.

CreateVpcEndpoint, createVpcEndpoint_subnetIds - The ID of one or more subnets from which you'll access OpenSearch Serverless.

CreateVpcEndpoint, createVpcEndpoint_vpcId - The ID of the VPC from which you'll access OpenSearch Serverless.

Request Lenses

createVpcEndpoint_clientToken :: Lens' CreateVpcEndpoint (Maybe Text) Source #

Unique, case-sensitive identifier to ensure idempotency of the request.

createVpcEndpoint_securityGroupIds :: Lens' CreateVpcEndpoint (Maybe (NonEmpty Text)) Source #

The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

createVpcEndpoint_name :: Lens' CreateVpcEndpoint Text Source #

The name of the interface endpoint.

createVpcEndpoint_subnetIds :: Lens' CreateVpcEndpoint (NonEmpty Text) Source #

The ID of one or more subnets from which you'll access OpenSearch Serverless.

createVpcEndpoint_vpcId :: Lens' CreateVpcEndpoint Text Source #

The ID of the VPC from which you'll access OpenSearch Serverless.

Destructuring the Response

data CreateVpcEndpointResponse Source #

See: newCreateVpcEndpointResponse smart constructor.

Constructors

CreateVpcEndpointResponse'
Fields createVpcEndpointDetail :: Maybe CreateVpcEndpointDetail Details about the created interface VPC endpoint. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateVpcEndpointResponse Source #

Arguments

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

Create a value of CreateVpcEndpointResponse 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:createVpcEndpointDetail:CreateVpcEndpointResponse', createVpcEndpointResponse_createVpcEndpointDetail - Details about the created interface VPC endpoint.

$sel:httpStatus:CreateVpcEndpointResponse', createVpcEndpointResponse_httpStatus - The response's http status code.

Response Lenses

createVpcEndpointResponse_createVpcEndpointDetail :: Lens' CreateVpcEndpointResponse (Maybe CreateVpcEndpointDetail) Source #

Details about the created interface VPC endpoint.

createVpcEndpointResponse_httpStatus :: Lens' CreateVpcEndpointResponse Int Source #

The response's http status code.