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 |
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:
Synopsis
- data CreateEndpoint = CreateEndpoint' {}
- 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.
CreateEndpoint' | |
|
Instances
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) Source #
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) Source #
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 Source #
The ID of the 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 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.
CreateEndpointResponse' | |
|
Instances
newCreateEndpointResponse Source #
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) Source #
The Amazon Resource Name (ARN) of the endpoint.
createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #
The response's http status code.