CreateVerifiedAccessEndpoint - Amazon Elastic Compute Cloud

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 AWS network component Verified Access attaches to.

Type: String

Valid Values: vpc

Required: 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 AWS 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 is UnauthorizedOperation.

Type: Boolean

Required: No

EndpointDomainPrefix

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

Type: String

Required: Yes

EndpointType

The type of AWS Verified Access endpoint to create.

Type: String

Valid Values: load-balancer | network-interface

Required: Yes

LoadBalancerOptions

The load balancer details if creating the AWS Verified Access endpoint as load-balancertype.

Type: CreateVerifiedAccessEndpointLoadBalancerOptions object

Required: No

NetworkInterfaceOptions

The network interface details if creating the AWS Verified Access endpoint as network-interfacetype.

Type: CreateVerifiedAccessEndpointEniOptions object

Required: No

PolicyDocument

The AWS Verified Access policy document.

Type: String

Required: No

SecurityGroupId.N

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

Type: Array of strings

Required: No

TagSpecification.N

The tags to assign to the AWS 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

The ID of the AWS 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: