create_verified_access_endpoint¶
Operation¶
async
¶
create_verified_access_endpoint(input: CreateVerifiedAccessEndpointInput, plugins: list[Plugin] | None = None) -> CreateVerifiedAccessEndpointOutput
An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateVerifiedAccessEndpointInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateVerifiedAccessEndpointOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateVerifiedAccessEndpointInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_domain: str | None = ...
The DNS name for users to reach your application.
class-attribute
instance-attribute
¶
attachment_type: str | None = ...
The type of attachment.
class-attribute
instance-attribute
¶
The CIDR options. This parameter is required if the endpoint type is
cidr.
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the Verified Access endpoint.
class-attribute
instance-attribute
¶
domain_certificate_arn: str | None = ...
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.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
endpoint_domain_prefix: str | None = ...
A custom identifier that is prepended to the DNS name that is generated for the endpoint.
class-attribute
instance-attribute
¶
endpoint_type: str | None = ...
The type of Verified Access endpoint to create.
class-attribute
instance-attribute
¶
The load balancer details. This parameter is required if the endpoint
type is load-balancer.
class-attribute
instance-attribute
¶
The network interface details. This parameter is required if the
endpoint type is network-interface.
class-attribute
instance-attribute
¶
policy_document: str | None = ...
The Verified Access policy document.
class-attribute
instance-attribute
¶
The RDS details. This parameter is required if the endpoint type is
rds.
class-attribute
instance-attribute
¶
The IDs of the security groups to associate with the Verified Access
endpoint. Required if AttachmentType is set to vpc.
class-attribute
instance-attribute
¶
The options for server side encryption.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateVerifiedAccessEndpointOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
Details about the Verified Access endpoint.