Source code for sceptre.stack

# -*- coding: utf-8 -*-

"""
sceptre.stack

This module implements a Stack class, which stores a Stack's data.

"""

import logging
from typing import Mapping, Sequence

from sceptre.connection_manager import ConnectionManager
from sceptre.helpers import get_external_stack_name, sceptreise_path
from sceptre.hooks import HookProperty
from sceptre.resolvers import ResolvableProperty
from sceptre.template import Template


[docs]class Stack(object): """ Stack stores information about a particular CloudFormation Stack. :param name: The name of the Stack. :type project: str :param project_code: A code which is prepended to the Stack names\ of all Stacks built by Sceptre. :type project_code: str :param template_path: The relative path to the CloudFormation, Jinja2\ or Python template to build the Stack from. :type template_path: str :param region: The AWS region to build Stacks in. :type region: str :param template_bucket_name: The name of the S3 bucket the Template is uploaded to. :type template_bucket_name: str :param template_key_prefix: A prefix to the key used to store templates uploaded to S3 :type template_key_prefix: str :param required_version: A PEP 440 compatible version specifier. If the Sceptre version does\ not fall within the given version requirement it will abort. :type required_version: str :param parameters: The keys must match up with the name of the parameter.\ The value must be of the type as defined in the template. :type parameters: dict :param sceptre_user_data: Data passed into\ `sceptre_handler(sceptre_user_data)` function in Python templates\ or accessible under `sceptre_user_data` variable within Jinja2\ templates. :type sceptre_user_data: dict :param hooks: A list of arbitrary shell or python commands or scripts to\ run. :type hooks: sceptre.hooks.Hook :param s3_details: :type s3_details: dict :param dependencies: The relative path to the Stack, including the file\ extension of the Stack. :type dependencies: list :param role_arn: The ARN of a CloudFormation Service Role that is assumed\ by CloudFormation to create, update or delete resources. :type role_arn: str :param protected: Stack protection against execution. :type protected: bool :param tags: CloudFormation Tags to be applied to the Stack. :type tags: dict :param external_name: :type external_name: str :param notifications: SNS topic ARNs to publish Stack related events to.\ A maximum of 5 ARNs can be specified per Stack. :type notifications: list :param on_failure: This parameter describes the action taken by\ CloudFormation when a Stack fails to create. :type on_failure: str :param profile: The name of the profile as defined in ~/.aws/config and\ ~/.aws/credentials. :type profile: str :param stack_timeout: A timeout in minutes before considering the Stack\ deployment as failed. After the specified timeout, the Stack will\ be rolled back. Specifiyng zero, as well as ommiting the field,\ will result in no timeout. Supports only positive integer value. :type stack_timeout: int :param stack_group_config: The StackGroup config for the Stack :type stack_group_config: dict """ parameters = ResolvableProperty("parameters") _sceptre_user_data = ResolvableProperty("_sceptre_user_data") notifications = ResolvableProperty("notifications") hooks = HookProperty("hooks") def __init__( self, name, project_code, template_path, region, template_bucket_name=None, template_key_prefix=None, required_version=None, parameters=None, sceptre_user_data=None, hooks=None, s3_details=None, dependencies=None, role_arn=None, protected=False, tags=None, external_name=None, notifications=None, on_failure=None, profile=None, stack_timeout=0, stack_group_config={} ): self.logger = logging.getLogger(__name__) self.name = sceptreise_path(name) self.project_code = project_code self.region = region self.template_bucket_name = template_bucket_name self.template_key_prefix = template_key_prefix self.required_version = required_version self.external_name = external_name or get_external_stack_name(self.project_code, self.name) self.template_path = template_path self.s3_details = s3_details self._template = None self._connection_manager = None self.protected = protected self.role_arn = role_arn self.on_failure = on_failure self.dependencies = dependencies or [] self.tags = tags or {} self.stack_timeout = stack_timeout self.profile = profile self.hooks = hooks or {} self.parameters = parameters or {} self._sceptre_user_data = sceptre_user_data or {} self._sceptre_user_data_is_resolved = False self.notifications = notifications or [] self.stack_group_config = stack_group_config or {} def __repr__(self): return ( "sceptre.stack.Stack(" "name='{name}', " "project_code={project_code}, " "template_path={template_path}, " "region={region}, " "template_bucket_name={template_bucket_name}, " "template_key_prefix={template_key_prefix}, " "required_version={required_version}, " "profile={profile}, " "sceptre_user_data={sceptre_user_data}, " "parameters={parameters}, " "hooks={hooks}, " "s3_details={s3_details}, " "dependencies={dependencies}, " "role_arn={role_arn}, " "protected={protected}, " "tags={tags}, " "external_name={external_name}, " "notifications={notifications}, " "on_failure={on_failure}, " "stack_timeout={stack_timeout}, " "stack_group_config={stack_group_config}" ")".format( name=self.name, project_code=self.project_code, template_path=self.template_path, region=self.region, template_bucket_name=self.template_bucket_name, template_key_prefix=self.template_key_prefix, required_version=self.required_version, profile=self.profile, sceptre_user_data=self.sceptre_user_data, parameters=self.parameters, hooks=self.hooks, s3_details=self.s3_details, dependencies=self.dependencies, role_arn=self.role_arn, protected=self.protected, tags=self.tags, external_name=self.external_name, notifications=self.notifications, on_failure=self.on_failure, stack_timeout=self.stack_timeout, stack_group_config=self.stack_group_config ) ) def __str__(self): return self.name def __eq__(self, stack): return ( self.name == stack.name and self.project_code == stack.project_code and self.template_path == stack.template_path and self.region == stack.region and self.template_bucket_name == stack.template_bucket_name and self.template_key_prefix == stack.template_key_prefix and self.required_version == stack.required_version and self.profile == stack.profile and self.sceptre_user_data == stack.sceptre_user_data and self.parameters == stack.parameters and self.hooks == stack.hooks and self.s3_details == stack.s3_details and self.dependencies == stack.dependencies and self.role_arn == stack.role_arn and self.protected == stack.protected and self.tags == stack.tags and self.external_name == stack.external_name and self.notifications == stack.notifications and self.on_failure == stack.on_failure and self.stack_timeout == stack.stack_timeout and self.stack_group_config == stack.stack_group_config ) def __hash__(self): return hash(str(self)) @property def connection_manager(self): """ Returns ConnectionManager. :returns: ConnectionManager. :rtype: ConnectionManager """ if self._connection_manager is None: self._connection_manager = ConnectionManager( self.region, self.profile, self.external_name ) return self._connection_manager @property def sceptre_user_data(self): """Returns sceptre_user_data after ensuring that it is fully resolved. :rtype: dict or list or None """ if not self._sceptre_user_data_is_resolved: self._sceptre_user_data_is_resolved = True self._resolve_sceptre_user_data() return self._sceptre_user_data @property def template(self): """ Returns the CloudFormation Template used to create the Stack. :returns: The Stack's template. :rtype: str """ if self._template is None: self._template = Template( path=self.template_path, sceptre_user_data=self.sceptre_user_data, s3_details=self.s3_details, connection_manager=self.connection_manager ) return self._template def _resolve_sceptre_user_data(self): data = self._sceptre_user_data if isinstance(data, Mapping): iterator = data.values() elif isinstance(data, Sequence): iterator = data else: return for value in iterator: if isinstance(value, ResolvableProperty.ResolveLater): value()