ClusterProps

class aws_cdk.aws_redshift.ClusterProps(*, master_user, vpc, cluster_name=None, cluster_type=None, default_database_name=None, encrypted=None, encryption_key=None, logging_bucket=None, logging_key_prefix=None, node_type=None, number_of_nodes=None, parameter_group=None, port=None, preferred_maintenance_window=None, publicly_accessible=None, removal_policy=None, roles=None, security_groups=None, subnet_group=None, vpc_subnets=None)

Bases: object

(experimental) Properties for a new database cluster.

Parameters
  • master_user (Login) – (experimental) Username and password for the administrative user.

  • vpc (IVpc) – (experimental) The VPC to place the cluster in.

  • cluster_name (Optional[str]) – (experimental) An optional identifier for the cluster. Default: - A name is automatically generated.

  • cluster_type (Optional[ClusterType]) – (experimental) Settings for the individual instances that are launched. Default: {@link ClusterType.MULTI_NODE}

  • default_database_name (Optional[str]) – (experimental) Name of a database which is automatically created inside the cluster. Default: - default_db

  • encrypted (Optional[bool]) – (experimental) Whether to enable encryption of data at rest in the cluster. Default: true

  • encryption_key (Optional[IKey]) – (experimental) The KMS key to use for encryption of data at rest. Default: - AWS-managed key, if encryption at rest is enabled

  • logging_bucket (Optional[IBucket]) – (experimental) Bucket to send logs to. Logging information includes queries and connection attempts, for the specified Amazon Redshift cluster. Default: - No Logs

  • logging_key_prefix (Optional[str]) – (experimental) Prefix used for logging. Default: - no prefix

  • node_type (Optional[NodeType]) – (experimental) The node type to be provisioned for the cluster. Default: {@link NodeType.DC2_LARGE}

  • number_of_nodes (Union[int, float, None]) – (experimental) Number of compute nodes in the cluster. Only specify this property for multi-node clusters. Value must be at least 2 and no more than 100. Default: - 2 if clusterType is ClusterType.MULTI_NODE, undefined otherwise

  • parameter_group (Optional[IClusterParameterGroup]) – (experimental) Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html. Default: - No parameter group.

  • port (Union[int, float, None]) – (experimental) What port to listen on. Default: - The default for the engine is used.

  • preferred_maintenance_window (Optional[str]) – (experimental) A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: ‘Sun:23:45-Mon:00:15’ Default: - 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

  • publicly_accessible (Optional[bool]) – (experimental) Whether to make cluster publicly accessible. Default: false

  • removal_policy (Optional[RemovalPolicy]) – (experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. Default: RemovalPolicy.RETAIN

  • roles (Optional[Sequence[IRole]]) – (experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services. Specify a maximum of 10 roles. Default: - No role is attached to the cluster.

  • security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) Security group. Default: - a new security group is created.

  • subnet_group (Optional[IClusterSubnetGroup]) – (experimental) A cluster subnet group to use with this cluster. Default: - a new subnet group will be created.

  • vpc_subnets (Optional[SubnetSelection]) – (experimental) Where to place the instances within the VPC. Default: - private subnets

Stability

experimental

Attributes

cluster_name

(experimental) An optional identifier for the cluster.

Default
  • A name is automatically generated.

Stability

experimental

Return type

Optional[str]

cluster_type

(experimental) Settings for the individual instances that are launched.

Default

{@link ClusterType.MULTI_NODE}

Stability

experimental

Return type

Optional[ClusterType]

default_database_name

(experimental) Name of a database which is automatically created inside the cluster.

Default
  • default_db

Stability

experimental

Return type

Optional[str]

encrypted

(experimental) Whether to enable encryption of data at rest in the cluster.

Default

true

Stability

experimental

Return type

Optional[bool]

encryption_key

(experimental) The KMS key to use for encryption of data at rest.

Default
  • AWS-managed key, if encryption at rest is enabled

Stability

experimental

Return type

Optional[IKey]

logging_bucket

(experimental) Bucket to send logs to.

Logging information includes queries and connection attempts, for the specified Amazon Redshift cluster.

Default
  • No Logs

Stability

experimental

Return type

Optional[IBucket]

logging_key_prefix

(experimental) Prefix used for logging.

Default
  • no prefix

Stability

experimental

Return type

Optional[str]

master_user

(experimental) Username and password for the administrative user.

Stability

experimental

Return type

Login

node_type

(experimental) The node type to be provisioned for the cluster.

Default

{@link NodeType.DC2_LARGE}

Stability

experimental

Return type

Optional[NodeType]

number_of_nodes

(experimental) Number of compute nodes in the cluster. Only specify this property for multi-node clusters.

Value must be at least 2 and no more than 100.

Default
  • 2 if clusterType is ClusterType.MULTI_NODE, undefined otherwise

Stability

experimental

Return type

Union[int, float, None]

parameter_group

//docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.

Default
  • No parameter group.

Stability

experimental

Type

(experimental) Additional parameters to pass to the database engine https

Return type

Optional[IClusterParameterGroup]

port

(experimental) What port to listen on.

Default
  • The default for the engine is used.

Stability

experimental

Return type

Union[int, float, None]

preferred_maintenance_window

mi-ddd:hh24:mi (24H Clock UTC).

Example: ‘Sun:23:45-Mon:00:15’

Default

  • 30-minute window selected at random from an 8-hour block of time for

each AWS Region, occurring on a random day of the week.

See

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

Stability

experimental

Type

(experimental) A preferred maintenance window day/time range. Should be specified as a range ddd

Type

hh24

Return type

Optional[str]

publicly_accessible

(experimental) Whether to make cluster publicly accessible.

Default

false

Stability

experimental

Return type

Optional[bool]

removal_policy

(experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.

Default

RemovalPolicy.RETAIN

Stability

experimental

Return type

Optional[RemovalPolicy]

roles

(experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.

Specify a maximum of 10 roles.

Default
  • No role is attached to the cluster.

Stability

experimental

Return type

Optional[List[IRole]]

security_groups

(experimental) Security group.

Default
  • a new security group is created.

Stability

experimental

Return type

Optional[List[ISecurityGroup]]

subnet_group

(experimental) A cluster subnet group to use with this cluster.

Default
  • a new subnet group will be created.

Stability

experimental

Return type

Optional[IClusterSubnetGroup]

vpc

(experimental) The VPC to place the cluster in.

Stability

experimental

Return type

IVpc

vpc_subnets

(experimental) Where to place the instances within the VPC.

Default
  • private subnets

Stability

experimental

Return type

Optional[SubnetSelection]