CfnCluster¶

class aws_cdk.aws_redshift.CfnCluster(scope, id, *, cluster_type, db_name, master_username, master_user_password, node_type, allow_version_upgrade=None, aqua_configuration_status=None, automated_snapshot_retention_period=None, availability_zone=None, availability_zone_relocation=None, availability_zone_relocation_status=None, classic=None, cluster_identifier=None, cluster_parameter_group_name=None, cluster_security_groups=None, cluster_subnet_group_name=None, cluster_version=None, defer_maintenance=None, defer_maintenance_duration=None, defer_maintenance_end_time=None, defer_maintenance_start_time=None, destination_region=None, elastic_ip=None, encrypted=None, enhanced_vpc_routing=None, hsm_client_certificate_identifier=None, hsm_configuration_identifier=None, iam_roles=None, kms_key_id=None, logging_properties=None, maintenance_track_name=None, manual_snapshot_retention_period=None, number_of_nodes=None, owner_account=None, port=None, preferred_maintenance_window=None, publicly_accessible=None, resource_action=None, revision_target=None, rotate_encryption_key=None, snapshot_cluster_identifier=None, snapshot_copy_grant_name=None, snapshot_copy_manual=None, snapshot_copy_retention_period=None, snapshot_identifier=None, tags=None, vpc_security_group_ids=None)¶

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Redshift::Cluster.

Specifies a cluster. A cluster is a fully managed data warehouse that consists of a set of compute nodes.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .

CloudformationResource: AWS::Redshift::Cluster
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html
ExampleMetadata: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

cfn_cluster = redshift.CfnCluster(self, "MyCfnCluster",
    cluster_type="clusterType",
    db_name="dbName",
    master_username="masterUsername",
    master_user_password="masterUserPassword",
    node_type="nodeType",

    # the properties below are optional
    allow_version_upgrade=False,
    aqua_configuration_status="aquaConfigurationStatus",
    automated_snapshot_retention_period=123,
    availability_zone="availabilityZone",
    availability_zone_relocation=False,
    availability_zone_relocation_status="availabilityZoneRelocationStatus",
    classic=False,
    cluster_identifier="clusterIdentifier",
    cluster_parameter_group_name="clusterParameterGroupName",
    cluster_security_groups=["clusterSecurityGroups"],
    cluster_subnet_group_name="clusterSubnetGroupName",
    cluster_version="clusterVersion",
    defer_maintenance=False,
    defer_maintenance_duration=123,
    defer_maintenance_end_time="deferMaintenanceEndTime",
    defer_maintenance_start_time="deferMaintenanceStartTime",
    destination_region="destinationRegion",
    elastic_ip="elasticIp",
    encrypted=False,
    enhanced_vpc_routing=False,
    hsm_client_certificate_identifier="hsmClientCertificateIdentifier",
    hsm_configuration_identifier="hsmConfigurationIdentifier",
    iam_roles=["iamRoles"],
    kms_key_id="kmsKeyId",
    logging_properties=redshift.CfnCluster.LoggingPropertiesProperty(
        bucket_name="bucketName",

        # the properties below are optional
        s3_key_prefix="s3KeyPrefix"
    ),
    maintenance_track_name="maintenanceTrackName",
    manual_snapshot_retention_period=123,
    number_of_nodes=123,
    owner_account="ownerAccount",
    port=123,
    preferred_maintenance_window="preferredMaintenanceWindow",
    publicly_accessible=False,
    resource_action="resourceAction",
    revision_target="revisionTarget",
    rotate_encryption_key=False,
    snapshot_cluster_identifier="snapshotClusterIdentifier",
    snapshot_copy_grant_name="snapshotCopyGrantName",
    snapshot_copy_manual=False,
    snapshot_copy_retention_period=123,
    snapshot_identifier="snapshotIdentifier",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Create a new AWS::Redshift::Cluster.

Parameters

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
cluster_type (str) – The type of the cluster. When cluster type is specified as. - single-node , the NumberOfNodes parameter is not required. - multi-node , the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node
db_name (str) – The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: - Must contain 1 to 64 alphanumeric characters. - Must contain only lowercase letters. - Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
master_username (str) –
The user name associated with the admin user account for the cluster that is being created. Constraints: - Must be 1 - 128 alphanumeric characters. The user name can’t be PUBLIC . - First character must be a letter. - Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
master_user_password (str) – The password associated with the admin user account for the cluster that is being created. Constraints: - Must be between 8 and 64 characters in length. - Must contain at least one uppercase letter. - Must contain at least one lowercase letter. - Must contain one number. - Can be any printable ASCII character (ASCII code 33-126) except ‘ (single quote), ” (double quote), , /, or @.
node_type (str) – The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide . Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
allow_version_upgrade (Union[bool, IResolvable, None]) – If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true
aqua_configuration_status (Optional[str]) – The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following. - enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type. - disabled - Don’t use AQUA. - auto - Amazon Redshift determines whether to use AQUA.
automated_snapshot_retention_period (Union[int, float, None]) – The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot in the Amazon Redshift API Reference . Default: 1 Constraints: Must be a value from 0 to 35.
availability_zone (Optional[str]) – The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: us-east-2d Constraint: The specified Availability Zone must be in the same region as the current endpoint.
availability_zone_relocation (Union[bool, IResolvable, None]) – The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
availability_zone_relocation_status (Optional[str]) – Describes the status of the Availability Zone relocation operation.
classic (Union[bool, IResolvable, None]) – A boolean value indicating whether the resize operation is using the classic resize process. If you don’t provide this parameter or set the value to false , the resize type is elastic.
cluster_identifier (Optional[str]) – A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account . Example: myexamplecluster
cluster_parameter_group_name (Optional[str]) – The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: - Must be 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens.
cluster_security_groups (Optional[Sequence[str]]) – A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.
cluster_subnet_group_name (Optional[str]) – The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
cluster_version (Optional[str]) – The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: 1.0
defer_maintenance (Union[bool, IResolvable, None]) – AWS::Redshift::Cluster.DeferMaintenance.
defer_maintenance_duration (Union[int, float, None]) – AWS::Redshift::Cluster.DeferMaintenanceDuration.
defer_maintenance_end_time (Optional[str]) – AWS::Redshift::Cluster.DeferMaintenanceEndTime.
defer_maintenance_start_time (Optional[str]) – AWS::Redshift::Cluster.DeferMaintenanceStartTime.
destination_region (Optional[str]) – The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
elastic_ip (Optional[str]) – The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
encrypted (Union[bool, IResolvable, None]) – If true , the data in the cluster is encrypted at rest. Default: false
enhanced_vpc_routing (Union[bool, IResolvable, None]) – An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true , enhanced VPC routing is enabled. Default: false
hsm_client_certificate_identifier (Optional[str]) – Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
hsm_configuration_identifier (Optional[str]) – Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
iam_roles (Optional[Sequence[str]]) – A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
kms_key_id (Optional[str]) – The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
logging_properties (Union[IResolvable, LoggingPropertiesProperty, None]) – Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
maintenance_track_name (Optional[str]) – An optional parameter for the name of the maintenance track for the cluster. If you don’t provide a maintenance track name, the cluster is assigned to the current track.
manual_snapshot_retention_period (Union[int, float, None]) – The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn’t change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
number_of_nodes (Union[int, float, None]) –
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node . For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide . If you don’t specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than 100.
owner_account (Optional[str]) – The AWS account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
port (Union[int, float, None]) – The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: 1150-65535
preferred_maintenance_window (Optional[str]) – The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
publicly_accessible (Union[bool, IResolvable, None]) – If true , the cluster can be accessed from a public network.
resource_action (Optional[str]) – AWS::Redshift::Cluster.ResourceAction.
revision_target (Optional[str]) – AWS::Redshift::Cluster.RevisionTarget.
rotate_encryption_key (Union[bool, IResolvable, None]) – AWS::Redshift::Cluster.RotateEncryptionKey.
snapshot_cluster_identifier (Optional[str]) – The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
snapshot_copy_grant_name (Optional[str]) – The name of the snapshot copy grant.
snapshot_copy_manual (Union[bool, IResolvable, None]) – Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
snapshot_copy_retention_period (Union[int, float, None]) – The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . By default, this only changes the retention period of copied automated snapshots. If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35 for automated snapshots. If you specify the manual option, only newly copied manual snapshots will have the new retention period. If you specify the value of -1 newly copied manual snapshots are retained indefinitely. Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
snapshot_identifier (Optional[str]) – The name of the snapshot from which to create the new cluster. This parameter isn’t case sensitive. Example: my-snapshot-id
tags (Optional[Sequence[CfnTag]]) – A list of tag instances.
vpc_security_group_ids (Optional[Sequence[str]]) – A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster.

Methods

add_deletion_override(path)¶

Syntactic sugar for addOverride(path, undefined).

Parameters: path (str) – The path of the value to delete.
Return type: None

add_depends_on(target)¶

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)¶

Add a value to the CloudFormation Resource Metadata.

Parameters

key (str) –
value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type: None

add_override(path, value)¶

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)¶

Adds an override that deletes the value of a property from the resource definition.

Parameters: property_path (str) – The path to the property.
Return type: None

add_property_override(property_path, value)¶

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters

property_path (str) – The path of the property.
value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)¶

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)¶

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters: attribute_name (str) – The name of the attribute.
Return type: Reference

get_metadata(key)¶

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type: Any

inspect(inspector)¶

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)¶

Overrides the auto-generated logical ID with a specific ID.

Parameters: new_logical_id (str) – The new logical ID to use for this stack element.
Return type: None

to_string()¶

Returns a string representation of this construct.

Return type: str
Returns: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Redshift::Cluster'¶

allow_version_upgrade¶

If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-allowversionupgrade
Return type: Union[bool, IResolvable, None]

aqua_configuration_status¶

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.

Possible values include the following.

enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.
disabled - Don’t use AQUA.
auto - Amazon Redshift determines whether to use AQUA.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-aquaconfigurationstatus
Return type: Optional[str]

attr_defer_maintenance_identifier¶

DeferMaintenanceIdentifier

Type: cloudformationAttribute
Return type: str

attr_endpoint_address¶

The connection endpoint for the Amazon Redshift cluster.

For example: examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com .

CloudformationAttribute: Endpoint.Address
Return type: str

attr_endpoint_port¶

The port number on which the Amazon Redshift cluster accepts connections.

For example: 5439 .

CloudformationAttribute: Endpoint.Port
Return type: str

attr_id¶

A unique identifier for the cluster.

You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Example: myexamplecluster

CloudformationAttribute: Id
Return type: str

automated_snapshot_retention_period¶

The number of days that automated snapshots are retained.

If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot in the Amazon Redshift API Reference .

Default: 1

Constraints: Must be a value from 0 to 35.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-automatedsnapshotretentionperiod
Return type: Union[int, float, None]

availability_zone¶

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.

For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone
Return type: Optional[str]

availability_zone_relocation¶

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocation
Return type: Union[bool, IResolvable, None]

availability_zone_relocation_status¶

Describes the status of the Availability Zone relocation operation.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocationstatus
Return type: Optional[str]

cfn_options¶

Options for this resource, such as condition, update policy etc.

Return type: ICfnResourceOptions

cfn_resource_type¶

AWS resource type.

Return type: str

classic¶

A boolean value indicating whether the resize operation is using the classic resize process.

If you don’t provide this parameter or set the value to false , the resize type is elastic.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-classic
Return type: Union[bool, IResolvable, None]

cluster_identifier¶

A unique identifier for the cluster.

You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account .

Example: myexamplecluster

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier
Return type: Optional[str]

cluster_parameter_group_name¶

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname
Return type: Optional[str]

cluster_security_groups¶

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups
Return type: Optional[List[str]]

cluster_subnet_group_name¶

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersubnetgroupname
Return type: Optional[str]

cluster_type¶

The type of the cluster. When cluster type is specified as.

single-node , the NumberOfNodes parameter is not required.
multi-node , the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustertype
Return type: str

cluster_version¶

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterversion
Return type: Optional[str]

creation_stack¶

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type: List[str]

db_name¶

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

Must contain 1 to 64 alphanumeric characters.
Must contain only lowercase letters.
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-dbname
Return type: str

defer_maintenance¶

AWS::Redshift::Cluster.DeferMaintenance.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenance
Return type: Union[bool, IResolvable, None]

defer_maintenance_duration¶

AWS::Redshift::Cluster.DeferMaintenanceDuration.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceduration
Return type: Union[int, float, None]

defer_maintenance_end_time¶

AWS::Redshift::Cluster.DeferMaintenanceEndTime.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceendtime
Return type: Optional[str]

defer_maintenance_start_time¶

AWS::Redshift::Cluster.DeferMaintenanceStartTime.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenancestarttime
Return type: Optional[str]

destination_region¶

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-destinationregion
Return type: Optional[str]

elastic_ip¶

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-elasticip
Return type: Optional[str]

encrypted¶

If true , the data in the cluster is encrypted at rest.

Default: false

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted
Return type: Union[bool, IResolvable, None]

enhanced_vpc_routing¶

An option that specifies whether to create the cluster with enhanced VPC routing enabled.

To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true , enhanced VPC routing is enabled.

Default: false

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-enhancedvpcrouting
Return type: Union[bool, IResolvable, None]

hsm_client_certificate_identifier¶

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertificateidentifier
Return type: Optional[str]

hsm_configuration_identifier¶

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmconfigurationidentifier
Return type: Optional[str]

iam_roles¶

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

You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles
Return type: Optional[List[str]]

kms_key_id¶

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid
Return type: Optional[str]

logging_properties¶

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties
Return type: Union[IResolvable, LoggingPropertiesProperty, None]

logical_id¶

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type: str
Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

maintenance_track_name¶

An optional parameter for the name of the maintenance track for the cluster.

If you don’t provide a maintenance track name, the cluster is assigned to the current track.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-maintenancetrackname
Return type: Optional[str]

manual_snapshot_retention_period¶

The default number of days to retain a manual snapshot.

If the value is -1, the snapshot is retained indefinitely. This setting doesn’t change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-manualsnapshotretentionperiod
Return type: Union[int, float, None]

master_user_password¶

The password associated with the admin user account for the cluster that is being created.

Constraints:

Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33-126) except ‘ (single quote), ” (double quote), , /, or @.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masteruserpassword
Return type: str

master_username¶

The user name associated with the admin user account for the cluster that is being created.

Constraints:

Must be 1 - 128 alphanumeric characters. The user name can’t be PUBLIC .
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterusername
Return type: str

node¶

The construct tree node associated with this construct.

Return type: ConstructNode

node_type¶

The node type to be provisioned for the cluster.

For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype
Return type: str

number_of_nodes¶

The number of compute nodes in the cluster.

This parameter is required when the ClusterType parameter is specified as multi-node .

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .

If you don’t specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-numberofnodes
Return type: Union[int, float, None]

owner_account¶

The AWS account used to create or copy the snapshot.

Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-owneraccount
Return type: Optional[str]

port¶

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port
Return type: Union[int, float, None]

preferred_maintenance_window¶

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-preferredmaintenancewindow
Return type: Optional[str]

publicly_accessible¶

If true , the cluster can be accessed from a public network.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible
Return type: Union[bool, IResolvable, None]

ref¶

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type: str

resource_action¶

AWS::Redshift::Cluster.ResourceAction.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-resourceaction
Return type: Optional[str]

revision_target¶

AWS::Redshift::Cluster.RevisionTarget.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-revisiontarget
Return type: Optional[str]

rotate_encryption_key¶

AWS::Redshift::Cluster.RotateEncryptionKey.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-rotateencryptionkey
Return type: Union[bool, IResolvable, None]

snapshot_cluster_identifier¶

The name of the cluster the source snapshot was created from.

This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotclusteridentifier
Return type: Optional[str]

snapshot_copy_grant_name¶

The name of the snapshot copy grant.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopygrantname
Return type: Optional[str]

snapshot_copy_manual¶

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopymanual
Return type: Union[bool, IResolvable, None]

snapshot_copy_retention_period¶

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopyretentionperiod
Return type: Union[int, float, None]

snapshot_identifier¶

The name of the snapshot from which to create the new cluster. This parameter isn’t case sensitive.

Example: my-snapshot-id

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotidentifier
Return type: Optional[str]

stack¶

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type: Stack

tags¶

A list of tag instances.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags
Return type: TagManager

vpc_security_group_ids¶

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids
Return type: Optional[List[str]]

Static Methods

classmethod is_cfn_element(x)¶

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)¶

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

EndpointProperty¶

class CfnCluster.EndpointProperty(*, address=None, port=None)¶

Bases: object

Describes a connection endpoint.

Parameters

address (Optional[str]) – The DNS address of the Cluster.
port (Optional[str]) – The port that the database engine is listening on.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

endpoint_property = redshift.CfnCluster.EndpointProperty(
    address="address",
    port="port"
)

Attributes

address¶

The DNS address of the Cluster.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-address
Return type: Optional[str]

port¶

The port that the database engine is listening on.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-port
Return type: Optional[str]

LoggingPropertiesProperty¶

class CfnCluster.LoggingPropertiesProperty(*, bucket_name, s3_key_prefix=None)¶

Bases: object

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameters

bucket_name (str) – The name of an existing S3 bucket where the log files are to be stored. Constraints: - Must be in the same region as the cluster - The cluster must have read bucket and put object permissions
s3_key_prefix (Optional[str]) – The prefix applied to the log file names. Constraints: - Cannot exceed 512 characters - Cannot contain spaces( ), double quotes (“), single quotes (‘), a backslash (), or control characters. The hexadecimal codes for invalid characters are: - x00 to x20 - x22 - x27 - x5c - x7f or larger

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

logging_properties_property = redshift.CfnCluster.LoggingPropertiesProperty(
    bucket_name="bucketName",

    # the properties below are optional
    s3_key_prefix="s3KeyPrefix"
)

Attributes

bucket_name¶

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

Must be in the same region as the cluster
The cluster must have read bucket and put object permissions

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-bucketname
Return type: str

s3_key_prefix¶

The prefix applied to the log file names.

Constraints:

Cannot exceed 512 characters
Cannot contain spaces( ), double quotes (“), single quotes (‘), a backslash (), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-s3keyprefix
Return type: Optional[str]