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.CreateVerifiedAccessEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Synopsis

Creating a Request

data CreateVerifiedAccessEndpoint Source #

See: newCreateVerifiedAccessEndpoint smart constructor.

Constructors

CreateVerifiedAccessEndpoint'

Fields

clientToken :: Maybe Text
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
description :: Maybe Text
A description for the Amazon Web Services Verified Access 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.
loadBalancerOptions :: Maybe CreateVerifiedAccessEndpointLoadBalancerOptions
The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.
networkInterfaceOptions :: Maybe CreateVerifiedAccessEndpointEniOptions
The network interface details if creating the Amazon Web Services Verified Access endpoint as network-interfacetype.
policyDocument :: Maybe Text
The Amazon Web Services Verified Access policy document.
securityGroupIds :: Maybe [Text]
The Amazon EC2 security groups to associate with the Amazon Web Services Verified Access endpoint.
tagSpecifications :: Maybe [TagSpecification]
The tags to assign to the Amazon Web Services Verified Access endpoint.
verifiedAccessGroupId :: Text
The ID of the Verified Access group to associate the endpoint with.
endpointType :: VerifiedAccessEndpointType
The type of Amazon Web Services Verified Access endpoint to create.
attachmentType :: VerifiedAccessEndpointAttachmentType
The Amazon Web Services network component Verified Access attaches to.
domainCertificateArn :: Text
The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.
applicationDomain :: Text
The DNS name for users to reach your application.
endpointDomainPrefix :: Text
A custom identifier that gets prepended to a DNS name that is generated for the endpoint.

Instances

Instances details

ToHeaders CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods toHeaders :: CreateVerifiedAccessEndpoint -> [Header] #
ToPath CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods toPath :: CreateVerifiedAccessEndpoint -> ByteString #
ToQuery CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods toQuery :: CreateVerifiedAccessEndpoint -> QueryString #
AWSRequest CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Associated Types type AWSResponse CreateVerifiedAccessEndpoint # Methods request :: (Service -> Service) -> CreateVerifiedAccessEndpoint -> Request CreateVerifiedAccessEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateVerifiedAccessEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateVerifiedAccessEndpoint))) #
Generic CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Associated Types type Rep CreateVerifiedAccessEndpoint :: Type -> Type # Methods from :: CreateVerifiedAccessEndpoint -> Rep CreateVerifiedAccessEndpoint x # to :: Rep CreateVerifiedAccessEndpoint x -> CreateVerifiedAccessEndpoint #
Read CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods readsPrec :: Int -> ReadS CreateVerifiedAccessEndpoint # readList :: ReadS [CreateVerifiedAccessEndpoint] # readPrec :: ReadPrec CreateVerifiedAccessEndpoint # readListPrec :: ReadPrec [CreateVerifiedAccessEndpoint] #
Show CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods showsPrec :: Int -> CreateVerifiedAccessEndpoint -> ShowS # show :: CreateVerifiedAccessEndpoint -> String # showList :: [CreateVerifiedAccessEndpoint] -> ShowS #
NFData CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods rnf :: CreateVerifiedAccessEndpoint -> () #
Eq CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods (==) :: CreateVerifiedAccessEndpoint -> CreateVerifiedAccessEndpoint -> Bool # (/=) :: CreateVerifiedAccessEndpoint -> CreateVerifiedAccessEndpoint -> Bool #
Hashable CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint Methods hashWithSalt :: Int -> CreateVerifiedAccessEndpoint -> Int # hash :: CreateVerifiedAccessEndpoint -> Int #
type AWSResponse CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint type AWSResponse CreateVerifiedAccessEndpoint = CreateVerifiedAccessEndpointResponse
type Rep CreateVerifiedAccessEndpoint Source #
Instance details Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint type Rep CreateVerifiedAccessEndpoint = D1 ('MetaData "CreateVerifiedAccessEndpoint" "Amazonka.EC2.CreateVerifiedAccessEndpoint" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateVerifiedAccessEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "loadBalancerOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateVerifiedAccessEndpointLoadBalancerOptions)) :: S1 ('MetaSel ('Just "networkInterfaceOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateVerifiedAccessEndpointEniOptions))) :: (S1 ('MetaSel ('Just "policyDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])) :: (S1 ('MetaSel ('Just "verifiedAccessGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VerifiedAccessEndpointType))) :: ((S1 ('MetaSel ('Just "attachmentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VerifiedAccessEndpointAttachmentType) :: S1 ('MetaSel ('Just "domainCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "applicationDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endpointDomainPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateVerifiedAccessEndpoint Source #

Arguments

:: Text	`CreateVerifiedAccessEndpoint`
-> VerifiedAccessEndpointType	`CreateVerifiedAccessEndpoint`
-> VerifiedAccessEndpointAttachmentType	`CreateVerifiedAccessEndpoint`
-> Text	`CreateVerifiedAccessEndpoint`
-> Text	`CreateVerifiedAccessEndpoint`
-> Text	`$sel:endpointDomainPrefix:CreateVerifiedAccessEndpoint'`
-> CreateVerifiedAccessEndpoint

Create a value of CreateVerifiedAccessEndpoint 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:

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_clientToken - A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_description - A description for the Amazon Web Services Verified Access endpoint.

$sel:dryRun:CreateVerifiedAccessEndpoint', createVerifiedAccessEndpoint_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.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_loadBalancerOptions - The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_networkInterfaceOptions - The network interface details if creating the Amazon Web Services Verified Access endpoint as network-interfacetype.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_policyDocument - The Amazon Web Services Verified Access policy document.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_securityGroupIds - The Amazon EC2 security groups to associate with the Amazon Web Services Verified Access endpoint.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_tagSpecifications - The tags to assign to the Amazon Web Services Verified Access endpoint.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_verifiedAccessGroupId - The ID of the Verified Access group to associate the endpoint with.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_endpointType - The type of Amazon Web Services Verified Access endpoint to create.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_attachmentType - The Amazon Web Services network component Verified Access attaches to.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_domainCertificateArn - The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.

CreateVerifiedAccessEndpoint, createVerifiedAccessEndpoint_applicationDomain - The DNS name for users to reach your application.

$sel:endpointDomainPrefix:CreateVerifiedAccessEndpoint', createVerifiedAccessEndpoint_endpointDomainPrefix - A custom identifier that gets prepended to a DNS name that is generated for the endpoint.

Request Lenses

createVerifiedAccessEndpoint_clientToken :: Lens' CreateVerifiedAccessEndpoint (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

createVerifiedAccessEndpoint_description :: Lens' CreateVerifiedAccessEndpoint (Maybe Text) Source #

A description for the Amazon Web Services Verified Access endpoint.

createVerifiedAccessEndpoint_dryRun :: Lens' CreateVerifiedAccessEndpoint (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.

createVerifiedAccessEndpoint_loadBalancerOptions :: Lens' CreateVerifiedAccessEndpoint (Maybe CreateVerifiedAccessEndpointLoadBalancerOptions) Source #

The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.

createVerifiedAccessEndpoint_networkInterfaceOptions :: Lens' CreateVerifiedAccessEndpoint (Maybe CreateVerifiedAccessEndpointEniOptions) Source #

The network interface details if creating the Amazon Web Services Verified Access endpoint as network-interfacetype.

createVerifiedAccessEndpoint_policyDocument :: Lens' CreateVerifiedAccessEndpoint (Maybe Text) Source #

The Amazon Web Services Verified Access policy document.

createVerifiedAccessEndpoint_securityGroupIds :: Lens' CreateVerifiedAccessEndpoint (Maybe [Text]) Source #

The Amazon EC2 security groups to associate with the Amazon Web Services Verified Access endpoint.

createVerifiedAccessEndpoint_tagSpecifications :: Lens' CreateVerifiedAccessEndpoint (Maybe [TagSpecification]) Source #

The tags to assign to the Amazon Web Services Verified Access endpoint.

createVerifiedAccessEndpoint_verifiedAccessGroupId :: Lens' CreateVerifiedAccessEndpoint Text Source #

The ID of the Verified Access group to associate the endpoint with.

createVerifiedAccessEndpoint_endpointType :: Lens' CreateVerifiedAccessEndpoint VerifiedAccessEndpointType Source #

The type of Amazon Web Services Verified Access endpoint to create.

createVerifiedAccessEndpoint_attachmentType :: Lens' CreateVerifiedAccessEndpoint VerifiedAccessEndpointAttachmentType Source #

The Amazon Web Services network component Verified Access attaches to.

createVerifiedAccessEndpoint_domainCertificateArn :: Lens' CreateVerifiedAccessEndpoint Text Source #

The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.

createVerifiedAccessEndpoint_applicationDomain :: Lens' CreateVerifiedAccessEndpoint Text Source #

The DNS name for users to reach your application.

createVerifiedAccessEndpoint_endpointDomainPrefix :: Lens' CreateVerifiedAccessEndpoint Text Source #

A custom identifier that gets prepended to a DNS name that is generated for the endpoint.

Destructuring the Response

data CreateVerifiedAccessEndpointResponse Source #

See: newCreateVerifiedAccessEndpointResponse smart constructor.

Constructors

CreateVerifiedAccessEndpointResponse'
Fields verifiedAccessEndpoint :: Maybe VerifiedAccessEndpoint The ID of the Amazon Web Services Verified Access endpoint. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateVerifiedAccessEndpointResponse Source #

Arguments

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

Create a value of CreateVerifiedAccessEndpointResponse 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:verifiedAccessEndpoint:CreateVerifiedAccessEndpointResponse', createVerifiedAccessEndpointResponse_verifiedAccessEndpoint - The ID of the Amazon Web Services Verified Access endpoint.

$sel:httpStatus:CreateVerifiedAccessEndpointResponse', createVerifiedAccessEndpointResponse_httpStatus - The response's http status code.

Response Lenses

createVerifiedAccessEndpointResponse_verifiedAccessEndpoint :: Lens' CreateVerifiedAccessEndpointResponse (Maybe VerifiedAccessEndpoint) Source #

The ID of the Amazon Web Services Verified Access endpoint.

createVerifiedAccessEndpointResponse_httpStatus :: Lens' CreateVerifiedAccessEndpointResponse Int Source #

The response's http status code.