`airflow.providers.amazon.aws.operators.cloud_formation`¶

This module contains AWS CloudFormation create/delete stack operators.

Module Contents¶

Classes¶

`CloudFormationCreateStackOperator`	An operator that creates a AWS CloudFormation stack.
`CloudFormationDeleteStackOperator`	An operator that deletes a AWS CloudFormation stack.

class airflow.providers.amazon.aws.operators.cloud_formation.CloudFormationCreateStackOperator(*, stack_name, cloudformation_parameters, **kwargs)[source]¶

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.cloud_formation.CloudFormationHook]

An operator that creates a AWS CloudFormation stack.

See also

For more information on how to use this operator, take a look at the guide: Create an AWS CloudFormation stack

Parameters

stack_name (str) – stack name (templated)
cloudformation_parameters (dict) – parameters to be passed to AWS CloudFormation.
aws_conn_id – The Airflow connection used for AWS credentials. If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node).
region_name – AWS region_name. If not specified then the default boto3 behaviour is used.
verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

aws_hook_class[source]¶

template_fields: Sequence[str][source]¶

ui_color = '#6b9659'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.amazon.aws.operators.cloud_formation.CloudFormationDeleteStackOperator(*, stack_name, cloudformation_parameters=None, aws_conn_id='aws_default', **kwargs)[source]¶

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.cloud_formation.CloudFormationHook]

An operator that deletes a AWS CloudFormation stack.

See also

For more information on how to use this operator, take a look at the guide: Delete an AWS CloudFormation stack

Parameters

stack_name (str) – stack name (templated)
cloudformation_parameters (dict | None) – parameters to be passed to CloudFormation.
aws_conn_id (str | None) – The Airflow connection used for AWS credentials. If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node).
region_name – AWS region_name. If not specified then the default boto3 behaviour is used.
verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

aws_hook_class[source]¶

template_fields: Sequence[str][source]¶

ui_color = '#1d472b'[source]¶

ui_fgcolor = '#FFF'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?