Skip to content

Commit

Permalink
DOCS-1287: fix broken links to ARN reference (#1288)
Browse files Browse the repository at this point in the history
Change broken links to ARN reference to
`<IAM/latest/UserGuide/reference-arns>`

Co-authored-by: Pavel Anni <[email protected]>
  • Loading branch information
pavelanni and Pavel Anni authored Jul 30, 2024
1 parent 63e44af commit 7722414
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 35 deletions.
38 changes: 19 additions & 19 deletions source/reference/minio-mc/mc-event-add.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <minio-bucket-notifications>`.

.. tab-set::
Expand All @@ -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 <minio-bucket-notifications>` on the
``myminio`` deployment.

Expand Down Expand Up @@ -66,7 +66,7 @@ Parameters

.. 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:

.. code-block:: shell
Expand All @@ -76,41 +76,41 @@ Parameters
.. mc-cmd:: 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
notification target at server startup. See
The MinIO server outputs an ARN for each configured
notification target at server startup. See
:ref:`Bucket Notifications <minio-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``.

See :ref:`mc-event-supported-events` for a detailed list of S3 events
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``
Expand All @@ -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
Expand All @@ -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 <minio-bucket-notifications>`:

.. code-block:: shell
Expand All @@ -165,13 +165,13 @@ Add an Event Notification to a Bucket
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.
For example:

``myminio/mydata``

- Replace ``ARN`` with the notification target
- Replace ``ARN`` with the notification target
:mc-cmd:`ARN <mc event add ARN>`.


Expand Down
8 changes: 4 additions & 4 deletions source/reference/minio-mc/mc-event-list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Parameters

.. 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:

.. code-block:: shell
Expand All @@ -71,7 +71,7 @@ Parameters
.. mc-cmd:: 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
server startup. See
Expand Down Expand Up @@ -112,12 +112,12 @@ List Event Notifications on a Bucket
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:

``myminio/mydata``

- Replace ``ARN`` with the notification target
- Replace ``ARN`` with the notification target
:mc-cmd:`ARN <mc event add ARN>`.

Behavior
Expand Down
24 changes: 12 additions & 12 deletions source/reference/minio-mc/mc-event-remove.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,30 +77,30 @@ Parameters
.. mc-cmd:: 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
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.

Defaults to removing all events on the :mc-cmd:`~mc event rm ALIAS`
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.
Expand All @@ -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
Expand Down Expand Up @@ -154,12 +154,12 @@ Remove Event Notifications from a Bucket
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:

``myminio/mydata``

- Replace ``ARN`` with the notification target
- Replace ``ARN`` with the notification target
:mc-cmd:`ARN <mc event add ARN>`.

Behavior
Expand Down

0 comments on commit 7722414

Please sign in to comment.