AWS QuickStart Redshift v0.0.3, Oct 15 21

aws-quickstart-redshift.Cluster

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            additional_security_group_id: Optional[Sequence[str]] = None,
            db_cluster_identifier: Optional[str] = None,
            db_maintenance_window: Optional[str] = None,
            db_master_password: Optional[str] = None,
            db_master_username: Optional[str] = None,
            db_name: Optional[str] = None,
            db_node_type: Optional[str] = None,
            db_port: Optional[int] = None,
            enable_event_subscription: Optional[bool] = None,
            enable_logging: Optional[bool] = None,
            glue_catalog_database_name: Optional[str] = None,
            max_concurrent_cluster: Optional[float] = None,
            notification_email: Optional[str] = None,
            num_db_nodes: Optional[int] = None,
            publicly_accessible: Optional[bool] = None,
            redshift_logging_s3_bucket_name: Optional[str] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            vpc_id: Optional[str] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: aws-quickstart-redshift:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Cluster resource accepts the following input properties:

DbClusterIdentifier string: The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
DbMasterPassword string: The password that is associated with the master user account for the cluster that is being created. Must have at least 8 characters and no more than 64 characters, and must include 1 uppercase letter, 1 lowercase letter, 1 number, and 1 symbol (excluding / @ " ').
DbMasterUsername string: The user name that is associated with the master user account for the cluster that is being created.
DbName string: The name of the first database to be created when the cluster is created.
DbNodeType string: The type of node to be provisioned
SubnetIDs List<string>: The list of subnet IDs in which to deploy the Redshift Cluster
VpcID string: The VPC with which to create the Redshift Cluster
AdditionalSecurityGroupID List<string>: An additional list of security group IDs to attach to the redshift cluster
DbMaintenanceWindow string: The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
DbPort int: The port number on which the cluster accepts incoming connections. Default is 8200
EnableEventSubscription bool: Set this parameter to false if you want to disable Amazon Redshift Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes. Default is true.
EnableLogging bool: Enables or disables logging to an S3 bucket. To enable logging, select True.
GlueCatalogDatabaseName string: The name of your Glue Data Catalog database.
MaxConcurrentCluster double: The maximum number of concurrency scaling Redshift clusters.
NotificationEmail string: The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
NumDbNodes int: The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
PubliclyAccessible bool: Specifies whether Amazon Redshift will be publicly accessible. If this option is set to True, the Amazon Redshift cluster will be created in a public subnet with security group whitelisting to RemoteAccessCIDR. If you leave the default option of False, the Amazon Redshift cluster will be created in a private subnet with security group whitelisting to VPCCIDR.
RedshiftLoggingS3BucketName string: Name for an S3 bucket for logging. An IAM role will be created and associated to the Redshift cluster with GET and LIST access to this bucket.

DbClusterIdentifier string: The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
DbMasterPassword string: The password that is associated with the master user account for the cluster that is being created. Must have at least 8 characters and no more than 64 characters, and must include 1 uppercase letter, 1 lowercase letter, 1 number, and 1 symbol (excluding / @ " ').
DbMasterUsername string: The user name that is associated with the master user account for the cluster that is being created.
DbName string: The name of the first database to be created when the cluster is created.
DbNodeType string: The type of node to be provisioned
SubnetIDs []string: The list of subnet IDs in which to deploy the Redshift Cluster
VpcID string: The VPC with which to create the Redshift Cluster
AdditionalSecurityGroupID []string: An additional list of security group IDs to attach to the redshift cluster
DbMaintenanceWindow string: The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
DbPort int: The port number on which the cluster accepts incoming connections. Default is 8200
EnableEventSubscription bool: Set this parameter to false if you want to disable Amazon Redshift Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes. Default is true.
EnableLogging bool: Enables or disables logging to an S3 bucket. To enable logging, select True.
GlueCatalogDatabaseName string: The name of your Glue Data Catalog database.
MaxConcurrentCluster float64: The maximum number of concurrency scaling Redshift clusters.
NotificationEmail string: The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
NumDbNodes int: The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
PubliclyAccessible bool: Specifies whether Amazon Redshift will be publicly accessible. If this option is set to True, the Amazon Redshift cluster will be created in a public subnet with security group whitelisting to RemoteAccessCIDR. If you leave the default option of False, the Amazon Redshift cluster will be created in a private subnet with security group whitelisting to VPCCIDR.
RedshiftLoggingS3BucketName string: Name for an S3 bucket for logging. An IAM role will be created and associated to the Redshift cluster with GET and LIST access to this bucket.

dbClusterIdentifier String: The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
dbMasterPassword String: The password that is associated with the master user account for the cluster that is being created. Must have at least 8 characters and no more than 64 characters, and must include 1 uppercase letter, 1 lowercase letter, 1 number, and 1 symbol (excluding / @ " ').
dbMasterUsername String: The user name that is associated with the master user account for the cluster that is being created.
dbName String: The name of the first database to be created when the cluster is created.
dbNodeType String: The type of node to be provisioned
subnetIDs List<String>: The list of subnet IDs in which to deploy the Redshift Cluster
vpcID String: The VPC with which to create the Redshift Cluster
additionalSecurityGroupID List<String>: An additional list of security group IDs to attach to the redshift cluster
dbMaintenanceWindow String: The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
dbPort Integer: The port number on which the cluster accepts incoming connections. Default is 8200
enableEventSubscription Boolean: Set this parameter to false if you want to disable Amazon Redshift Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes. Default is true.
enableLogging Boolean: Enables or disables logging to an S3 bucket. To enable logging, select True.
glueCatalogDatabaseName String: The name of your Glue Data Catalog database.
maxConcurrentCluster Double: The maximum number of concurrency scaling Redshift clusters.
notificationEmail String: The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
numDbNodes Integer: The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
publiclyAccessible Boolean: Specifies whether Amazon Redshift will be publicly accessible. If this option is set to True, the Amazon Redshift cluster will be created in a public subnet with security group whitelisting to RemoteAccessCIDR. If you leave the default option of False, the Amazon Redshift cluster will be created in a private subnet with security group whitelisting to VPCCIDR.
redshiftLoggingS3BucketName String: Name for an S3 bucket for logging. An IAM role will be created and associated to the Redshift cluster with GET and LIST access to this bucket.

dbClusterIdentifier string: The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
dbMasterPassword string: The password that is associated with the master user account for the cluster that is being created. Must have at least 8 characters and no more than 64 characters, and must include 1 uppercase letter, 1 lowercase letter, 1 number, and 1 symbol (excluding / @ " ').
dbMasterUsername string: The user name that is associated with the master user account for the cluster that is being created.
dbName string: The name of the first database to be created when the cluster is created.
dbNodeType string: The type of node to be provisioned
subnetIDs string[]: The list of subnet IDs in which to deploy the Redshift Cluster
vpcID string: The VPC with which to create the Redshift Cluster
additionalSecurityGroupID string[]: An additional list of security group IDs to attach to the redshift cluster
dbMaintenanceWindow string: The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
dbPort number: The port number on which the cluster accepts incoming connections. Default is 8200
enableEventSubscription boolean: Set this parameter to false if you want to disable Amazon Redshift Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes. Default is true.
enableLogging boolean: Enables or disables logging to an S3 bucket. To enable logging, select True.
glueCatalogDatabaseName string: The name of your Glue Data Catalog database.
maxConcurrentCluster number: The maximum number of concurrency scaling Redshift clusters.
notificationEmail string: The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
numDbNodes number: The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
publiclyAccessible boolean: Specifies whether Amazon Redshift will be publicly accessible. If this option is set to True, the Amazon Redshift cluster will be created in a public subnet with security group whitelisting to RemoteAccessCIDR. If you leave the default option of False, the Amazon Redshift cluster will be created in a private subnet with security group whitelisting to VPCCIDR.
redshiftLoggingS3BucketName string: Name for an S3 bucket for logging. An IAM role will be created and associated to the Redshift cluster with GET and LIST access to this bucket.

db_cluster_identifier str: The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
db_master_password str: The password that is associated with the master user account for the cluster that is being created. Must have at least 8 characters and no more than 64 characters, and must include 1 uppercase letter, 1 lowercase letter, 1 number, and 1 symbol (excluding / @ " ').
db_master_username str: The user name that is associated with the master user account for the cluster that is being created.
db_name str: The name of the first database to be created when the cluster is created.
db_node_type str: The type of node to be provisioned
subnet_ids Sequence[str]: The list of subnet IDs in which to deploy the Redshift Cluster
vpc_id str: The VPC with which to create the Redshift Cluster
additional_security_group_id Sequence[str]: An additional list of security group IDs to attach to the redshift cluster
db_maintenance_window str: The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
db_port int: The port number on which the cluster accepts incoming connections. Default is 8200
enable_event_subscription bool: Set this parameter to false if you want to disable Amazon Redshift Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes. Default is true.
enable_logging bool: Enables or disables logging to an S3 bucket. To enable logging, select True.
glue_catalog_database_name str: The name of your Glue Data Catalog database.
max_concurrent_cluster float: The maximum number of concurrency scaling Redshift clusters.
notification_email str: The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
num_db_nodes int: The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
publicly_accessible bool: Specifies whether Amazon Redshift will be publicly accessible. If this option is set to True, the Amazon Redshift cluster will be created in a public subnet with security group whitelisting to RemoteAccessCIDR. If you leave the default option of False, the Amazon Redshift cluster will be created in a private subnet with security group whitelisting to VPCCIDR.
redshift_logging_s3_bucket_name str: Name for an S3 bucket for logging. An IAM role will be created and associated to the Redshift cluster with GET and LIST access to this bucket.

dbClusterIdentifier String: The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
dbMasterPassword String: The password that is associated with the master user account for the cluster that is being created. Must have at least 8 characters and no more than 64 characters, and must include 1 uppercase letter, 1 lowercase letter, 1 number, and 1 symbol (excluding / @ " ').
dbMasterUsername String: The user name that is associated with the master user account for the cluster that is being created.
dbName String: The name of the first database to be created when the cluster is created.
dbNodeType String: The type of node to be provisioned
subnetIDs List<String>: The list of subnet IDs in which to deploy the Redshift Cluster
vpcID String: The VPC with which to create the Redshift Cluster
additionalSecurityGroupID List<String>: An additional list of security group IDs to attach to the redshift cluster
dbMaintenanceWindow String: The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
dbPort Number: The port number on which the cluster accepts incoming connections. Default is 8200
enableEventSubscription Boolean: Set this parameter to false if you want to disable Amazon Redshift Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes. Default is true.
enableLogging Boolean: Enables or disables logging to an S3 bucket. To enable logging, select True.
glueCatalogDatabaseName String: The name of your Glue Data Catalog database.
maxConcurrentCluster Number: The maximum number of concurrency scaling Redshift clusters.
notificationEmail String: The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
numDbNodes Number: The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
publiclyAccessible Boolean: Specifies whether Amazon Redshift will be publicly accessible. If this option is set to True, the Amazon Redshift cluster will be created in a public subnet with security group whitelisting to RemoteAccessCIDR. If you leave the default option of False, the Amazon Redshift cluster will be created in a private subnet with security group whitelisting to VPCCIDR.
redshiftLoggingS3BucketName String: Name for an S3 bucket for logging. An IAM role will be created and associated to the Redshift cluster with GET and LIST access to this bucket.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

Package Details

Repository: AWS QuickStart Redshift
License