Skip to content

CreateVerifiedAccessEndpointRequest

Source code in docs_src/capo_ec2/types/create_verified_access_endpoint_request.py
class CreateVerifiedAccessEndpointRequest(TypedDict, closed=True):
    verified_access_group_id: NotRequired[
        "capo_ec2.types.verified_access_group_id.VerifiedAccessGroupId"
    ]
    """<p>The ID of the Verified Access group to associate the endpoint with.</p>"""
    endpoint_type: NotRequired[
        "capo_ec2.types.verified_access_endpoint_type.VerifiedAccessEndpointType"
    ]
    """<p>The type of Verified Access endpoint to create.</p>"""
    attachment_type: NotRequired[
        "capo_ec2.types.verified_access_endpoint_attachment_type.VerifiedAccessEndpointAttachmentType"
    ]
    """<p>The type of attachment.</p>"""
    domain_certificate_arn: NotRequired["capo_ec2.types.certificate_arn.CertificateArn"]
    """<p>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.</p>"""
    application_domain: NotRequired["capo_ec2.types.string.String"]
    """<p>The DNS name for users to reach your application.</p>"""
    endpoint_domain_prefix: NotRequired["capo_ec2.types.string.String"]
    """<p>A custom identifier that is prepended to the DNS name that is generated for the endpoint.</p>"""
    security_group_ids: NotRequired[
        "capo_ec2.types.security_group_id_list.SecurityGroupIdList"
    ]
    """<p>The IDs of the security groups to associate with the Verified Access endpoint. Required if <code>AttachmentType</code> is set to <code>vpc</code>.</p>"""
    load_balancer_options: NotRequired[
        "capo_ec2.types.create_verified_access_endpoint_load_balancer_options.CreateVerifiedAccessEndpointLoadBalancerOptions"
    ]
    """<p>The load balancer details. This parameter is required if the endpoint type is <code>load-balancer</code>.</p>"""
    network_interface_options: NotRequired[
        "capo_ec2.types.create_verified_access_endpoint_eni_options.CreateVerifiedAccessEndpointEniOptions"
    ]
    """<p>The network interface details. This parameter is required if the endpoint type is <code>network-interface</code>.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>A description for the Verified Access endpoint.</p>"""
    policy_document: NotRequired["capo_ec2.types.string.String"]
    """<p>The Verified Access policy document.</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to assign to the Verified Access endpoint.</p>"""
    client_token: NotRequired["capo_ec2.types.string.String"]
    """<p>A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    sse_specification: NotRequired[
        "capo_ec2.types.verified_access_sse_specification_request.VerifiedAccessSseSpecificationRequest"
    ]
    """<p>The options for server side encryption.</p>"""
    rds_options: NotRequired[
        "capo_ec2.types.create_verified_access_endpoint_rds_options.CreateVerifiedAccessEndpointRdsOptions"
    ]
    """<p>The RDS details. This parameter is required if the endpoint type is <code>rds</code>.</p>"""
    cidr_options: NotRequired[
        "capo_ec2.types.create_verified_access_endpoint_cidr_options.CreateVerifiedAccessEndpointCidrOptions"
    ]
    """<p>The CIDR options. This parameter is required if the endpoint type is <code>cidr</code>.</p>"""

application_domain instance-attribute

application_domain: NotRequired[String]

The DNS name for users to reach your application.

attachment_type instance-attribute

attachment_type: NotRequired[VerifiedAccessEndpointAttachmentType]

The type of attachment.

cidr_options instance-attribute

cidr_options: NotRequired[CreateVerifiedAccessEndpointCidrOptions]

The CIDR options. This parameter is required if the endpoint type is cidr.

client_token instance-attribute

client_token: NotRequired[String]

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

description instance-attribute

description: NotRequired[String]

A description for the Verified Access endpoint.

domain_certificate_arn instance-attribute

domain_certificate_arn: NotRequired[CertificateArn]

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.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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.

endpoint_domain_prefix instance-attribute

endpoint_domain_prefix: NotRequired[String]

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

endpoint_type instance-attribute

endpoint_type: NotRequired[VerifiedAccessEndpointType]

The type of Verified Access endpoint to create.

load_balancer_options instance-attribute

load_balancer_options: NotRequired[CreateVerifiedAccessEndpointLoadBalancerOptions]

The load balancer details. This parameter is required if the endpoint type is load-balancer.

network_interface_options instance-attribute

network_interface_options: NotRequired[CreateVerifiedAccessEndpointEniOptions]

The network interface details. This parameter is required if the endpoint type is network-interface.

policy_document instance-attribute

policy_document: NotRequired[String]

The Verified Access policy document.

rds_options instance-attribute

rds_options: NotRequired[CreateVerifiedAccessEndpointRdsOptions]

The RDS details. This parameter is required if the endpoint type is rds.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdList]

The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.

sse_specification instance-attribute

sse_specification: NotRequired[VerifiedAccessSseSpecificationRequest]

The options for server side encryption.

tag_specifications instance-attribute

tag_specifications: NotRequired[TagSpecificationList]

The tags to assign to the Verified Access endpoint.

verified_access_group_id instance-attribute

verified_access_group_id: NotRequired[VerifiedAccessGroupId]

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