Skip to content

create_load_balancer_tls_certificate async

create_load_balancer_tls_certificate(
    load_balancer_name: ResourceName,
    certificate_name: ResourceName,
    certificate_domain_name: DomainName,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    certificate_alternative_names: Optional[DomainNameList] = None,
    tags: Optional[TagList] = None,
) -> CreateLoadBalancerTlsCertificateResult

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

Parameters:

  • load_balancer_name (ResourceName) –

    The load balancer name where you want to create the SSL/TLS certificate.

  • certificate_name (ResourceName) –

    The SSL/TLS certificate name.

    You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.

  • certificate_domain_name (DomainName) –

    The domain name (example.com) for your SSL/TLS certificate.

  • certificate_alternative_names (Optional[DomainNameList], default: None ) –

    An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (*.example.com).

  • tags (Optional[TagList], default: None ) –

    The tag keys and optional values to add to the resource during create.

    Use the TagResource action to tag a resource after it's created.

Raises:

  • AccessDeniedException –

    Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException –

    Lightsail throws this exception when an account is still in the setup in progress state.

  • InvalidInputException –

    Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException –

    Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException –

    Lightsail throws this exception when an operation fails to execute.

  • RegionSetupInProgressException –

    Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.

  • ServiceException –

    A general service exception.

  • UnauthenticatedException –

    Lightsail throws this exception when the user has not been authenticated.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/async_lightsail.py
async def create_load_balancer_tls_certificate(
    self,
    load_balancer_name: "capo_lightsail.types.resource_name.ResourceName",
    certificate_name: "capo_lightsail.types.resource_name.ResourceName",
    certificate_domain_name: "capo_lightsail.types.domain_name.DomainName",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    certificate_alternative_names: Optional[
        "capo_lightsail.types.domain_name_list.DomainNameList"
    ] = None,
    tags: Optional["capo_lightsail.types.tag_list.TagList"] = None,
) -> "capo_lightsail.types.create_load_balancer_tls_certificate_result.CreateLoadBalancerTlsCertificateResult":
    """<p>Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>The <code>CreateLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags">Amazon Lightsail Developer Guide</a>.</p>

    Args:
        load_balancer_name: <p>The load balancer name where you want to create the SSL/TLS certificate.</p>
        certificate_name: <p>The SSL/TLS certificate name.</p> <p>You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see <a href="http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html">Limits</a>.</p>
        certificate_domain_name: <p>The domain name (<code>example.com</code>) for your SSL/TLS certificate.</p>
        certificate_alternative_names: <p>An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (<code>*.example.com</code>).</p>
        tags: <p>The tag keys and optional values to add to the resource during create.</p> <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.account_setup_in_progress_exception.AccountSetupInProgressException: <p>Lightsail throws this exception when an account is still in the setup in progress state.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.create_load_balancer_tls_certificate_request.CreateLoadBalancerTlsCertificateRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.create_load_balancer_tls_certificate_result.CreateLoadBalancerTlsCertificateResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.create_load_balancer_tls_certificate

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.create_load_balancer_tls_certificate.async_create_load_balancer_tls_certificate(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateLoadBalancerTlsCertificate")
    )
    input_: capo_lightsail.types.create_load_balancer_tls_certificate_request.CreateLoadBalancerTlsCertificateRequest = {
        "load_balancer_name": load_balancer_name,
        "certificate_name": certificate_name,
        "certificate_domain_name": certificate_domain_name,
    }
    if certificate_alternative_names is not None:
        input_["certificate_alternative_names"] = certificate_alternative_names
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output