From 7722414e1b4fb97ee65e564e0adc21ef37b411a6 Mon Sep 17 00:00:00 2001 From: Pavel Anni Date: Tue, 30 Jul 2024 12:03:18 -0400 Subject: [PATCH] DOCS-1287: fix broken links to ARN reference (#1288) Change broken links to ARN reference to `` Co-authored-by: Pavel Anni --- source/reference/minio-mc/mc-event-add.rst | 38 +++++++++---------- source/reference/minio-mc/mc-event-list.rst | 8 ++-- source/reference/minio-mc/mc-event-remove.rst | 24 ++++++------ 3 files changed, 35 insertions(+), 35 deletions(-) diff --git a/source/reference/minio-mc/mc-event-add.rst b/source/reference/minio-mc/mc-event-add.rst index 4fea95ac..72382a93 100644 --- a/source/reference/minio-mc/mc-event-add.rst +++ b/source/reference/minio-mc/mc-event-add.rst @@ -21,7 +21,7 @@ The :mc:`mc event add` command adds event notification triggers to a bucket. .. end-mc-event-add-desc -MinIO automatically sends triggered events to the configured +MinIO automatically sends triggered events to the configured :ref:`notification target `. .. tab-set:: @@ -37,7 +37,7 @@ MinIO automatically sends triggered events to the configured mc event add --event "put,delete" myminio/mydata arn:aws:sqs::primary:target - The specified ARN corresponds to a configured + The specified ARN corresponds to a configured :ref:`bucket notification target ` on the ``myminio`` deployment. @@ -66,7 +66,7 @@ Parameters .. mc-cmd:: ALIAS - *Required* The MinIO :ref:`alias ` and bucket to + *Required* The MinIO :ref:`alias ` and bucket to which the command adds the new event notification. For example: .. code-block:: shell @@ -76,25 +76,25 @@ Parameters .. mc-cmd:: ARN *Required* The :aws-docs:`Amazon Resource Name (ARN) - ` of the notification target. + ` of the notification target. - The MinIO server outputs an ARN for each configured - notification target at server startup. See + The MinIO server outputs an ARN for each configured + notification target at server startup. See :ref:`Bucket Notifications ` for more information. .. mc-cmd:: --event - - *Optional* The event(s) for which MinIO generates bucket notifications. + + *Optional* The event(s) for which MinIO generates bucket notifications. Supports the following values: - ``put`` - ``get`` - ``delete`` - - Specify multiple value using a comma ``,`` delimiter. + + Specify multiple value using a comma ``,`` delimiter. Defaults to ``put,delete,get``. @@ -102,15 +102,15 @@ Parameters associated to each of the supported values. .. mc-cmd:: ignore-existing, p - + *Optional* Directs MinIO to ignore applying the specified event triggers if an existing matching trigger exists. .. mc-cmd:: --prefix - - *Optional* The bucket prefix in which the specified + + *Optional* The bucket prefix in which the specified :mc-cmd:`~mc event add --event` can trigger a bucket notification. For example, given a :mc-cmd:`~mc event add ALIAS` of ``play/mybucket`` @@ -120,10 +120,10 @@ Parameters Omit to trigger the event for all prefixes and objects in the bucket. .. mc-cmd:: --suffix - - *Optional* The bucket suffix in which the specified - :mc-cmd:`~mc event add --event` can trigger a bucket notification. + + *Optional* The bucket suffix in which the specified + :mc-cmd:`~mc event add --event` can trigger a bucket notification. For example, given a :mc-cmd:`~mc event add ALIAS` of ``play/mybucket`` and a :mc-cmd:`~mc event add --suffix` of ``.jpg``, only events in @@ -150,7 +150,7 @@ Add an Event Notification to a Bucket The following command adds a new event notification trigger for all S3 ``PUT``, ``GET``, and ``DELETE`` operations on a bucket. The command - assumes the MinIO deployment has at least one configured + assumes the MinIO deployment has at least one configured :ref:`bucket notification target `: .. code-block:: shell @@ -165,13 +165,13 @@ Add an Event Notification to a Bucket mc event add ALIAS ARN - - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO + - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO deployment and the bucket on which to add the bucket notification event. For example: ``myminio/mydata`` - - Replace ``ARN`` with the notification target + - Replace ``ARN`` with the notification target :mc-cmd:`ARN `. diff --git a/source/reference/minio-mc/mc-event-list.rst b/source/reference/minio-mc/mc-event-list.rst index e8cbcde3..9c251cc8 100644 --- a/source/reference/minio-mc/mc-event-list.rst +++ b/source/reference/minio-mc/mc-event-list.rst @@ -61,7 +61,7 @@ Parameters .. mc-cmd:: ALIAS - *Required* The S3 service :ref:`alias ` and bucket to + *Required* The S3 service :ref:`alias ` and bucket to which the command lists event notification. For example: .. code-block:: shell @@ -71,7 +71,7 @@ Parameters .. mc-cmd:: ARN *Required* The :aws-docs:`Amazon Resource Name (ARN) - ` of the bucket resource. + ` of the bucket resource. The MinIO server outputs an ARN for each configured notification target at server startup. See @@ -112,12 +112,12 @@ List Event Notifications on a Bucket mc event ls ALIAS ARN - - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO + - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO deployment on which to add the bucket notification event. For example: ``myminio/mydata`` - - Replace ``ARN`` with the notification target + - Replace ``ARN`` with the notification target :mc-cmd:`ARN `. Behavior diff --git a/source/reference/minio-mc/mc-event-remove.rst b/source/reference/minio-mc/mc-event-remove.rst index 59827a5e..b5d1217a 100644 --- a/source/reference/minio-mc/mc-event-remove.rst +++ b/source/reference/minio-mc/mc-event-remove.rst @@ -77,16 +77,16 @@ Parameters .. mc-cmd:: ARN *Required* The :aws-docs:`Amazon Resource Name (ARN) - ` of the notification target. + ` of the notification target. - The MinIO server outputs an ARN for each configured - notification target at server startup. See + The MinIO server outputs an ARN for each configured + notification target at server startup. See :ref:`minio-bucket-notifications` for more information. .. mc-cmd:: --event - - + + *Optional* The event(s) to remove. Specify multiple events using a comma ``,`` delimiter. See :ref:`mc-event-supported-events` for supported events. @@ -94,13 +94,13 @@ Parameters bucket with the :mc-cmd:`~mc event rm ARN` notification target. .. mc-cmd:: --force - - + + *Optional* Removes all events on the :mc-cmd:`~mc event rm ALIAS` bucket with the :mc-cmd:`~mc event rm ARN` notification target. .. mc-cmd:: --prefix - + *Optional* The bucket prefix in which the command removes bucket notifications. @@ -111,10 +111,10 @@ Parameters ``play/mybucket/photos``. .. mc-cmd:: --suffix - + *Optional* The bucket suffix in which the command removes bucket - notifications. + notifications. For example, given a :mc-cmd:`~mc event rm ALIAS` of ``play/mybucket`` and a :mc-cmd:`~mc event rm --suffix` of @@ -154,12 +154,12 @@ Remove Event Notifications from a Bucket mc event rm ALIAS ARN - - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO + - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO deployment on which to add the bucket notification event. For example: ``myminio/mydata`` - - Replace ``ARN`` with the notification target + - Replace ``ARN`` with the notification target :mc-cmd:`ARN `. Behavior