CfnClusterProps

class aws_cdk.aws_redshift.CfnClusterProps(*, cluster_type, db_name, master_username, 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, endpoint=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, manage_master_password=None, manual_snapshot_retention_period=None, master_password_secret_kms_key_id=None, master_user_password=None, multi_az=None, namespace_resource_policy=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: object

Properties for defining a CfnCluster.

Parameters:
  • 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 or hyphens. The user name can’t be PUBLIC . - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. - The first character must be a letter. - Must not contain a colon (:) or a slash (/). - Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

  • 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: dc2.large | dc2.8xlarge | ra3.large | 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]) – This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

  • 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]) – A Boolean indicating whether to enable the deferred maintenance window.

  • defer_maintenance_duration (Union[int, float, None]) – An integer indicating the duration of the maintenance window in days. If you specify a duration, you can’t specify an end time. The duration must be 45 days or less.

  • defer_maintenance_end_time (Optional[str]) – A timestamp for the end of the time period when we defer maintenance.

  • defer_maintenance_start_time (Optional[str]) – A timestamp indicating the start time for the deferred maintenance window.

  • 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. Don’t specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. 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

  • endpoint (Union[IResolvable, EndpointProperty, Dict[str, Any], None]) – The connection endpoint.

  • 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, Dict[str, Any], 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.

  • manage_master_password (Union[bool, IResolvable, None]) – If true , Amazon Redshift uses AWS Secrets Manager to manage this cluster’s admin credentials. You can’t use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account’s password.

  • 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.

  • master_password_secret_kms_key_id (Optional[str]) – The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster’s admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

  • master_user_password (Optional[str]) – The password associated with the admin user account for the cluster that is being created. You can’t use MasterUserPassword if ManageMasterPassword is true . 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 @ .

  • multi_az (Union[bool, IResolvable, None]) – A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. The default is false.

  • namespace_resource_policy (Any) – The policy that is attached to a resource.

  • 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: - For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215 . (If you have an existing cluster with ra3 nodes, it isn’t required that you change the port to these ranges.) - For clusters with dc2 nodes - Select a port within the range 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]) – The Amazon Redshift operation to be performed. Supported operations are pause-cluster , resume-cluster , and failover-primary-compute .

  • revision_target (Optional[str]) – Describes a RevisionTarget object.

  • rotate_encryption_key (Union[bool, IResolvable, None]) – Rotates the encryption keys for a cluster.

  • snapshot_cluster_identifier (Optional[str]) – The name of the cluster the source snapshot was created from. This parameter is required if your user or role 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. You must specify this parameter or snapshotArn , but not both. Example: my-snapshot-id

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

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.
from aws_cdk import aws_redshift as redshift

# namespace_resource_policy: Any

cfn_cluster_props = redshift.CfnClusterProps(
    cluster_type="clusterType",
    db_name="dbName",
    master_username="masterUsername",
    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,
    endpoint=redshift.CfnCluster.EndpointProperty(
        address="address",
        port="port"
    ),
    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",
        log_destination_type="logDestinationType",
        log_exports=["logExports"],
        s3_key_prefix="s3KeyPrefix"
    ),
    maintenance_track_name="maintenanceTrackName",
    manage_master_password=False,
    manual_snapshot_retention_period=123,
    master_password_secret_kms_key_id="masterPasswordSecretKmsKeyId",
    master_user_password="masterUserPassword",
    multi_az=False,
    namespace_resource_policy=namespace_resource_policy,
    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"]
)

Attributes

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-allowversionupgrade

aqua_configuration_status

This parameter is retired.

It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-aquaconfigurationstatus

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-automatedsnapshotretentionperiod

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone

availability_zone_relocation

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocation

availability_zone_relocation_status

Describes the status of the Availability Zone relocation operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocationstatus

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-classic

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname

cluster_security_groups

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

Default: The default cluster security group for Amazon Redshift.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups

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).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersubnetgroupname

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

See:

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterversion

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.

See:

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

defer_maintenance

A Boolean indicating whether to enable the deferred maintenance window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenance

defer_maintenance_duration

An integer indicating the duration of the maintenance window in days.

If you specify a duration, you can’t specify an end time. The duration must be 45 days or less.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceduration

defer_maintenance_end_time

A timestamp for the end of the time period when we defer maintenance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceendtime

defer_maintenance_start_time

A timestamp indicating the start time for the deferred maintenance window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenancestarttime

destination_region

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-destinationregion

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. Don’t specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-elasticip

encrypted

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

Default: false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted

endpoint

The connection endpoint.

See:

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-enhancedvpcrouting

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertificateidentifier

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmconfigurationidentifier

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid

logging_properties

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

See:

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

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-maintenancetrackname

manage_master_password

If true , Amazon Redshift uses AWS Secrets Manager to manage this cluster’s admin credentials.

You can’t use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account’s password.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-managemasterpassword

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-manualsnapshotretentionperiod

master_password_secret_kms_key_id

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster’s admin credentials secret.

You can only use this parameter if ManageMasterPassword is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterpasswordsecretkmskeyid

master_user_password

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

You can’t use MasterUserPassword if ManageMasterPassword is true .

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 @ .

See:

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

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 or hyphens. The user name can’t be PUBLIC .

  • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • The first character must be a letter.

  • Must not contain a colon (:) or a slash (/).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

See:

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

multi_az

A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.

The default is false.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-multiaz

namespace_resource_policy

The policy that is attached to a resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-namespaceresourcepolicy

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 .

Valid Values: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

See:

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

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-numberofnodes

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-owneraccount

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:

  • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215 . (If you have an existing cluster with ra3 nodes, it isn’t required that you change the port to these ranges.)

  • For clusters with dc2 nodes - Select a port within the range 1150-65535 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-preferredmaintenancewindow

publicly_accessible

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible

resource_action

The Amazon Redshift operation to be performed.

Supported operations are pause-cluster , resume-cluster , and failover-primary-compute .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-resourceaction

revision_target

Describes a RevisionTarget object.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-revisiontarget

rotate_encryption_key

Rotates the encryption keys for a cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-rotateencryptionkey

snapshot_cluster_identifier

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotclusteridentifier

snapshot_copy_grant_name

The name of the snapshot copy grant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopygrantname

snapshot_copy_manual

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopymanual

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopyretentionperiod

snapshot_identifier

The name of the snapshot from which to create the new cluster.

This parameter isn’t case sensitive. You must specify this parameter or snapshotArn , but not both.

Example: my-snapshot-id

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotidentifier

tags

A list of tag instances.

See:

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

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids