Source code for airflow.providers.amazon.aws.hooks.cloud_formation

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
"""This module contains AWS CloudFormation Hook."""

from __future__ import annotations

from typing import TYPE_CHECKING

from botocore.exceptions import ClientError

from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook

if TYPE_CHECKING:
    from boto3 import client, resource


[docs]class CloudFormationHook(AwsBaseHook):
    """
    Interact with AWS CloudFormation.

    Provide thin wrapper around
    :external+boto3:py:class:`boto3.client("cloudformation") <CloudFormation.Client>`.

    Additional arguments (such as ``aws_conn_id``) may be specified and
    are passed down to the underlying AwsBaseHook.

    .. seealso::
        - :class:`airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook`
    """

    def __init__(self, *args, **kwargs):
        super().__init__(client_type="cloudformation", *args, **kwargs)

[docs]    def get_stack_status(self, stack_name: client | resource) -> dict | None:
        """
        Get stack status from CloudFormation.

        .. seealso::
            - :external+boto3:py:meth:`CloudFormation.Client.describe_stacks`

        """
        self.log.info("Poking for stack %s", stack_name)

        try:
            stacks = self.get_conn().describe_stacks(StackName=stack_name)["Stacks"]
            return stacks[0]["StackStatus"]
        except ClientError as e:
            if "does not exist" in str(e):
                return None
            else:
                raise e

[docs]    def create_stack(self, stack_name: str, cloudformation_parameters: dict) -> None:
        """
        Create stack in CloudFormation.

        .. seealso::
            - :external+boto3:py:meth:`CloudFormation.Client.create_stack`

        :param stack_name: stack_name.
        :param cloudformation_parameters: parameters to be passed to CloudFormation.
        """
        if "StackName" not in cloudformation_parameters:
            cloudformation_parameters["StackName"] = stack_name
        self.get_conn().create_stack(**cloudformation_parameters)

[docs]    def delete_stack(self, stack_name: str, cloudformation_parameters: dict | None = None) -> None:
        """
        Delete stack in CloudFormation.

        .. seealso::
            - :external+boto3:py:meth:`CloudFormation.Client.delete_stack`

        :param stack_name: stack_name.
        :param cloudformation_parameters: parameters to be passed to CloudFormation (optional).
        """
        cloudformation_parameters = cloudformation_parameters or {}
        if "StackName" not in cloudformation_parameters:
            cloudformation_parameters["StackName"] = stack_name
        self.get_conn().delete_stack(**cloudformation_parameters)