Module core.default.resources.simple.static_site

Set of constructs for for making a website to serve Static Web Content

"""Set of constructs for for making a website to serve Static Web Content

"""
from typing import Any, Optional, Dict

from core.constructs.resource import (
    Resource,
    TaggableResourceModel,
    TaggableMixin,
    update_hash,
    ResourceOutputs,
)
from core.constructs.cloud_output import Cloud_Output_Str
from core.utils import hasher
from core.constructs.models import frozendict

RUUID = "cdev::simple::staticsite"


class StaticSiteOutput(ResourceOutputs):
    def __init__(self, name: str) -> None:
        super().__init__(name, RUUID)

    @property
    def bucket_name(self) -> Cloud_Output_Str:
        """The name of the underlying S3 Bucket where the content for the site is stored."""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="bucket_name", type=self.OUTPUT_TYPE
        )

    @bucket_name.setter
    def bucket_name(self, value: Any) -> None:
        raise Exception

    @property
    def cloudfront_id(self) -> Cloud_Output_Str:
        """The id of the site on the Cloudfront CDN"""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="cloudfront_id", type=self.OUTPUT_TYPE
        )

    @cloudfront_id.setter
    def cloudfront_id(self, value: Any) -> None:
        raise Exception

    @property
    def cloudfront_arn(self) -> Cloud_Output_Str:
        """The arn of the site on the Cloudfront CDN"""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="cloudfront_arn", type=self.OUTPUT_TYPE
        )

    @cloudfront_arn.setter
    def cloudfront_arn(self, value: Any) -> None:
        raise Exception

    @property
    def site_url(self) -> Cloud_Output_Str:
        """The url of the created site"""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="site_url", type=self.OUTPUT_TYPE
        )

    @site_url.setter
    def site_url(self, value: Any) -> None:
        raise Exception


###############
##### Static Site
###############
class simple_static_site_model(TaggableResourceModel):
    index_document: str
    """The suffix for documents when request are made for a folder. ex: site.com/dir1/ will look for /dir1/<index_document>"""
    error_document: str
    """The absolute path of document within the site that will be used as a general error page."""
    sync_folder: bool
    """Whether to consider changes in the state of the content folder to trigger a sync of the content folder."""
    content_folder: Optional[str]
    """The relative path within the Workspace of the folder containting the static content for the site."""
    domain_name: Optional[str]
    """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
    ssl_certificate_arn: Optional[str]
    """Arn of a SSL certificate to use with the site."""


class StaticSite(TaggableMixin, Resource):
    @update_hash
    def __init__(
        self,
        cdev_name: str,
        index_document: str = "index.html",
        error_document: str = "error.html",
        sync_folder: bool = False,
        content_folder: str = None,
        domain_name: str = None,
        ssl_certificate_arn: str = None,
        nonce: str = "",
        tags: Dict[str, str] = None,
    ) -> None:
        """Create a resource to host static files.

        Arguments:
            cdev_name (str): [description]
            index_document (str): The suffix for documents when request are made for a folder.
            error_document (str): The absolute path of document within the site that will be used as a general error page.
            sync_folder (bool): Whether to consider changes in the state of the content folder to trigger a sync of the content folder.
            content_folder (str): The relative path within the `Workspace` of the folder containting the static content for the site.
            domain_name (str): The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name.
            ssl_certificate_arn (str): Arn of a SSL certificate to use with the site.
            nonce (str): Nonce to make the resource hash unique if there are conflicting resources with same configuration.
            tags (Dict[str, str]): A set of tags to add to the resource
        """
        super().__init__(cdev_name, RUUID, nonce, tags=tags)

        self._index_document = index_document
        self._error_document = error_document
        self._sync_folder = sync_folder
        self._content_folder = content_folder
        self._domain_name = domain_name
        self._ssl_certificate_arn = ssl_certificate_arn

        self.output = StaticSiteOutput(cdev_name)

    @property
    def index_document(self) -> str:
        """The suffix for documents when request are made for a folder."""
        return self._index_document

    @index_document.setter
    @update_hash
    def index_document(self, value: str) -> None:
        self._index_document = value

    @property
    def error_document(self) -> str:
        """The absolute path of document within the site that will be used as a general error page."""
        return self._error_document

    @error_document.setter
    @update_hash
    def error_document(self, value: str) -> None:
        self._error_document = value

    @property
    def content_folder(self) -> str:
        """The relative path within the `Workspace` of the folder containting the static content for the site."""
        return self._content_folder

    @content_folder.setter
    @update_hash
    def content_folder(self, value: str) -> None:
        self._content_folder = value

    @property
    def sync_folder(self) -> str:
        """Whether to consider changes in the state of the content folder to trigger a sync of the content folder."""
        return self._sync_folder

    @sync_folder.setter
    @update_hash
    def sync_folder(self, value: bool) -> None:
        self._sync_folder = value

    @property
    def domain_name(self) -> str:
        """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
        return self._domain_name

    @domain_name.setter
    @update_hash
    def domain_name(self, value: str) -> None:
        self._domain_name = value

    @property
    def ssl_certificate_arn(self) -> str:
        """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
        return self._ssl_certificate_arn

    @ssl_certificate_arn.setter
    @update_hash
    def ssl_certificate_arn(self, value: str) -> None:
        self._ssl_certificate_arn = value

    def compute_hash(self) -> None:
        # TODO update component to look at the content if the sync folder command is given
        self._hash = hasher.hash_list(
            [
                self.index_document,
                self.error_document,
                self.sync_folder,
                self.content_folder,
                self.domain_name,
                self.ssl_certificate_arn,
                self.nonce,
                self._get_tags_hash(),
            ]
        )

    def render(self) -> simple_static_site_model:
        if self.sync_folder and not self.content_folder:

            raise Exception(
                f"If sync_folder is set to 'True' then you must provide a path to the folder."
            )

        return simple_static_site_model(
            ruuid=self.ruuid,
            name=self.name,
            hash=self.hash,
            index_document=self.index_document,
            error_document=self.error_document,
            sync_folder=self.sync_folder,
            content_folder=self.content_folder,
            domain_name=self.domain_name,
            ssl_certificate_arn=self.ssl_certificate_arn,
            tags=frozendict(self.tags),
        )

Classes

class StaticSite (cdev_name: str, index_document: str = 'index.html', error_document: str = 'error.html', sync_folder: bool = False, content_folder: str = None, domain_name: str = None, ssl_certificate_arn: str = None, nonce: str = '', tags: Dict[str, str] = None)

Create a resource to host static files.

Arguments

cdev_name (str): [description] index_document (str): The suffix for documents when request are made for a folder. error_document (str): The absolute path of document within the site that will be used as a general error page. sync_folder (bool): Whether to consider changes in the state of the content folder to trigger a sync of the content folder. content_folder (str): The relative path within the Workspace of the folder containting the static content for the site. domain_name (str): The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name. ssl_certificate_arn (str): Arn of a SSL certificate to use with the site. nonce (str): Nonce to make the resource hash unique if there are conflicting resources with same configuration. tags (Dict[str, str]): A set of tags to add to the resource

Expand source code

class StaticSite(TaggableMixin, Resource):
    @update_hash
    def __init__(
        self,
        cdev_name: str,
        index_document: str = "index.html",
        error_document: str = "error.html",
        sync_folder: bool = False,
        content_folder: str = None,
        domain_name: str = None,
        ssl_certificate_arn: str = None,
        nonce: str = "",
        tags: Dict[str, str] = None,
    ) -> None:
        """Create a resource to host static files.

        Arguments:
            cdev_name (str): [description]
            index_document (str): The suffix for documents when request are made for a folder.
            error_document (str): The absolute path of document within the site that will be used as a general error page.
            sync_folder (bool): Whether to consider changes in the state of the content folder to trigger a sync of the content folder.
            content_folder (str): The relative path within the `Workspace` of the folder containting the static content for the site.
            domain_name (str): The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name.
            ssl_certificate_arn (str): Arn of a SSL certificate to use with the site.
            nonce (str): Nonce to make the resource hash unique if there are conflicting resources with same configuration.
            tags (Dict[str, str]): A set of tags to add to the resource
        """
        super().__init__(cdev_name, RUUID, nonce, tags=tags)

        self._index_document = index_document
        self._error_document = error_document
        self._sync_folder = sync_folder
        self._content_folder = content_folder
        self._domain_name = domain_name
        self._ssl_certificate_arn = ssl_certificate_arn

        self.output = StaticSiteOutput(cdev_name)

    @property
    def index_document(self) -> str:
        """The suffix for documents when request are made for a folder."""
        return self._index_document

    @index_document.setter
    @update_hash
    def index_document(self, value: str) -> None:
        self._index_document = value

    @property
    def error_document(self) -> str:
        """The absolute path of document within the site that will be used as a general error page."""
        return self._error_document

    @error_document.setter
    @update_hash
    def error_document(self, value: str) -> None:
        self._error_document = value

    @property
    def content_folder(self) -> str:
        """The relative path within the `Workspace` of the folder containting the static content for the site."""
        return self._content_folder

    @content_folder.setter
    @update_hash
    def content_folder(self, value: str) -> None:
        self._content_folder = value

    @property
    def sync_folder(self) -> str:
        """Whether to consider changes in the state of the content folder to trigger a sync of the content folder."""
        return self._sync_folder

    @sync_folder.setter
    @update_hash
    def sync_folder(self, value: bool) -> None:
        self._sync_folder = value

    @property
    def domain_name(self) -> str:
        """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
        return self._domain_name

    @domain_name.setter
    @update_hash
    def domain_name(self, value: str) -> None:
        self._domain_name = value

    @property
    def ssl_certificate_arn(self) -> str:
        """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
        return self._ssl_certificate_arn

    @ssl_certificate_arn.setter
    @update_hash
    def ssl_certificate_arn(self, value: str) -> None:
        self._ssl_certificate_arn = value

    def compute_hash(self) -> None:
        # TODO update component to look at the content if the sync folder command is given
        self._hash = hasher.hash_list(
            [
                self.index_document,
                self.error_document,
                self.sync_folder,
                self.content_folder,
                self.domain_name,
                self.ssl_certificate_arn,
                self.nonce,
                self._get_tags_hash(),
            ]
        )

    def render(self) -> simple_static_site_model:
        if self.sync_folder and not self.content_folder:

            raise Exception(
                f"If sync_folder is set to 'True' then you must provide a path to the folder."
            )

        return simple_static_site_model(
            ruuid=self.ruuid,
            name=self.name,
            hash=self.hash,
            index_document=self.index_document,
            error_document=self.error_document,
            sync_folder=self.sync_folder,
            content_folder=self.content_folder,
            domain_name=self.domain_name,
            ssl_certificate_arn=self.ssl_certificate_arn,
            tags=frozendict(self.tags),
        )

Ancestors

• TaggableMixin
• Resource

Instance variables

var content_folder : str

The relative path within the Workspace of the folder containting the static content for the site.

Expand source code

@property
def content_folder(self) -> str:
    """The relative path within the `Workspace` of the folder containting the static content for the site."""
    return self._content_folder

var domain_name : str

The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name.

Expand source code

@property
def domain_name(self) -> str:
    """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
    return self._domain_name

var error_document : str

The absolute path of document within the site that will be used as a general error page.

Expand source code

@property
def error_document(self) -> str:
    """The absolute path of document within the site that will be used as a general error page."""
    return self._error_document

var index_document : str

The suffix for documents when request are made for a folder.

Expand source code

@property
def index_document(self) -> str:
    """The suffix for documents when request are made for a folder."""
    return self._index_document

var ssl_certificate_arn : str

The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name.

Expand source code

@property
def ssl_certificate_arn(self) -> str:
    """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
    return self._ssl_certificate_arn

var sync_folder : str

Whether to consider changes in the state of the content folder to trigger a sync of the content folder.

Expand source code

@property
def sync_folder(self) -> str:
    """Whether to consider changes in the state of the content folder to trigger a sync of the content folder."""
    return self._sync_folder

Methods

def compute_hash(self) ‑> None

Expand source code

def compute_hash(self) -> None:
    # TODO update component to look at the content if the sync folder command is given
    self._hash = hasher.hash_list(
        [
            self.index_document,
            self.error_document,
            self.sync_folder,
            self.content_folder,
            self.domain_name,
            self.ssl_certificate_arn,
            self.nonce,
            self._get_tags_hash(),
        ]
    )

def render(self) ‑> simple_static_site_model

Expand source code

def render(self) -> simple_static_site_model:
    if self.sync_folder and not self.content_folder:

        raise Exception(
            f"If sync_folder is set to 'True' then you must provide a path to the folder."
        )

    return simple_static_site_model(
        ruuid=self.ruuid,
        name=self.name,
        hash=self.hash,
        index_document=self.index_document,
        error_document=self.error_document,
        sync_folder=self.sync_folder,
        content_folder=self.content_folder,
        domain_name=self.domain_name,
        ssl_certificate_arn=self.ssl_certificate_arn,
        tags=frozendict(self.tags),
    )

Inherited members

• TaggableMixin:
  • tags
• Resource:
  • hash
  • name
  • nonce
  • ruuid

class StaticSiteOutput (name: str)

Container object for the returned values from the cloud after the resource has been deployed.

Expand source code

class StaticSiteOutput(ResourceOutputs):
    def __init__(self, name: str) -> None:
        super().__init__(name, RUUID)

    @property
    def bucket_name(self) -> Cloud_Output_Str:
        """The name of the underlying S3 Bucket where the content for the site is stored."""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="bucket_name", type=self.OUTPUT_TYPE
        )

    @bucket_name.setter
    def bucket_name(self, value: Any) -> None:
        raise Exception

    @property
    def cloudfront_id(self) -> Cloud_Output_Str:
        """The id of the site on the Cloudfront CDN"""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="cloudfront_id", type=self.OUTPUT_TYPE
        )

    @cloudfront_id.setter
    def cloudfront_id(self, value: Any) -> None:
        raise Exception

    @property
    def cloudfront_arn(self) -> Cloud_Output_Str:
        """The arn of the site on the Cloudfront CDN"""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="cloudfront_arn", type=self.OUTPUT_TYPE
        )

    @cloudfront_arn.setter
    def cloudfront_arn(self, value: Any) -> None:
        raise Exception

    @property
    def site_url(self) -> Cloud_Output_Str:
        """The url of the created site"""
        return Cloud_Output_Str(
            name=self._name, ruuid=RUUID, key="site_url", type=self.OUTPUT_TYPE
        )

    @site_url.setter
    def site_url(self, value: Any) -> None:
        raise Exception

Ancestors

• ResourceOutputs

Instance variables

var bucket_name : Cloud_Output_Str

The name of the underlying S3 Bucket where the content for the site is stored.

Expand source code

@property
def bucket_name(self) -> Cloud_Output_Str:
    """The name of the underlying S3 Bucket where the content for the site is stored."""
    return Cloud_Output_Str(
        name=self._name, ruuid=RUUID, key="bucket_name", type=self.OUTPUT_TYPE
    )

var cloudfront_arn : Cloud_Output_Str

The arn of the site on the Cloudfront CDN

Expand source code

@property
def cloudfront_arn(self) -> Cloud_Output_Str:
    """The arn of the site on the Cloudfront CDN"""
    return Cloud_Output_Str(
        name=self._name, ruuid=RUUID, key="cloudfront_arn", type=self.OUTPUT_TYPE
    )

var cloudfront_id : Cloud_Output_Str

The id of the site on the Cloudfront CDN

Expand source code

@property
def cloudfront_id(self) -> Cloud_Output_Str:
    """The id of the site on the Cloudfront CDN"""
    return Cloud_Output_Str(
        name=self._name, ruuid=RUUID, key="cloudfront_id", type=self.OUTPUT_TYPE
    )

var site_url : Cloud_Output_Str

The url of the created site

Expand source code

@property
def site_url(self) -> Cloud_Output_Str:
    """The url of the created site"""
    return Cloud_Output_Str(
        name=self._name, ruuid=RUUID, key="site_url", type=self.OUTPUT_TYPE
    )

class simple_static_site_model (**data: Any)

Derived class, that adds an extra attribute tags.

Attributes

tags

When deploying the resource we add them to it so it can be filtered by any of them

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class simple_static_site_model(TaggableResourceModel):
    index_document: str
    """The suffix for documents when request are made for a folder. ex: site.com/dir1/ will look for /dir1/<index_document>"""
    error_document: str
    """The absolute path of document within the site that will be used as a general error page."""
    sync_folder: bool
    """Whether to consider changes in the state of the content folder to trigger a sync of the content folder."""
    content_folder: Optional[str]
    """The relative path within the Workspace of the folder containting the static content for the site."""
    domain_name: Optional[str]
    """The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name."""
    ssl_certificate_arn: Optional[str]
    """Arn of a SSL certificate to use with the site."""

Ancestors

• TaggableResourceModel
• ResourceModel
• ImmutableModel
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var content_folder : Optional[str]

The relative path within the Workspace of the folder containting the static content for the site.

var domain_name : Optional[str]

The domain name to associate with this site. This will set up the site to be aliased via DNS to the given domain name.

var error_document : str

The absolute path of document within the site that will be used as a general error page.

var index_document : str

The suffix for documents when request are made for a folder. ex: site.com/dir1/ will look for /dir1/

var ssl_certificate_arn : Optional[str]

Arn of a SSL certificate to use with the site.

var sync_folder : bool

Whether to consider changes in the state of the content folder to trigger a sync of the content folder.

Inherited members

• TaggableResourceModel:
  • hash
  • name
  • ruuid
  • tags