Add tagging support for the s3 mb command (aws#10119)

Author: aemous

.changes/next-release/enhancement-s3-53314.json

@@ -0,0 +1,5 @@
+{
+  "type": "enhancement",
+  "category": "``s3``",
+  "description": "Add support for specifying tags on buckets during bucket creation using the ``aws s3 mb`` command via a new ``--tags`` flag."
+}

awscli/customizations/s3/subcommands.py

@@ -483,6 +483,18 @@
     )
 }
 
+TAGS = {
+    'name': 'tags',
+    'synopsis': '--tags <key> <value>',
+    'action': 'append',
+    'nargs': 2,
+    'help_text': (
+        'This flag specifies tags to be added to the bucket in the format of '
+        '``--tags key value``. You can specify this flag multiple times, '
+        'once for each tag.'
+    ),
+}
+
 CASE_CONFLICT = {
     'name': 'case-conflict',
     'choices': [
@@ -876,7 +888,13 @@ class MbCommand(S3Command):
     NAME = 'mb'
     DESCRIPTION = "Creates an S3 bucket."
     USAGE = "<S3Uri>"
-    ARG_TABLE = [{'name': 'path', 'positional_arg': True, 'synopsis': USAGE}]
+    ARG_TABLE = [
+        {
+            'name': 'path',
+            'positional_arg': True,
+            'synopsis': USAGE,
+        }
+    ] + [TAGS]
 
     def _run_main(self, parsed_args, parsed_globals):
         super(MbCommand, self)._run_main(parsed_args, parsed_globals)
@@ -888,9 +906,17 @@ def _run_main(self, parsed_args, parsed_globals):
         if is_s3express_bucket(bucket):
             raise ValueError("Cannot use mb command with a directory bucket.")
 
-        bucket_config = {'LocationConstraint': self.client.meta.region_name}
         params = {'Bucket': bucket}
+        bucket_config = {}
+        bucket_tags = self._create_bucket_tags(parsed_args)
+
+        # Only set LocationConstraint when the region name is not us-east-1.
+        # Sending LocationConstraint with value us-east-1 results in an error.
         if self.client.meta.region_name != 'us-east-1':
+            bucket_config['LocationConstraint'] = self.client.meta.region_name
+        if bucket_tags:
+            bucket_config['Tags'] = bucket_tags
+        if bucket_config:
             params['CreateBucketConfiguration'] = bucket_config
 
         # TODO: Consolidate how we handle return codes and errors
@@ -905,6 +931,11 @@ def _run_main(self, parsed_args, parsed_globals):
             )
             return 1
 
+    def _create_bucket_tags(self, parsed_args):
+        if parsed_args.tags is not None:
+            return [{'Key': tag[0], 'Value': tag[1]} for tag in parsed_args.tags]
+        return []
+
 
 class RbCommand(S3Command):
     NAME = 'rb'

awscli/examples/s3/mb.rst

@@ -20,3 +20,16 @@ user makes the bucket ``amzn-s3-demo-bucket`` in the region ``us-west-1``::
 Output::
 
     make_bucket: s3://amzn-s3-demo-bucket
+
+**Example 3: Create a bucket with specified tags**
+
+The following ``mb`` command creates a bucket with specified tags using the ``--tags`` parameter. In this example, the
+user makes the bucket ``amzn-s3-demo-bucket`` with two tags with keys ``Key1`` and ``Key2``, respectively. ::
+
+    aws s3 mb s3://amzn-s3-demo-bucket \
+        --tags Key1 Value1 \
+        --tags Key2 Value2
+
+Output::
+
+    make_bucket: s3://amzn-s3-demo-bucket

tests/functional/s3/test_mb_command.py

@@ -49,4 +49,51 @@ def test_nonzero_exit_if_invalid_path_provided(self):
     def test_incompatible_with_express_directory_bucket(self):
         command = self.prefix + 's3://bucket--usw2-az1--x-s3/'
         stderr = self.run_cmd(command, expected_rc=255)[1]
-        self.assertIn('Cannot use mb command with a directory bucket.', stderr)
+        self.assertIn('Cannot use mb command with a directory bucket.', stderr)
+
+    def test_make_bucket_with_single_tag(self):
+        command = self.prefix + 's3://bucket --tags Key1 Value1 --region us-west-2'
+        expected_params = {
+            'Bucket': 'bucket',
+            'CreateBucketConfiguration': {
+                'LocationConstraint': 'us-west-2',
+                'Tags': [
+                    {'Key': 'Key1', 'Value': 'Value1'}
+                ]
+            }
+        }
+        self.assert_params_for_cmd(command, expected_params)
+
+    def test_make_bucket_with_single_tag_us_east_1(self):
+        command = self.prefix + 's3://bucket --tags Key1 Value1 --region us-east-1'
+        expected_params = {
+            'Bucket': 'bucket',
+            'CreateBucketConfiguration': {
+                'Tags': [
+                    {'Key': 'Key1', 'Value': 'Value1'}
+                ]
+            }
+        }
+        self.assert_params_for_cmd(command, expected_params)
+
+    def test_make_bucket_with_multiple_tags(self):
+        command = self.prefix + 's3://bucket --tags Key1 Value1 --tags Key2 Value2 --region us-west-2'
+        expected_params = {
+            'Bucket': 'bucket',
+            'CreateBucketConfiguration': {
+                'LocationConstraint': 'us-west-2',
+                'Tags': [
+                    {'Key': 'Key1', 'Value': 'Value1'},
+                    {'Key': 'Key2', 'Value': 'Value2'}
+                ]
+            }
+        }
+        self.assert_params_for_cmd(command, expected_params)
+
+    def test_tags_with_three_arguments_fails(self):
+        command = self.prefix + 's3://bucket --tags Key1 Value1 ExtraArg'
+        self.assert_params_for_cmd(
+            command,
+            expected_rc=255,
+            stderr_contains='Unknown options: ExtraArg'
+        )