Skip to content

Commit 8583e5a

Browse files
Garison DraperGarison Draper
authored andcommitted
updating documentation
1 parent d136a08 commit 8583e5a

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

docs/config.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -219,12 +219,18 @@ the build action::
219219
Tags
220220
----
221221

222-
CloudFormation supports arbitrary key-value pair tags. All stack-level, including automatically created tags, are
223-
propagated to resources that AWS CloudFormation supports. See `AWS CloudFormation Resource Tags Type`_ for more details.
224-
If no tags are specified, the `stacker_namespace` tag is applied to your stack with the value of `namespace` as the
225-
tag value.
222+
Verious resources in AWS support arbitrary key-value pair tags. You can set
223+
the `tags` Top Level Keyword to populate tags on all Resources that support
224+
that feature. The S3 bucket created by stacker for CFN uploads and all
225+
Cloudformation stack-level resouces, including automatically created tags,
226+
are propagated to resources that AWS CloudFormation supports. See
227+
`AWS CloudFormation Resource Tags Type`_ for more details.
226228

227-
If you prefer to apply a custom set of tags, specify the top-level keyword `tags` as a map. Example::
229+
If no tags are specified, the `stacker_namespace` tag is applied to your stack
230+
with the value of `namespace` as the tag value.
231+
232+
If you prefer to apply a custom set of tags, specify the top-level keyword
233+
`tags` as a map. Example::
228234

229235
tags:
230236
"hello": world
@@ -236,6 +242,8 @@ map for the top-level keyword::
236242

237243
tags: {}
238244

245+
Tags are updated on every stacker run
246+
239247
.. _`AWS CloudFormation Resource Tags Type`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html
240248

241249
Mappings

stacker/util.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,8 +474,8 @@ def ensure_s3_bucket(s3_client, bucket_name, bucket_region, context):
474474
bucket_name (str): The bucket being checked/created.
475475
bucket_region (str, optional): The region to create the bucket in. If
476476
not provided, will be determined by s3_client's region.
477-
context (:class:`stacker.context.Context`): context instance, used to
478-
set tags on the S3 bucket created from the stacker config
477+
context (:class:`stacker.context.Context`): The stacker context, used
478+
set the S3 bucket tags from the stacker config
479479
480480
"""
481481
try:

0 commit comments

Comments
 (0)