create_domain_association ¶

def create_domain_association(
    self,
    app_id: "capo_amplify.types.app_id.AppId",
    domain_name: "capo_amplify.types.domain_name.DomainName",
    sub_domain_settings: "capo_amplify.types.sub_domain_settings.SubDomainSettings",
    *,
    config_overrides: Optional[AmplifyClientConfig] = None,
    enable_auto_sub_domain: Optional[
        "capo_amplify.types.enable_auto_sub_domain.EnableAutoSubDomain"
    ] = None,
    auto_sub_domain_creation_patterns: Optional[
        "capo_amplify.types.auto_sub_domain_creation_patterns.AutoSubDomainCreationPatterns"
    ] = None,
    auto_sub_domain_iam_role: Optional[
        "capo_amplify.types.auto_sub_domain_iam_role.AutoSubDomainIAMRole"
    ] = None,
    certificate_settings: Optional[
        "capo_amplify.types.certificate_settings.CertificateSettings"
    ] = None,
) -> "capo_amplify.types.create_domain_association_result.CreateDomainAssociationResult":
    """<p>Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app </p>

    Args:
        app_id: <p> The unique ID for an Amplify app. </p>
        domain_name: <p> The domain name for the domain association. </p>
        enable_auto_sub_domain: <p> Enables the automated creation of subdomains for branches. </p>
        sub_domain_settings: <p> The setting for the subdomain. </p>
        auto_sub_domain_creation_patterns: <p> Sets the branch patterns for automatic subdomain creation. </p>
        auto_sub_domain_iam_role: <p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>
        certificate_settings: <p>The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.</p>

    Raises:
        capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
        capo_amplify.errors.dependent_service_failure_exception.DependentServiceFailureException: <p>An operation failed because a dependent service threw an exception. </p>
        capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
        capo_amplify.errors.limit_exceeded_exception.LimitExceededException: <p>A resource could not be created because service quotas were exceeded. </p>
        capo_amplify.errors.not_found_exception.NotFoundException: <p>An entity was not found during an operation. </p>
        capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
        capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amplify.types.create_domain_association_request.CreateDomainAssociationRequest]",
    ) -> OperationResponse[
        "capo_amplify.types.create_domain_association_result.CreateDomainAssociationResult"
    ]:
        import capo_amplify._operations.amplify.create_domain_association

        output, http_response = (
            capo_amplify._operations.amplify.create_domain_association.create_domain_association(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDomainAssociation")
    )
    input_: capo_amplify.types.create_domain_association_request.CreateDomainAssociationRequest = {
        "app_id": app_id,
        "domain_name": domain_name,
        "sub_domain_settings": sub_domain_settings,
    }
    if enable_auto_sub_domain is not None:
        input_["enable_auto_sub_domain"] = enable_auto_sub_domain
    if auto_sub_domain_creation_patterns is not None:
        input_["auto_sub_domain_creation_patterns"] = (
            auto_sub_domain_creation_patterns
        )
    if auto_sub_domain_iam_role is not None:
        input_["auto_sub_domain_iam_role"] = auto_sub_domain_iam_role
    if certificate_settings is not None:
        input_["certificate_settings"] = certificate_settings

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