Amazonka.S3Outposts.CreateEndpoint

Creates an endpoint and associates it with the specified Outpost.

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

Related actions include:

• DeleteEndpoint
• ListEndpoints

Creating a Request

data CreateEndpoint

See: newCreateEndpoint smart constructor.

Constructors

CreateEndpoint'

Fields

• accessType :: Maybe EndpointAccessType

  The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

  Private is the default access type value.

• customerOwnedIpv4Pool :: Maybe Text

  The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

• outpostId :: Text

  The ID of the Outposts.

• subnetId :: Text

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

• securityGroupId :: Text

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

Instances

ToJSON CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

toJSON :: CreateEndpoint -> Value

toEncoding :: CreateEndpoint -> Encoding

toJSONList :: [CreateEndpoint] -> Value

toEncodingList :: [CreateEndpoint] -> Encoding

ToHeaders CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

toHeaders :: CreateEndpoint -> [Header]

ToPath CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

toPath :: CreateEndpoint -> ByteString

ToQuery CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

toQuery :: CreateEndpoint -> QueryString

AWSRequest CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Associated Types

type AWSResponse CreateEndpoint

Methods

request :: (Service -> Service) -> CreateEndpoint -> Request CreateEndpoint

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEndpoint)))

Generic CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Associated Types

type Rep CreateEndpoint :: Type -> Type

Methods

from :: CreateEndpoint -> Rep CreateEndpoint x

to :: Rep CreateEndpoint x -> CreateEndpoint

Read CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

readsPrec :: Int -> ReadS CreateEndpoint

readList :: ReadS [CreateEndpoint]

readPrec :: ReadPrec CreateEndpoint

readListPrec :: ReadPrec [CreateEndpoint]

Show CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

showsPrec :: Int -> CreateEndpoint -> ShowS

show :: CreateEndpoint -> String

showList :: [CreateEndpoint] -> ShowS

NFData CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

rnf :: CreateEndpoint -> ()

Eq CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

(==) :: CreateEndpoint -> CreateEndpoint -> Bool

(/=) :: CreateEndpoint -> CreateEndpoint -> Bool

Hashable CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

hashWithSalt :: Int -> CreateEndpoint -> Int

hash :: CreateEndpoint -> Int

type AWSResponse CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

type AWSResponse CreateEndpoint = CreateEndpointResponse

type Rep CreateEndpoint

Defined in Amazonka.S3Outposts.CreateEndpoint

type Rep CreateEndpoint = D1 ('MetaData "CreateEndpoint" "Amazonka.S3Outposts.CreateEndpoint" "amazonka-s3outposts-2.0-FXtMY52WtY5H7dQDI4FXOO" '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)))))

newCreateEndpoint

Arguments

:: Text

$sel:outpostId:CreateEndpoint'

-> Text

CreateEndpoint

-> Text

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:

CreateEndpoint, createEndpoint_accessType - The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

CreateEndpoint, createEndpoint_customerOwnedIpv4Pool - The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

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

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

CreateEndpoint, createEndpoint_securityGroupId - The ID of the security group to use with the endpoint.

Request Lenses

createEndpoint_accessType :: Lens' CreateEndpoint (Maybe EndpointAccessType)

The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

createEndpoint_customerOwnedIpv4Pool :: Lens' CreateEndpoint (Maybe Text)

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

createEndpoint_outpostId :: Lens' CreateEndpoint Text

The ID of the Outposts.

createEndpoint_subnetId :: Lens' CreateEndpoint Text

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

createEndpoint_securityGroupId :: Lens' CreateEndpoint Text

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

Destructuring the Response

data CreateEndpointResponse

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

Generic CreateEndpointResponse

Defined in Amazonka.S3Outposts.CreateEndpoint

Associated Types

type Rep CreateEndpointResponse :: Type -> Type

Methods

from :: CreateEndpointResponse -> Rep CreateEndpointResponse x

to :: Rep CreateEndpointResponse x -> CreateEndpointResponse

Read CreateEndpointResponse

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

readsPrec :: Int -> ReadS CreateEndpointResponse

readList :: ReadS [CreateEndpointResponse]

readPrec :: ReadPrec CreateEndpointResponse

readListPrec :: ReadPrec [CreateEndpointResponse]

Show CreateEndpointResponse

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

showsPrec :: Int -> CreateEndpointResponse -> ShowS

show :: CreateEndpointResponse -> String

showList :: [CreateEndpointResponse] -> ShowS

NFData CreateEndpointResponse

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

rnf :: CreateEndpointResponse -> ()

Eq CreateEndpointResponse

Defined in Amazonka.S3Outposts.CreateEndpoint

Methods

(==) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool

(/=) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool

type Rep CreateEndpointResponse

Defined in Amazonka.S3Outposts.CreateEndpoint

type Rep CreateEndpointResponse = D1 ('MetaData "CreateEndpointResponse" "Amazonka.S3Outposts.CreateEndpoint" "amazonka-s3outposts-2.0-FXtMY52WtY5H7dQDI4FXOO" '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

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:

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)

The Amazon Resource Name (ARN) of the endpoint.

createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int

The response's http status code.