airflow.providers.amazon.aws.hooks.redshift_cluster
¶
Module Contents¶
Classes¶
Interact with Amazon Redshift. |
|
Interact with AWS Redshift using aiobotocore library |
- class airflow.providers.amazon.aws.hooks.redshift_cluster.RedshiftHook(*args, **kwargs)[source]¶
Bases:
airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook
Interact with Amazon Redshift. Provide thin wrapper around
boto3.client("redshift")
.Additional arguments (such as
aws_conn_id
) may be specified and are passed down to the underlying AwsBaseHook.- create_cluster(cluster_identifier, node_type, master_username, master_user_password, params)[source]¶
Creates a new cluster with the specified parameters
See also
- Parameters
cluster_identifier (str) – A unique identifier for the cluster.
node_type (str) – 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
, andra3.16xlarge
.master_username (str) – The username associated with the admin user account for the cluster that is being created.
master_user_password (str) – password associated with the admin user account for the cluster that is being created.
params (dict[str, Any]) – Remaining AWS Create cluster API params.
- cluster_status(cluster_identifier)[source]¶
Return status of a cluster
See also
- Parameters
cluster_identifier (str) – unique identifier of a cluster
skip_final_cluster_snapshot – determines cluster snapshot creation
final_cluster_snapshot_identifier – Optional[str]
- delete_cluster(cluster_identifier, skip_final_cluster_snapshot=True, final_cluster_snapshot_identifier=None)[source]¶
Delete a cluster and optionally create a snapshot
See also
- describe_cluster_snapshots(cluster_identifier)[source]¶
Gets a list of snapshots for a cluster
- Parameters
cluster_identifier (str) – unique identifier of a cluster
- restore_from_cluster_snapshot(cluster_identifier, snapshot_identifier)[source]¶
Restores a cluster from its snapshot
- create_cluster_snapshot(snapshot_identifier, cluster_identifier, retention_period=-1)[source]¶
Creates a snapshot of a cluster
- class airflow.providers.amazon.aws.hooks.redshift_cluster.RedshiftAsyncHook(*args, **kwargs)[source]¶
Bases:
airflow.providers.amazon.aws.hooks.base_aws.AwsBaseAsyncHook
Interact with AWS Redshift using aiobotocore library
- async cluster_status(cluster_identifier, delete_operation=False)[source]¶
Connects to the AWS redshift cluster via aiobotocore and get the status and returns the status of the cluster based on the cluster_identifier passed
- async pause_cluster(cluster_identifier, poll_interval=5.0)[source]¶
Connects to the AWS redshift cluster via aiobotocore and pause the cluster based on the cluster_identifier passed
- async resume_cluster(cluster_identifier, polling_period_seconds=5.0)[source]¶
Connects to the AWS redshift cluster via aiobotocore and resume the cluster for the cluster_identifier passed
- async get_cluster_status(cluster_identifier, expected_state, flag, delete_operation=False)[source]¶
check for expected Redshift cluster state
- Parameters
cluster_identifier (str) – unique identifier of a cluster
expected_state (str) – expected_state example(“available”, “pausing”, “paused””)
flag (asyncio.Event) – asyncio even flag set true if success and if any error
delete_operation (bool) – whether the method has been called as part of delete cluster operation