airflow.providers.amazon.aws.hooks.redshift_cluster

Module Contents

Classes

RedshiftHook

Interact with AWS Redshift, using the boto3 library
class airflow.providers.amazon.aws.hooks.redshift_cluster.RedshiftHook(*args, **kwargs)[source]

Bases: airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook

Interact with AWS Redshift, using the boto3 library

Additional arguments (such as aws_conn_id) may be specified and are passed down to the underlying AwsBaseHook.

See also

AwsBaseHook

Parameters

aws_conn_id (str) -- The Airflow connection used for AWS credentials.

cluster_status(self, cluster_identifier: str) → str[source]

Return status of a cluster

Parameters

  • cluster_identifier (str) -- unique identifier of a cluster

  • skip_final_cluster_snapshot (bool) -- determines cluster snapshot creation

  • final_cluster_snapshot_identifier (Optional[str]) -- Optional[str]

delete_cluster(self, cluster_identifier: str, skip_final_cluster_snapshot: bool = True, final_cluster_snapshot_identifier: Optional[str] = None)[source]

Delete a cluster and optionally create a snapshot

Parameters

  • cluster_identifier (str) -- unique identifier of a cluster

  • skip_final_cluster_snapshot (bool) -- determines cluster snapshot creation

  • final_cluster_snapshot_identifier (str) -- name of final cluster snapshot

describe_cluster_snapshots(self, cluster_identifier: str) → Optional[List[str]][source]

Gets a list of snapshots for a cluster

Parameters

cluster_identifier (str) -- unique identifier of a cluster

restore_from_cluster_snapshot(self, cluster_identifier: str, snapshot_identifier: str) → str[source]

Restores a cluster from its snapshot

Parameters

  • cluster_identifier (str) -- unique identifier of a cluster

  • snapshot_identifier (str) -- unique identifier for a snapshot of a cluster

create_cluster_snapshot(self, snapshot_identifier: str, cluster_identifier: str) → str[source]

Creates a snapshot of a cluster

Parameters

  • snapshot_identifier (str) -- unique identifier for a snapshot of a cluster

  • cluster_identifier (str) -- unique identifier of a cluster

Was this entry helpful?