AWS QuickStart Redshift v0.0.3 published on Friday, Oct 15, 2021 by Pulumi
aws-quickstart-redshift.Cluster
Explore with Pulumi AI
AWS QuickStart Redshift v0.0.3 published on Friday, Oct 15, 2021 by Pulumi
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
subnet_ids: Optional[Sequence[str]] = None,
db_cluster_identifier: Optional[str] = None,
vpc_id: 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,
enable_event_subscription: Optional[bool] = None,
additional_security_group_id: Optional[Sequence[str]] = 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,
db_port: Optional[int] = None,
db_maintenance_window: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var clusterResource = new AwsQuickStartRedshift.Cluster("clusterResource", new()
{
SubnetIDs = new[]
{
"string",
},
DbClusterIdentifier = "string",
VpcID = "string",
DbMasterPassword = "string",
DbMasterUsername = "string",
DbName = "string",
DbNodeType = "string",
EnableEventSubscription = false,
AdditionalSecurityGroupID = new[]
{
"string",
},
EnableLogging = false,
GlueCatalogDatabaseName = "string",
MaxConcurrentCluster = 0,
NotificationEmail = "string",
NumDbNodes = 0,
PubliclyAccessible = false,
RedshiftLoggingS3BucketName = "string",
DbPort = 0,
DbMaintenanceWindow = "string",
});
example, err := awsquickstartredshift.NewCluster(ctx, "clusterResource", &awsquickstartredshift.ClusterArgs{
SubnetIDs: pulumi.StringArray{
pulumi.String("string"),
},
DbClusterIdentifier: "string",
VpcID: pulumi.String("string"),
DbMasterPassword: pulumi.String("string"),
DbMasterUsername: "string",
DbName: "string",
DbNodeType: "string",
EnableEventSubscription: false,
AdditionalSecurityGroupID: pulumi.StringArray{
pulumi.String("string"),
},
EnableLogging: false,
GlueCatalogDatabaseName: "string",
MaxConcurrentCluster: 0,
NotificationEmail: "string",
NumDbNodes: 0,
PubliclyAccessible: false,
RedshiftLoggingS3BucketName: "string",
DbPort: 0,
DbMaintenanceWindow: "string",
})
var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
.subnetIDs("string")
.dbClusterIdentifier("string")
.vpcID("string")
.dbMasterPassword("string")
.dbMasterUsername("string")
.dbName("string")
.dbNodeType("string")
.enableEventSubscription(false)
.additionalSecurityGroupID("string")
.enableLogging(false)
.glueCatalogDatabaseName("string")
.maxConcurrentCluster(0)
.notificationEmail("string")
.numDbNodes(0)
.publiclyAccessible(false)
.redshiftLoggingS3BucketName("string")
.dbPort(0)
.dbMaintenanceWindow("string")
.build());
cluster_resource = aws_quickstart_redshift.Cluster("clusterResource",
subnet_ids=["string"],
db_cluster_identifier="string",
vpc_id="string",
db_master_password="string",
db_master_username="string",
db_name="string",
db_node_type="string",
enable_event_subscription=False,
additional_security_group_id=["string"],
enable_logging=False,
glue_catalog_database_name="string",
max_concurrent_cluster=0,
notification_email="string",
num_db_nodes=0,
publicly_accessible=False,
redshift_logging_s3_bucket_name="string",
db_port=0,
db_maintenance_window="string")
const clusterResource = new aws_quickstart_redshift.Cluster("clusterResource", {
subnetIDs: ["string"],
dbClusterIdentifier: "string",
vpcID: "string",
dbMasterPassword: "string",
dbMasterUsername: "string",
dbName: "string",
dbNodeType: "string",
enableEventSubscription: false,
additionalSecurityGroupID: ["string"],
enableLogging: false,
glueCatalogDatabaseName: "string",
maxConcurrentCluster: 0,
notificationEmail: "string",
numDbNodes: 0,
publiclyAccessible: false,
redshiftLoggingS3BucketName: "string",
dbPort: 0,
dbMaintenanceWindow: "string",
});
type: aws-quickstart-redshift:Cluster
properties:
additionalSecurityGroupID:
- string
dbClusterIdentifier: string
dbMaintenanceWindow: string
dbMasterPassword: string
dbMasterUsername: string
dbName: string
dbNodeType: string
dbPort: 0
enableEventSubscription: false
enableLogging: false
glueCatalogDatabaseName: string
maxConcurrentCluster: 0
notificationEmail: string
numDbNodes: 0
publiclyAccessible: false
redshiftLoggingS3BucketName: string
subnetIDs:
- string
vpcID: string
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:
- Db
Cluster stringIdentifier - The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
- Db
Master stringPassword - 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 stringUsername - The user name that is associated with the master user account for the cluster that is being created.
- Db
Name string - The name of the first database to be created when the cluster is created.
- Db
Node stringType - The type of node to be provisioned
- Subnet
IDs List<string> - The list of subnet IDs in which to deploy the Redshift Cluster
- Vpc
ID string - The VPC with which to create the Redshift Cluster
- Additional
Security List<string>Group ID - An additional list of security group IDs to attach to the redshift cluster
- Db
Maintenance stringWindow - 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 boolSubscription - 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 istrue
. - Enable
Logging bool - Enables or disables logging to an S3 bucket. To enable logging, select True.
- Glue
Catalog stringDatabase Name - The name of your Glue Data Catalog database.
- Max
Concurrent doubleCluster - The maximum number of concurrency scaling Redshift clusters.
- Notification
Email string - The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
- Num
Db intNodes - 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 stringS3Bucket Name - 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 stringIdentifier - The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
- Db
Master stringPassword - 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 stringUsername - The user name that is associated with the master user account for the cluster that is being created.
- Db
Name string - The name of the first database to be created when the cluster is created.
- Db
Node stringType - The type of node to be provisioned
- Subnet
IDs []string - The list of subnet IDs in which to deploy the Redshift Cluster
- Vpc
ID string - The VPC with which to create the Redshift Cluster
- Additional
Security []stringGroup ID - An additional list of security group IDs to attach to the redshift cluster
- Db
Maintenance stringWindow - 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 boolSubscription - 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 istrue
. - Enable
Logging bool - Enables or disables logging to an S3 bucket. To enable logging, select True.
- Glue
Catalog stringDatabase Name - The name of your Glue Data Catalog database.
- Max
Concurrent float64Cluster - The maximum number of concurrency scaling Redshift clusters.
- Notification
Email string - The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
- Num
Db intNodes - 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 stringS3Bucket Name - 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 StringIdentifier - The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
- db
Master StringPassword - 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 StringUsername - The user name that is associated with the master user account for the cluster that is being created.
- db
Name String - The name of the first database to be created when the cluster is created.
- db
Node StringType - The type of node to be provisioned
- subnet
IDs List<String> - The list of subnet IDs in which to deploy the Redshift Cluster
- vpc
ID String - The VPC with which to create the Redshift Cluster
- additional
Security List<String>Group ID - An additional list of security group IDs to attach to the redshift cluster
- db
Maintenance StringWindow - The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
- db
Port Integer - The port number on which the cluster accepts incoming connections. Default is 8200
- enable
Event BooleanSubscription - 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 istrue
. - enable
Logging Boolean - Enables or disables logging to an S3 bucket. To enable logging, select True.
- glue
Catalog StringDatabase Name - The name of your Glue Data Catalog database.
- max
Concurrent DoubleCluster - The maximum number of concurrency scaling Redshift clusters.
- notification
Email String - The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
- num
Db IntegerNodes - The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
- publicly
Accessible 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.
- redshift
Logging StringS3Bucket Name - 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 stringIdentifier - The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
- db
Master stringPassword - 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 stringUsername - The user name that is associated with the master user account for the cluster that is being created.
- db
Name string - The name of the first database to be created when the cluster is created.
- db
Node stringType - The type of node to be provisioned
- subnet
IDs string[] - The list of subnet IDs in which to deploy the Redshift Cluster
- vpc
ID string - The VPC with which to create the Redshift Cluster
- additional
Security string[]Group ID - An additional list of security group IDs to attach to the redshift cluster
- db
Maintenance stringWindow - The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
- db
Port number - The port number on which the cluster accepts incoming connections. Default is 8200
- enable
Event booleanSubscription - 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 istrue
. - enable
Logging boolean - Enables or disables logging to an S3 bucket. To enable logging, select True.
- glue
Catalog stringDatabase Name - The name of your Glue Data Catalog database.
- max
Concurrent numberCluster - The maximum number of concurrency scaling Redshift clusters.
- notification
Email string - The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
- num
Db numberNodes - The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
- publicly
Accessible 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.
- redshift
Logging stringS3Bucket Name - 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_ stridentifier - The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
- db_
master_ strpassword - 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_ strusername - 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_ strtype - 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_ Sequence[str]group_ id - An additional list of security group IDs to attach to the redshift cluster
- db_
maintenance_ strwindow - 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_ boolsubscription - 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 istrue
. - enable_
logging bool - Enables or disables logging to an S3 bucket. To enable logging, select True.
- glue_
catalog_ strdatabase_ name - The name of your Glue Data Catalog database.
- max_
concurrent_ floatcluster - 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_ intnodes - 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_ strs3_ bucket_ name - 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 StringIdentifier - The identifier of the Redshift Cluster. Must contain only lowercase, alphanumeric characters and hyphens.
- db
Master StringPassword - 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 StringUsername - The user name that is associated with the master user account for the cluster that is being created.
- db
Name String - The name of the first database to be created when the cluster is created.
- db
Node StringType - The type of node to be provisioned
- subnet
IDs List<String> - The list of subnet IDs in which to deploy the Redshift Cluster
- vpc
ID String - The VPC with which to create the Redshift Cluster
- additional
Security List<String>Group ID - An additional list of security group IDs to attach to the redshift cluster
- db
Maintenance StringWindow - The maintenance window for the Redshift cluster. e.g 'sat:05:00-sat:05:30'
- db
Port Number - The port number on which the cluster accepts incoming connections. Default is 8200
- enable
Event BooleanSubscription - 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 istrue
. - enable
Logging Boolean - Enables or disables logging to an S3 bucket. To enable logging, select True.
- glue
Catalog StringDatabase Name - The name of your Glue Data Catalog database.
- max
Concurrent NumberCluster - The maximum number of concurrency scaling Redshift clusters.
- notification
Email String - The email notification list that is used to configure an SNS topic for sending CloudWatch alarm and event notifications.
- num
Db NumberNodes - The number of compute nodes in the cluster. For multi-node clusters, the NumberOfNodes parameter must be greater than 1.
- publicly
Accessible 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.
- redshift
Logging StringS3Bucket Name - 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
AWS QuickStart Redshift v0.0.3 published on Friday, Oct 15, 2021 by Pulumi