CreateVerifiedAccessEndpoint
An AWS Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- ApplicationDomain
-
The DNS name for users to reach your application.
Type: String
Required: Yes
- AttachmentType
-
The type of attachment.
Type: String
Valid Values:
vpcRequired: Yes
- ClientToken
-
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
Type: String
Required: No
- Description
-
A description for the Verified Access endpoint.
Type: String
Required: No
- DomainCertificateArn
-
The ARN of the public TLS/SSL certificate in AWS 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.
Type: String
Required: Yes
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- EndpointDomainPrefix
-
A custom identifier that is prepended to the DNS name that is generated for the endpoint.
Type: String
Required: Yes
- EndpointType
-
The type of Verified Access endpoint to create.
Type: String
Valid Values:
load-balancer | network-interfaceRequired: Yes
- LoadBalancerOptions
-
The load balancer details. This parameter is required if the endpoint type is
load-balancer.Type: CreateVerifiedAccessEndpointLoadBalancerOptions object
Required: No
- NetworkInterfaceOptions
-
The network interface details. This parameter is required if the endpoint type is
network-interface.Type: CreateVerifiedAccessEndpointEniOptions object
Required: No
- PolicyDocument
-
The Verified Access policy document.
Type: String
Required: No
- SecurityGroupId.N
-
The IDs of the security groups to associate with the Verified Access endpoint. Required if
AttachmentTypeis set tovpc.Type: Array of strings
Required: No
- SseSpecification
-
The options for server side encryption.
Type: VerifiedAccessSseSpecificationRequest object
Required: No
- TagSpecification.N
-
The tags to assign to the Verified Access endpoint.
Type: Array of TagSpecification objects
Required: No
- VerifiedAccessGroupId
-
The ID of the Verified Access group to associate the endpoint with.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- verifiedAccessEndpoint
-
Details about the Verified Access endpoint.
Type: VerifiedAccessEndpoint object
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
