1
0
mirror of https://github.com/minio/docs.git synced 2025-08-06 14:42:56 +03:00

DOCS-1287: fix broken links to ARN reference (#1288)

Change broken links to ARN reference to
`<IAM/latest/UserGuide/reference-arns>`

Co-authored-by: Pavel Anni <pavel@minio.io>
This commit is contained in:
Pavel Anni
2024-07-30 12:03:18 -04:00
committed by GitHub
parent 63e44aff1c
commit 7722414e1b
3 changed files with 35 additions and 35 deletions

View File

@@ -21,7 +21,7 @@ The :mc:`mc event add` command adds event notification triggers to a bucket.
.. end-mc-event-add-desc .. end-mc-event-add-desc
MinIO automatically sends triggered events to the configured MinIO automatically sends triggered events to the configured
:ref:`notification target <minio-bucket-notifications>`. :ref:`notification target <minio-bucket-notifications>`.
.. tab-set:: .. 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 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 <minio-bucket-notifications>` on the :ref:`bucket notification target <minio-bucket-notifications>` on the
``myminio`` deployment. ``myminio`` deployment.
@@ -66,7 +66,7 @@ Parameters
.. mc-cmd:: ALIAS .. mc-cmd:: ALIAS
*Required* The MinIO :ref:`alias <alias>` and bucket to *Required* The MinIO :ref:`alias <alias>` and bucket to
which the command adds the new event notification. For example: which the command adds the new event notification. For example:
.. code-block:: shell .. code-block:: shell
@@ -76,25 +76,25 @@ Parameters
.. mc-cmd:: ARN .. mc-cmd:: ARN
*Required* The :aws-docs:`Amazon Resource Name (ARN) *Required* The :aws-docs:`Amazon Resource Name (ARN)
<general/latest/gr/aws-arns-and-namespaces>` of the notification target. <IAM/latest/UserGuide/reference-arns>` of the notification target.
The MinIO server outputs an ARN for each configured The MinIO server outputs an ARN for each configured
notification target at server startup. See notification target at server startup. See
:ref:`Bucket Notifications <minio-bucket-notifications>` for more :ref:`Bucket Notifications <minio-bucket-notifications>` for more
information. information.
.. mc-cmd:: --event .. 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: Supports the following values:
- ``put`` - ``put``
- ``get`` - ``get``
- ``delete`` - ``delete``
Specify multiple value using a comma ``,`` delimiter. Specify multiple value using a comma ``,`` delimiter.
Defaults to ``put,delete,get``. Defaults to ``put,delete,get``.
@@ -102,15 +102,15 @@ Parameters
associated to each of the supported values. associated to each of the supported values.
.. mc-cmd:: ignore-existing, p .. mc-cmd:: ignore-existing, p
*Optional* Directs MinIO to ignore applying the specified event *Optional* Directs MinIO to ignore applying the specified event
triggers if an existing matching trigger exists. triggers if an existing matching trigger exists.
.. mc-cmd:: --prefix .. 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. :mc-cmd:`~mc event add --event` can trigger a bucket notification.
For example, given a :mc-cmd:`~mc event add ALIAS` of ``play/mybucket`` 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. Omit to trigger the event for all prefixes and objects in the bucket.
.. mc-cmd:: --suffix .. 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`` 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 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 The following command adds a new event notification trigger for all
S3 ``PUT``, ``GET``, and ``DELETE`` operations on a bucket. The command 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 <minio-bucket-notifications>`: :ref:`bucket notification target <minio-bucket-notifications>`:
.. code-block:: shell .. code-block:: shell
@@ -165,13 +165,13 @@ Add an Event Notification to a Bucket
mc event add ALIAS ARN mc event add ALIAS ARN
- Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO - Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO
deployment and the bucket on which to add the bucket notification event. deployment and the bucket on which to add the bucket notification event.
For example: For example:
``myminio/mydata`` ``myminio/mydata``
- Replace ``ARN`` with the notification target - Replace ``ARN`` with the notification target
:mc-cmd:`ARN <mc event add ARN>`. :mc-cmd:`ARN <mc event add ARN>`.

View File

@@ -61,7 +61,7 @@ Parameters
.. mc-cmd:: ALIAS .. mc-cmd:: ALIAS
*Required* The S3 service :ref:`alias <alias>` and bucket to *Required* The S3 service :ref:`alias <alias>` and bucket to
which the command lists event notification. For example: which the command lists event notification. For example:
.. code-block:: shell .. code-block:: shell
@@ -71,7 +71,7 @@ Parameters
.. mc-cmd:: ARN .. mc-cmd:: ARN
*Required* The :aws-docs:`Amazon Resource Name (ARN) *Required* The :aws-docs:`Amazon Resource Name (ARN)
<general/latest/gr/aws-arns-and-namespaces>` of the bucket resource. <IAM/latest/UserGuide/reference-arns>` of the bucket resource.
The MinIO server outputs an ARN for each configured notification target at The MinIO server outputs an ARN for each configured notification target at
server startup. See server startup. See
@@ -112,12 +112,12 @@ List Event Notifications on a Bucket
mc event ls ALIAS ARN mc event ls ALIAS ARN
- Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO - Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO
deployment on which to add the bucket notification event. For example: deployment on which to add the bucket notification event. For example:
``myminio/mydata`` ``myminio/mydata``
- Replace ``ARN`` with the notification target - Replace ``ARN`` with the notification target
:mc-cmd:`ARN <mc event add ARN>`. :mc-cmd:`ARN <mc event add ARN>`.
Behavior Behavior

View File

@@ -77,16 +77,16 @@ Parameters
.. mc-cmd:: ARN .. mc-cmd:: ARN
*Required* The :aws-docs:`Amazon Resource Name (ARN) *Required* The :aws-docs:`Amazon Resource Name (ARN)
<general/latest/gr/aws-arns-and-namespaces>` of the notification target. <IAM/latest/UserGuide/reference-arns>` of the notification target.
The MinIO server outputs an ARN for each configured The MinIO server outputs an ARN for each configured
notification target at server startup. See notification target at server startup. See
:ref:`minio-bucket-notifications` for more :ref:`minio-bucket-notifications` for more
information. information.
.. mc-cmd:: --event .. mc-cmd:: --event
*Optional* The event(s) to remove. Specify multiple events using a comma *Optional* The event(s) to remove. Specify multiple events using a comma
``,`` delimiter. See :ref:`mc-event-supported-events` for supported events. ``,`` 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. bucket with the :mc-cmd:`~mc event rm ARN` notification target.
.. mc-cmd:: --force .. mc-cmd:: --force
*Optional* Removes all events on the :mc-cmd:`~mc event rm ALIAS` bucket *Optional* Removes all events on the :mc-cmd:`~mc event rm ALIAS` bucket
with the :mc-cmd:`~mc event rm ARN` notification target. with the :mc-cmd:`~mc event rm ARN` notification target.
.. mc-cmd:: --prefix .. mc-cmd:: --prefix
*Optional* The bucket prefix in which the command removes bucket *Optional* The bucket prefix in which the command removes bucket
notifications. notifications.
@@ -111,10 +111,10 @@ Parameters
``play/mybucket/photos``. ``play/mybucket/photos``.
.. mc-cmd:: --suffix .. mc-cmd:: --suffix
*Optional* The bucket suffix in which the command removes bucket *Optional* The bucket suffix in which the command removes bucket
notifications. notifications.
For example, given a :mc-cmd:`~mc event rm ALIAS` of For example, given a :mc-cmd:`~mc event rm ALIAS` of
``play/mybucket`` and a :mc-cmd:`~mc event rm --suffix` 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 mc event rm ALIAS ARN
- Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO - Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO
deployment on which to add the bucket notification event. For example: deployment on which to add the bucket notification event. For example:
``myminio/mydata`` ``myminio/mydata``
- Replace ``ARN`` with the notification target - Replace ``ARN`` with the notification target
:mc-cmd:`ARN <mc event add ARN>`. :mc-cmd:`ARN <mc event add ARN>`.
Behavior Behavior