Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3Outposts.CreateEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.

This action creates an endpoint and associates it with the specified Outposts.

It can take up to 5 minutes for this action to complete.

Related actions include:

Synopsis

data CreateEndpoint = CreateEndpoint' {
- accessType :: Maybe EndpointAccessType
- customerOwnedIpv4Pool :: Maybe Text
- outpostId :: Text
- subnetId :: Text
- securityGroupId :: Text
}
newCreateEndpoint :: Text -> Text -> Text -> CreateEndpoint
createEndpoint_accessType :: Lens' CreateEndpoint (Maybe EndpointAccessType)
createEndpoint_customerOwnedIpv4Pool :: Lens' CreateEndpoint (Maybe Text)
createEndpoint_outpostId :: Lens' CreateEndpoint Text
createEndpoint_subnetId :: Lens' CreateEndpoint Text
createEndpoint_securityGroupId :: Lens' CreateEndpoint Text
data CreateEndpointResponse = CreateEndpointResponse' {
- endpointArn :: Maybe Text
- httpStatus :: Int
}
newCreateEndpointResponse :: Int -> CreateEndpointResponse
createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text)
createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int

Creating a Request

data CreateEndpoint Source #

See: newCreateEndpoint smart constructor.

Constructors

CreateEndpoint'

Fields

accessType :: Maybe EndpointAccessType
The type of access for the on-premise network connectivity for the Outpost endpoint. To access the endpoint from an on-premises network, you must specify the access type and provide the customer owned IPv4 pool.
customerOwnedIpv4Pool :: Maybe Text
The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.
outpostId :: Text
The ID of the AWS Outposts.
subnetId :: Text
The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has the Amazon S3 on Outposts provisioned.
securityGroupId :: Text
The ID of the security group to use with the endpoint.

Instances

Instances details

Eq CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods (==) :: CreateEndpoint -> CreateEndpoint -> Bool # (/=) :: CreateEndpoint -> CreateEndpoint -> Bool #
Read CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods readsPrec :: Int -> ReadS CreateEndpoint # readList :: ReadS [CreateEndpoint] # readPrec :: ReadPrec CreateEndpoint # readListPrec :: ReadPrec [CreateEndpoint] #
Show CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods showsPrec :: Int -> CreateEndpoint -> ShowS # show :: CreateEndpoint -> String # showList :: [CreateEndpoint] -> ShowS #
Generic CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Associated Types type Rep CreateEndpoint :: Type -> Type # Methods from :: CreateEndpoint -> Rep CreateEndpoint x # to :: Rep CreateEndpoint x -> CreateEndpoint #
NFData CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods rnf :: CreateEndpoint -> () #
Hashable CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods hashWithSalt :: Int -> CreateEndpoint -> Int # hash :: CreateEndpoint -> Int #
ToJSON CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods toJSON :: CreateEndpoint -> Value # toEncoding :: CreateEndpoint -> Encoding # toJSONList :: [CreateEndpoint] -> Value # toEncodingList :: [CreateEndpoint] -> Encoding #
AWSRequest CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Associated Types type AWSResponse CreateEndpoint # Methods request :: CreateEndpoint -> Request CreateEndpoint # response :: MonadResource m => Logger -> Service -> Proxy CreateEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEndpoint))) #
ToHeaders CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods toHeaders :: CreateEndpoint -> [Header] #
ToPath CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods toPath :: CreateEndpoint -> ByteString #
ToQuery CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods toQuery :: CreateEndpoint -> QueryString #
type Rep CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint type Rep CreateEndpoint = D1 ('MetaData "CreateEndpoint" "Amazonka.S3Outposts.CreateEndpoint" "libZSservicesZSamazonka-s3outpostsZSamazonka-s3outposts" 'False) (C1 ('MetaCons "CreateEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointAccessType)) :: S1 ('MetaSel ('Just "customerOwnedIpv4Pool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "outpostId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "securityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateEndpoint Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint type AWSResponse CreateEndpoint = CreateEndpointResponse

newCreateEndpoint Source #

Arguments

:: Text	`$sel:outpostId:CreateEndpoint'`
-> Text	`$sel:subnetId:CreateEndpoint'`
-> Text	`$sel:securityGroupId:CreateEndpoint'`
-> CreateEndpoint

Create a value of CreateEndpoint 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:accessType:CreateEndpoint', createEndpoint_accessType - The type of access for the on-premise network connectivity for the Outpost endpoint. To access the endpoint from an on-premises network, you must specify the access type and provide the customer owned IPv4 pool.

$sel:customerOwnedIpv4Pool:CreateEndpoint', createEndpoint_customerOwnedIpv4Pool - The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.

$sel:outpostId:CreateEndpoint', createEndpoint_outpostId - The ID of the AWS Outposts.

$sel:subnetId:CreateEndpoint', createEndpoint_subnetId - The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has the Amazon S3 on Outposts provisioned.

$sel:securityGroupId:CreateEndpoint', createEndpoint_securityGroupId - The ID of the security group to use with the endpoint.

Request Lenses

createEndpoint_accessType :: Lens' CreateEndpoint (Maybe EndpointAccessType) Source #

The type of access for the on-premise network connectivity for the Outpost endpoint. To access the endpoint from an on-premises network, you must specify the access type and provide the customer owned IPv4 pool.

createEndpoint_customerOwnedIpv4Pool :: Lens' CreateEndpoint (Maybe Text) Source #

The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.

createEndpoint_outpostId :: Lens' CreateEndpoint Text Source #

The ID of the AWS Outposts.

createEndpoint_subnetId :: Lens' CreateEndpoint Text Source #

The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has the Amazon S3 on Outposts provisioned.

createEndpoint_securityGroupId :: Lens' CreateEndpoint Text Source #

The ID of the security group to use with the endpoint.

Destructuring the Response

data CreateEndpointResponse Source #

See: newCreateEndpointResponse smart constructor.

Constructors

CreateEndpointResponse'
Fields endpointArn :: Maybe Text The Amazon Resource Name (ARN) of the endpoint. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateEndpointResponse Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods (==) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool # (/=) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool #
Read CreateEndpointResponse Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods readsPrec :: Int -> ReadS CreateEndpointResponse # readList :: ReadS [CreateEndpointResponse] # readPrec :: ReadPrec CreateEndpointResponse # readListPrec :: ReadPrec [CreateEndpointResponse] #
Show CreateEndpointResponse Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods showsPrec :: Int -> CreateEndpointResponse -> ShowS # show :: CreateEndpointResponse -> String # showList :: [CreateEndpointResponse] -> ShowS #
Generic CreateEndpointResponse Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Associated Types type Rep CreateEndpointResponse :: Type -> Type # Methods from :: CreateEndpointResponse -> Rep CreateEndpointResponse x # to :: Rep CreateEndpointResponse x -> CreateEndpointResponse #
NFData CreateEndpointResponse Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint Methods rnf :: CreateEndpointResponse -> () #
type Rep CreateEndpointResponse Source #
Instance details Defined in Amazonka.S3Outposts.CreateEndpoint type Rep CreateEndpointResponse = D1 ('MetaData "CreateEndpointResponse" "Amazonka.S3Outposts.CreateEndpoint" "libZSservicesZSamazonka-s3outpostsZSamazonka-s3outposts" 'False) (C1 ('MetaCons "CreateEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEndpointResponse Source #

Arguments

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

Create a value of CreateEndpointResponse 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:endpointArn:CreateEndpointResponse', createEndpointResponse_endpointArn - The Amazon Resource Name (ARN) of the endpoint.

$sel:httpStatus:CreateEndpointResponse', createEndpointResponse_httpStatus - The response's http status code.

Response Lenses

createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the endpoint.

createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #

The response's http status code.