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 |
An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
Synopsis
- data CreateVerifiedAccessEndpoint = CreateVerifiedAccessEndpoint' {
- clientToken :: Maybe Text
- description :: Maybe Text
- dryRun :: Maybe Bool
- loadBalancerOptions :: Maybe CreateVerifiedAccessEndpointLoadBalancerOptions
- networkInterfaceOptions :: Maybe CreateVerifiedAccessEndpointEniOptions
- policyDocument :: Maybe Text
- securityGroupIds :: Maybe [Text]
- tagSpecifications :: Maybe [TagSpecification]
- verifiedAccessGroupId :: Text
- endpointType :: VerifiedAccessEndpointType
- attachmentType :: VerifiedAccessEndpointAttachmentType
- domainCertificateArn :: Text
- applicationDomain :: Text
- endpointDomainPrefix :: Text
- newCreateVerifiedAccessEndpoint :: Text -> VerifiedAccessEndpointType -> VerifiedAccessEndpointAttachmentType -> Text -> Text -> Text -> CreateVerifiedAccessEndpoint
- createVerifiedAccessEndpoint_clientToken :: Lens' CreateVerifiedAccessEndpoint (Maybe Text)
- createVerifiedAccessEndpoint_description :: Lens' CreateVerifiedAccessEndpoint (Maybe Text)
- createVerifiedAccessEndpoint_dryRun :: Lens' CreateVerifiedAccessEndpoint (Maybe Bool)
- createVerifiedAccessEndpoint_loadBalancerOptions :: Lens' CreateVerifiedAccessEndpoint (Maybe CreateVerifiedAccessEndpointLoadBalancerOptions)
- createVerifiedAccessEndpoint_networkInterfaceOptions :: Lens' CreateVerifiedAccessEndpoint (Maybe CreateVerifiedAccessEndpointEniOptions)
- createVerifiedAccessEndpoint_policyDocument :: Lens' CreateVerifiedAccessEndpoint (Maybe Text)
- createVerifiedAccessEndpoint_securityGroupIds :: Lens' CreateVerifiedAccessEndpoint (Maybe [Text])
- createVerifiedAccessEndpoint_tagSpecifications :: Lens' CreateVerifiedAccessEndpoint (Maybe [TagSpecification])
- createVerifiedAccessEndpoint_verifiedAccessGroupId :: Lens' CreateVerifiedAccessEndpoint Text
- createVerifiedAccessEndpoint_endpointType :: Lens' CreateVerifiedAccessEndpoint VerifiedAccessEndpointType
- createVerifiedAccessEndpoint_attachmentType :: Lens' CreateVerifiedAccessEndpoint VerifiedAccessEndpointAttachmentType
- createVerifiedAccessEndpoint_domainCertificateArn :: Lens' CreateVerifiedAccessEndpoint Text
- createVerifiedAccessEndpoint_applicationDomain :: Lens' CreateVerifiedAccessEndpoint Text
- createVerifiedAccessEndpoint_endpointDomainPrefix :: Lens' CreateVerifiedAccessEndpoint Text
- data CreateVerifiedAccessEndpointResponse = CreateVerifiedAccessEndpointResponse' {}
- newCreateVerifiedAccessEndpointResponse :: Int -> CreateVerifiedAccessEndpointResponse
- createVerifiedAccessEndpointResponse_verifiedAccessEndpoint :: Lens' CreateVerifiedAccessEndpointResponse (Maybe VerifiedAccessEndpoint)
- createVerifiedAccessEndpointResponse_httpStatus :: Lens' CreateVerifiedAccessEndpointResponse Int
Creating a Request
data CreateVerifiedAccessEndpoint Source #
See: newCreateVerifiedAccessEndpoint
smart constructor.
CreateVerifiedAccessEndpoint' | |
|
Instances
newCreateVerifiedAccessEndpoint Source #
:: Text | |
-> VerifiedAccessEndpointType | |
-> VerifiedAccessEndpointAttachmentType | |
-> Text | |
-> Text | |
-> Text | |
-> 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-balancer
type.
CreateVerifiedAccessEndpoint
, createVerifiedAccessEndpoint_networkInterfaceOptions
- The network interface details if creating the Amazon Web Services
Verified Access endpoint as network-interface
type.
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-balancer
type.
createVerifiedAccessEndpoint_networkInterfaceOptions :: Lens' CreateVerifiedAccessEndpoint (Maybe CreateVerifiedAccessEndpointEniOptions) Source #
The network interface details if creating the Amazon Web Services
Verified Access endpoint as network-interface
type.
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.
CreateVerifiedAccessEndpointResponse' | |
|
Instances
Generic CreateVerifiedAccessEndpointResponse Source # | |
Read CreateVerifiedAccessEndpointResponse Source # | |
Show CreateVerifiedAccessEndpointResponse Source # | |
NFData CreateVerifiedAccessEndpointResponse Source # | |
Defined in Amazonka.EC2.CreateVerifiedAccessEndpoint rnf :: CreateVerifiedAccessEndpointResponse -> () # | |
Eq CreateVerifiedAccessEndpointResponse Source # | |
type Rep CreateVerifiedAccessEndpointResponse Source # | |
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 #
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.