Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc build failure on main #23240

Merged
merged 4 commits into from
Apr 26, 2022
Merged

Fix doc build failure on main #23240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1d55fd
Fix Redshift node_type docstring format
uranusjr Apr 26, 2022
9ea659e
Fix underline
uranusjr Apr 26, 2022
7bbf0ae
Fix example_redshift_cluster.py relative path
uranusjr Apr 26, 2022
101f4a4
Add proper seealso link in operator docstring
uranusjr Apr 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions airflow/providers/amazon/aws/hooks/redshift_cluster.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ def create_cluster(

:param cluster_identifier: A unique identifier for the cluster.
:param node_type: The node type to be provisioned for the cluster.
Valid Values: ``ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge
| dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge``
Valid Values: ``ds2.xlarge``, ``ds2.8xlarge``, ``dc1.large``,
``dc1.8xlarge``, ``dc2.large``, ``dc2.8xlarge``, ``ra3.xlplus``,
``ra3.4xlarge``, and ``ra3.16xlarge``.
:param master_username: The username associated with the admin user account
for the cluster that is being created.
:param master_user_password: password associated with the admin user account
Expand Down
12 changes: 8 additions & 4 deletions airflow/providers/amazon/aws/operators/redshift_cluster.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,17 @@


class RedshiftCreateClusterOperator(BaseOperator):
"""
Creates a new cluster with the specified parameters.
"""Creates a new cluster with the specified parameters.

.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:RedshiftCreateClusterOperator`

:param cluster_identifier: A unique identifier for the cluster.
:param node_type: The node type to be provisioned for the cluster.
Valid Values: ``ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge
| dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge``
Valid Values: ``ds2.xlarge``, ``ds2.8xlarge``, ``dc1.large``,
``dc1.8xlarge``, ``dc2.large``, ``dc2.8xlarge``, ``ra3.xlplus``,
``ra3.4xlarge``, and ``ra3.16xlarge``.
:param master_username: The username associated with the admin user account for
the cluster that is being created.
:param master_user_password: The password associated with the admin user account for
Expand Down
4 changes: 2 additions & 2 deletions docs/apache-airflow-providers-amazon/operators/redshift_cluster.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ Manage Amazon Redshift Clusters
.. _howto/operator:RedshiftCreateClusterOperator:

Amazon Redshift Cluster Operator
""""""""""""""""""""""""""""""
""""""""""""""""""""""""""""""""

To create an Amazon Redshift Cluster with the specified parameters
:class:`~airflow.providers.amazon.aws.operators.redshift_cluster.RedshiftCreateClusterOperator`.

.. exampleinclude:: /../../../airflow/providers/amazon/aws/example_dags/example_redshift_cluster.py
.. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_redshift_cluster.py
:language: python
:dedent: 4
:start-after: [START howto_operator_redshift_cluster]
Expand Down