Skip to content

create_verified_access_endpoint

create_verified_access_endpoint(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    verified_access_group_id: Optional[VerifiedAccessGroupId] = None,
    endpoint_type: Optional[VerifiedAccessEndpointType] = None,
    attachment_type: Optional[VerifiedAccessEndpointAttachmentType] = None,
    domain_certificate_arn: Optional[CertificateArn] = None,
    application_domain: Optional[String] = None,
    endpoint_domain_prefix: Optional[String] = None,
    security_group_ids: Optional[SecurityGroupIdList] = None,
    load_balancer_options: Optional[
        CreateVerifiedAccessEndpointLoadBalancerOptions
    ] = None,
    network_interface_options: Optional[CreateVerifiedAccessEndpointEniOptions] = None,
    description: Optional[String] = None,
    policy_document: Optional[String] = None,
    tag_specifications: Optional[TagSpecificationList] = None,
    client_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    sse_specification: Optional[VerifiedAccessSseSpecificationRequest] = None,
    rds_options: Optional[CreateVerifiedAccessEndpointRdsOptions] = None,
    cidr_options: Optional[CreateVerifiedAccessEndpointCidrOptions] = None,
) -> CreateVerifiedAccessEndpointResult

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Parameters:

  • verified_access_group_id (Optional[VerifiedAccessGroupId], default: None ) –

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

  • endpoint_type (Optional[VerifiedAccessEndpointType], default: None ) –

    The type of Verified Access endpoint to create.

  • attachment_type (Optional[VerifiedAccessEndpointAttachmentType], default: None ) –

    The type of attachment.

  • domain_certificate_arn (Optional[CertificateArn], default: 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.

  • application_domain (Optional[String], default: None ) –

    The DNS name for users to reach your application.

  • endpoint_domain_prefix (Optional[String], default: None ) –

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

  • security_group_ids (Optional[SecurityGroupIdList], default: None ) –

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

  • load_balancer_options (Optional[CreateVerifiedAccessEndpointLoadBalancerOptions], default: None ) –

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

  • network_interface_options (Optional[CreateVerifiedAccessEndpointEniOptions], default: None ) –

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

  • description (Optional[String], default: None ) –

    A description for the Verified Access endpoint.

  • policy_document (Optional[String], default: None ) –

    The Verified Access policy document.

  • tag_specifications (Optional[TagSpecificationList], default: None ) –

    The tags to assign to the Verified Access endpoint.

  • client_token (Optional[String], default: None ) –

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

  • dry_run (Optional[Boolean], default: 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.

  • sse_specification (Optional[VerifiedAccessSseSpecificationRequest], default: None ) –

    The options for server side encryption.

  • rds_options (Optional[CreateVerifiedAccessEndpointRdsOptions], default: None ) –

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

  • cidr_options (Optional[CreateVerifiedAccessEndpointCidrOptions], default: None ) –

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

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def create_verified_access_endpoint(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    verified_access_group_id: Optional[
        "capo_ec2.types.verified_access_group_id.VerifiedAccessGroupId"
    ] = None,
    endpoint_type: Optional[
        "capo_ec2.types.verified_access_endpoint_type.VerifiedAccessEndpointType"
    ] = None,
    attachment_type: Optional[
        "capo_ec2.types.verified_access_endpoint_attachment_type.VerifiedAccessEndpointAttachmentType"
    ] = None,
    domain_certificate_arn: Optional[
        "capo_ec2.types.certificate_arn.CertificateArn"
    ] = None,
    application_domain: Optional["capo_ec2.types.string.String"] = None,
    endpoint_domain_prefix: Optional["capo_ec2.types.string.String"] = None,
    security_group_ids: Optional[
        "capo_ec2.types.security_group_id_list.SecurityGroupIdList"
    ] = None,
    load_balancer_options: Optional[
        "capo_ec2.types.create_verified_access_endpoint_load_balancer_options.CreateVerifiedAccessEndpointLoadBalancerOptions"
    ] = None,
    network_interface_options: Optional[
        "capo_ec2.types.create_verified_access_endpoint_eni_options.CreateVerifiedAccessEndpointEniOptions"
    ] = None,
    description: Optional["capo_ec2.types.string.String"] = None,
    policy_document: Optional["capo_ec2.types.string.String"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    sse_specification: Optional[
        "capo_ec2.types.verified_access_sse_specification_request.VerifiedAccessSseSpecificationRequest"
    ] = None,
    rds_options: Optional[
        "capo_ec2.types.create_verified_access_endpoint_rds_options.CreateVerifiedAccessEndpointRdsOptions"
    ] = None,
    cidr_options: Optional[
        "capo_ec2.types.create_verified_access_endpoint_cidr_options.CreateVerifiedAccessEndpointCidrOptions"
    ] = None,
) -> "capo_ec2.types.create_verified_access_endpoint_result.CreateVerifiedAccessEndpointResult":
    """<p>An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.</p>

    Args:
        verified_access_group_id: <p>The ID of the Verified Access group to associate the endpoint with.</p>
        endpoint_type: <p>The type of Verified Access endpoint to create.</p>
        attachment_type: <p>The type of attachment.</p>
        domain_certificate_arn: <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: <p>The DNS name for users to reach your application.</p>
        endpoint_domain_prefix: <p>A custom identifier that is prepended to the DNS name that is generated for the endpoint.</p>
        security_group_ids: <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: <p>The load balancer details. This parameter is required if the endpoint type is <code>load-balancer</code>.</p>
        network_interface_options: <p>The network interface details. This parameter is required if the endpoint type is <code>network-interface</code>.</p>
        description: <p>A description for the Verified Access endpoint.</p>
        policy_document: <p>The Verified Access policy document.</p>
        tag_specifications: <p>The tags to assign to the Verified Access endpoint.</p>
        client_token: <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: <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: <p>The options for server side encryption.</p>
        rds_options: <p>The RDS details. This parameter is required if the endpoint type is <code>rds</code>.</p>
        cidr_options: <p>The CIDR options. This parameter is required if the endpoint type is <code>cidr</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_verified_access_endpoint_request.CreateVerifiedAccessEndpointRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_verified_access_endpoint_result.CreateVerifiedAccessEndpointResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_verified_access_endpoint

        output, http_response = (
            capo_ec2._operations.amazon_ec2.create_verified_access_endpoint.create_verified_access_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateVerifiedAccessEndpoint")
    )
    input_: capo_ec2.types.create_verified_access_endpoint_request.CreateVerifiedAccessEndpointRequest = {}
    if verified_access_group_id is not None:
        input_["verified_access_group_id"] = verified_access_group_id
    if endpoint_type is not None:
        input_["endpoint_type"] = endpoint_type
    if attachment_type is not None:
        input_["attachment_type"] = attachment_type
    if domain_certificate_arn is not None:
        input_["domain_certificate_arn"] = domain_certificate_arn
    if application_domain is not None:
        input_["application_domain"] = application_domain
    if endpoint_domain_prefix is not None:
        input_["endpoint_domain_prefix"] = endpoint_domain_prefix
    if security_group_ids is not None:
        input_["security_group_ids"] = security_group_ids
    if load_balancer_options is not None:
        input_["load_balancer_options"] = load_balancer_options
    if network_interface_options is not None:
        input_["network_interface_options"] = network_interface_options
    if description is not None:
        input_["description"] = description
    if policy_document is not None:
        input_["policy_document"] = policy_document
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if sse_specification is not None:
        input_["sse_specification"] = sse_specification
    if rds_options is not None:
        input_["rds_options"] = rds_options
    if cidr_options is not None:
        input_["cidr_options"] = cidr_options

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output