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.EC2.ModifyVpcEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.

Synopsis

data ModifyVpcEndpoint = ModifyVpcEndpoint' {
- addRouteTableIds :: Maybe [Text]
- addSecurityGroupIds :: Maybe [Text]
- addSubnetIds :: Maybe [Text]
- dnsOptions :: Maybe DnsOptionsSpecification
- dryRun :: Maybe Bool
- ipAddressType :: Maybe IpAddressType
- policyDocument :: Maybe Text
- privateDnsEnabled :: Maybe Bool
- removeRouteTableIds :: Maybe [Text]
- removeSecurityGroupIds :: Maybe [Text]
- removeSubnetIds :: Maybe [Text]
- resetPolicy :: Maybe Bool
- vpcEndpointId :: Text
}
newModifyVpcEndpoint :: Text -> ModifyVpcEndpoint
modifyVpcEndpoint_addRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
modifyVpcEndpoint_addSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
modifyVpcEndpoint_addSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
modifyVpcEndpoint_dnsOptions :: Lens' ModifyVpcEndpoint (Maybe DnsOptionsSpecification)
modifyVpcEndpoint_dryRun :: Lens' ModifyVpcEndpoint (Maybe Bool)
modifyVpcEndpoint_ipAddressType :: Lens' ModifyVpcEndpoint (Maybe IpAddressType)
modifyVpcEndpoint_policyDocument :: Lens' ModifyVpcEndpoint (Maybe Text)
modifyVpcEndpoint_privateDnsEnabled :: Lens' ModifyVpcEndpoint (Maybe Bool)
modifyVpcEndpoint_removeRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
modifyVpcEndpoint_removeSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
modifyVpcEndpoint_removeSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
modifyVpcEndpoint_resetPolicy :: Lens' ModifyVpcEndpoint (Maybe Bool)
modifyVpcEndpoint_vpcEndpointId :: Lens' ModifyVpcEndpoint Text
data ModifyVpcEndpointResponse = ModifyVpcEndpointResponse' {
- return' :: Maybe Bool
- httpStatus :: Int
}
newModifyVpcEndpointResponse :: Int -> ModifyVpcEndpointResponse
modifyVpcEndpointResponse_return :: Lens' ModifyVpcEndpointResponse (Maybe Bool)
modifyVpcEndpointResponse_httpStatus :: Lens' ModifyVpcEndpointResponse Int

Creating a Request

data ModifyVpcEndpoint Source #

Contains the parameters for ModifyVpcEndpoint.

See: newModifyVpcEndpoint smart constructor.

Constructors

ModifyVpcEndpoint'

Fields

addRouteTableIds :: Maybe [Text]
(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
addSecurityGroupIds :: Maybe [Text]
(Interface endpoint) One or more security group IDs to associate with the network interface.
addSubnetIds :: Maybe [Text]
(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
dnsOptions :: Maybe DnsOptionsSpecification
The DNS options for the endpoint.
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ipAddressType :: Maybe IpAddressType
The IP address type for the endpoint.
policyDocument :: Maybe Text
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
privateDnsEnabled :: Maybe Bool
(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
removeRouteTableIds :: Maybe [Text]
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
removeSecurityGroupIds :: Maybe [Text]
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
removeSubnetIds :: Maybe [Text]
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
resetPolicy :: Maybe Bool
(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
vpcEndpointId :: Text
The ID of the endpoint.

Instances

Instances details

ToHeaders ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods toHeaders :: ModifyVpcEndpoint -> [Header] #
ToPath ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods toPath :: ModifyVpcEndpoint -> ByteString #
ToQuery ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods toQuery :: ModifyVpcEndpoint -> QueryString #
AWSRequest ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Associated Types type AWSResponse ModifyVpcEndpoint # Methods request :: (Service -> Service) -> ModifyVpcEndpoint -> Request ModifyVpcEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyVpcEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyVpcEndpoint))) #
Generic ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Associated Types type Rep ModifyVpcEndpoint :: Type -> Type # Methods from :: ModifyVpcEndpoint -> Rep ModifyVpcEndpoint x # to :: Rep ModifyVpcEndpoint x -> ModifyVpcEndpoint #
Read ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods readsPrec :: Int -> ReadS ModifyVpcEndpoint # readList :: ReadS [ModifyVpcEndpoint] # readPrec :: ReadPrec ModifyVpcEndpoint # readListPrec :: ReadPrec [ModifyVpcEndpoint] #
Show ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods showsPrec :: Int -> ModifyVpcEndpoint -> ShowS # show :: ModifyVpcEndpoint -> String # showList :: [ModifyVpcEndpoint] -> ShowS #
NFData ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods rnf :: ModifyVpcEndpoint -> () #
Eq ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods (==) :: ModifyVpcEndpoint -> ModifyVpcEndpoint -> Bool # (/=) :: ModifyVpcEndpoint -> ModifyVpcEndpoint -> Bool #
Hashable ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint Methods hashWithSalt :: Int -> ModifyVpcEndpoint -> Int # hash :: ModifyVpcEndpoint -> Int #
type AWSResponse ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint type AWSResponse ModifyVpcEndpoint = ModifyVpcEndpointResponse
type Rep ModifyVpcEndpoint Source #
Instance details Defined in Amazonka.EC2.ModifyVpcEndpoint type Rep ModifyVpcEndpoint = D1 ('MetaData "ModifyVpcEndpoint" "Amazonka.EC2.ModifyVpcEndpoint" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyVpcEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "addRouteTableIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "addSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "addSubnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "dnsOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DnsOptionsSpecification)) :: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType))))) :: ((S1 ('MetaSel ('Just "policyDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "privateDnsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "removeRouteTableIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "removeSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "removeSubnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "resetPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "vpcEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyVpcEndpoint Source #

Arguments

:: Text	`ModifyVpcEndpoint`
-> ModifyVpcEndpoint

Create a value of ModifyVpcEndpoint 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:addRouteTableIds:ModifyVpcEndpoint', modifyVpcEndpoint_addRouteTableIds - (Gateway endpoint) One or more route tables IDs to associate with the endpoint.

$sel:addSecurityGroupIds:ModifyVpcEndpoint', modifyVpcEndpoint_addSecurityGroupIds - (Interface endpoint) One or more security group IDs to associate with the network interface.

$sel:addSubnetIds:ModifyVpcEndpoint', modifyVpcEndpoint_addSubnetIds - (Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

ModifyVpcEndpoint, modifyVpcEndpoint_dnsOptions - The DNS options for the endpoint.

$sel:dryRun:ModifyVpcEndpoint', modifyVpcEndpoint_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

ModifyVpcEndpoint, modifyVpcEndpoint_ipAddressType - The IP address type for the endpoint.

ModifyVpcEndpoint, modifyVpcEndpoint_policyDocument - (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.

ModifyVpcEndpoint, modifyVpcEndpoint_privateDnsEnabled - (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.

$sel:removeRouteTableIds:ModifyVpcEndpoint', modifyVpcEndpoint_removeRouteTableIds - (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

$sel:removeSecurityGroupIds:ModifyVpcEndpoint', modifyVpcEndpoint_removeSecurityGroupIds - (Interface endpoint) One or more security group IDs to disassociate from the network interface.

$sel:removeSubnetIds:ModifyVpcEndpoint', modifyVpcEndpoint_removeSubnetIds - (Interface endpoint) One or more subnets IDs in which to remove the endpoint.

$sel:resetPolicy:ModifyVpcEndpoint', modifyVpcEndpoint_resetPolicy - (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.

ModifyVpcEndpoint, modifyVpcEndpoint_vpcEndpointId - The ID of the endpoint.

Request Lenses

modifyVpcEndpoint_addRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #

(Gateway endpoint) One or more route tables IDs to associate with the endpoint.

modifyVpcEndpoint_addSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #

(Interface endpoint) One or more security group IDs to associate with the network interface.

modifyVpcEndpoint_addSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #

(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

modifyVpcEndpoint_dnsOptions :: Lens' ModifyVpcEndpoint (Maybe DnsOptionsSpecification) Source #

The DNS options for the endpoint.

modifyVpcEndpoint_dryRun :: Lens' ModifyVpcEndpoint (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

modifyVpcEndpoint_ipAddressType :: Lens' ModifyVpcEndpoint (Maybe IpAddressType) Source #

The IP address type for the endpoint.

modifyVpcEndpoint_policyDocument :: Lens' ModifyVpcEndpoint (Maybe Text) Source #

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.

modifyVpcEndpoint_privateDnsEnabled :: Lens' ModifyVpcEndpoint (Maybe Bool) Source #

(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.

modifyVpcEndpoint_removeRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #

(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

modifyVpcEndpoint_removeSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #

(Interface endpoint) One or more security group IDs to disassociate from the network interface.

modifyVpcEndpoint_removeSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #

(Interface endpoint) One or more subnets IDs in which to remove the endpoint.

modifyVpcEndpoint_resetPolicy :: Lens' ModifyVpcEndpoint (Maybe Bool) Source #

(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.

modifyVpcEndpoint_vpcEndpointId :: Lens' ModifyVpcEndpoint Text Source #

The ID of the endpoint.

Destructuring the Response

data ModifyVpcEndpointResponse Source #

See: newModifyVpcEndpointResponse smart constructor.

Constructors

ModifyVpcEndpointResponse'
Fields return' :: Maybe Bool Returns `true` if the request succeeds; otherwise, it returns an error. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newModifyVpcEndpointResponse Source #

Arguments

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

Create a value of ModifyVpcEndpointResponse 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:return':ModifyVpcEndpointResponse', modifyVpcEndpointResponse_return - Returns true if the request succeeds; otherwise, it returns an error.

$sel:httpStatus:ModifyVpcEndpointResponse', modifyVpcEndpointResponse_httpStatus - The response's http status code.

Response Lenses

modifyVpcEndpointResponse_return :: Lens' ModifyVpcEndpointResponse (Maybe Bool) Source #

Returns true if the request succeeds; otherwise, it returns an error.

modifyVpcEndpointResponse_httpStatus :: Lens' ModifyVpcEndpointResponse Int Source #

The response's http status code.