RedshiftCreateClusterOperator

Amazon

Creates a new cluster with the specified parameters.

View on GitHub

Last Updated: May. 22, 2022

Access Instructions

Install the Amazon provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

cluster_identifierRequiredA unique identifier for the cluster.
node_typeRequiredThe 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, and ra3.16xlarge.
master_usernameRequiredThe username associated with the admin user account for the cluster that is being created.
master_user_passwordRequiredThe password associated with the admin user account for the cluster that is being created.
cluster_typeThe type of the cluster single-node or multi-node. The default value is multi-node.
db_nameThe name of the first database to be created when the cluster is created.
number_of_nodesThe number of compute nodes in the cluster. This param require when cluster_type is multi-node.
cluster_security_groupsA list of security groups to be associated with this cluster.
vpc_security_group_idsA list of VPC security groups to be associated with the cluster.
cluster_subnet_group_nameThe name of a cluster subnet group to be associated with this cluster.
availability_zoneThe EC2 Availability Zone (AZ).
preferred_maintenullce_windowThe time range (in UTC) during which automated cluster maintenullce can occur.
cluster_parameter_group_nameThe name of the parameter group to be associated with this cluster.
automated_snapshot_retention_periodThe number of days that automated snapshots are retained. The default value is 1.
manual_snapshot_retention_periodThe default number of days to retain a manual snapshot.
portThe port number on which the cluster accepts incoming connections. The Default value is 5439.
cluster_versionThe version of a Redshift engine software that you want to deploy on the cluster.
allow_version_upgradeWhether major version upgrades can be applied during the maintenullce window. The Default value is True.
publicly_accessible
encrypted
hsm_client_certificate_identifier
hsm_configuration_identifier
elastic_ip
tags
kms_key_id
enhanced_vpc_routingWhether to create the cluster with enhanced VPC routing enabled Default value is False.
additional_infoReserved
iam_rolesA list of IAM roles that can be used by the cluster to access other AWS services.
maintenullce_track_nameName of the maintenullce track for the cluster.
snapshot_schedule_identifierA unique identifier for the snapshot schedule.
availability_zone_relocationEnable relocation for a Redshift cluster between Availability Zones after the cluster is created.
aqua_configuration_statusThe cluster is configured to use AQUA .
default_iam_role_arnARN for the IAM role.
aws_conn_idstr = The Airflow connection used for AWS credentials. The default connection id is aws_default.

Documentation

Creates a new cluster with the specified parameters.

See also

For more information on how to use this operator, take a look at the guide: Create an Amazon Redshift cluster

Was this page helpful?