AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.redshift.Cluster

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

Create Cluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

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

@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_type: Optional[str] = None,
            node_type: Optional[str] = None,
            master_username: Optional[str] = None,
            db_name: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            defer_maintenance: Optional[bool] = None,
            classic: Optional[bool] = None,
            cluster_identifier: Optional[str] = None,
            cluster_parameter_group_name: Optional[str] = None,
            cluster_security_groups: Optional[Sequence[str]] = None,
            cluster_subnet_group_name: Optional[str] = None,
            availability_zone_relocation: Optional[bool] = None,
            cluster_version: Optional[str] = None,
            maintenance_track_name: Optional[str] = None,
            logging_properties: Optional[ClusterLoggingPropertiesArgs] = None,
            defer_maintenance_duration: Optional[int] = None,
            defer_maintenance_end_time: Optional[str] = None,
            defer_maintenance_start_time: Optional[str] = None,
            destination_region: Optional[str] = None,
            elastic_ip: Optional[str] = None,
            encrypted: Optional[bool] = None,
            endpoint: Optional[ClusterEndpointArgs] = None,
            enhanced_vpc_routing: Optional[bool] = None,
            hsm_client_certificate_identifier: Optional[str] = None,
            hsm_configuration_identifier: Optional[str] = None,
            iam_roles: Optional[Sequence[str]] = None,
            availability_zone_relocation_status: Optional[str] = None,
            allow_version_upgrade: Optional[bool] = None,
            availability_zone: Optional[str] = None,
            manage_master_password: Optional[bool] = None,
            manual_snapshot_retention_period: Optional[int] = None,
            master_password_secret_kms_key_id: Optional[str] = None,
            master_user_password: Optional[str] = None,
            automated_snapshot_retention_period: Optional[int] = None,
            multi_az: Optional[bool] = None,
            namespace_resource_policy: Optional[Any] = None,
            aqua_configuration_status: Optional[str] = None,
            number_of_nodes: Optional[int] = None,
            owner_account: Optional[str] = None,
            port: Optional[int] = None,
            preferred_maintenance_window: Optional[str] = None,
            publicly_accessible: Optional[bool] = None,
            resource_action: Optional[str] = None,
            revision_target: Optional[str] = None,
            rotate_encryption_key: Optional[bool] = None,
            snapshot_cluster_identifier: Optional[str] = None,
            snapshot_copy_grant_name: Optional[str] = None,
            snapshot_copy_manual: Optional[bool] = None,
            snapshot_copy_retention_period: Optional[int] = None,
            snapshot_identifier: Optional[str] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = None)

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

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

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

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

Parameters

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

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

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

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

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

Cluster Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Cluster resource accepts the following input properties:

ClusterType string

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

DbName string

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.

MasterUsername string

The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.

NodeType string

AllowVersionUpgrade bool

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

AquaConfigurationStatus string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

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

AutomatedSnapshotRetentionPeriod int

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

AvailabilityZone string

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

AvailabilityZoneRelocation bool

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

AvailabilityZoneRelocationStatus string

The availability zone relocation status of the cluster

Classic bool

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.

ClusterIdentifier string

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. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

ClusterParameterGroupName string

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

ClusterSecurityGroups List<string>

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

ClusterSubnetGroupName string

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

ClusterVersion string

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.

DeferMaintenance bool

A boolean indicating whether to enable the deferred maintenance window.

DeferMaintenanceDuration int

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.

DeferMaintenanceEndTime string

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

DeferMaintenanceStartTime string

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

DestinationRegion string

The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference

ElasticIp string

The Elastic IP (EIP) address for the cluster.

Encrypted bool

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

Endpoint Pulumi.AwsNative.Redshift.Inputs.ClusterEndpoint

The connection endpoint.

EnhancedVpcRouting bool

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

HsmClientCertificateIdentifier string

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

HsmConfigurationIdentifier string

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.

IamRoles List<string>

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. You can supply up to 50 IAM roles in a single request

KmsKeyId string

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

LoggingProperties Pulumi.AwsNative.Redshift.Inputs.ClusterLoggingProperties

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

MaintenanceTrackName string

The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

ManageMasterPassword bool

A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. 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.

ManualSnapshotRetentionPeriod int

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

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

MasterPasswordSecretKmsKeyId string

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

MasterUserPassword string

The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.

MultiAz bool

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

NamespaceResourcePolicy object

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

NumberOfNodes int

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

OwnerAccount string

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 int

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

PreferredMaintenanceWindow string

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

PubliclyAccessible bool

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

ResourceAction string

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

RevisionTarget string

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

RotateEncryptionKey bool

A boolean indicating if we want to rotate Encryption Keys.

SnapshotClusterIdentifier string

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.

SnapshotCopyGrantName string

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

SnapshotCopyManual bool

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

SnapshotCopyRetentionPeriod int

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

Default is 7.

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

SnapshotIdentifier string

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

Tags List<Pulumi.AwsNative.Inputs.Tag>

The list of tags for the cluster parameter group.

VpcSecurityGroupIds List<string>

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

ClusterType string

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

DbName string

MasterUsername string

The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.

NodeType string

AllowVersionUpgrade bool

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

AquaConfigurationStatus string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

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

AutomatedSnapshotRetentionPeriod int

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

AvailabilityZone string

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

AvailabilityZoneRelocation bool

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

AvailabilityZoneRelocationStatus string

The availability zone relocation status of the cluster

Classic bool

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.

ClusterIdentifier string

ClusterParameterGroupName string

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

ClusterSecurityGroups []string

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

ClusterSubnetGroupName string

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

ClusterVersion string

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.

DeferMaintenance bool

A boolean indicating whether to enable the deferred maintenance window.

DeferMaintenanceDuration int

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.

DeferMaintenanceEndTime string

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

DeferMaintenanceStartTime string

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

DestinationRegion string

ElasticIp string

The Elastic IP (EIP) address for the cluster.

Encrypted bool

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

Endpoint ClusterEndpointArgs

The connection endpoint.

EnhancedVpcRouting bool

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

Default: false

HsmClientCertificateIdentifier string

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

HsmConfigurationIdentifier string

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.

IamRoles []string

KmsKeyId string

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

LoggingProperties ClusterLoggingPropertiesArgs

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

MaintenanceTrackName string

ManageMasterPassword bool

ManualSnapshotRetentionPeriod int

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

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

MasterPasswordSecretKmsKeyId string

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

MasterUserPassword string

MultiAz bool

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

NamespaceResourcePolicy interface{}

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

NumberOfNodes int

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

OwnerAccount string

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 int

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

PreferredMaintenanceWindow string

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

PubliclyAccessible bool

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

ResourceAction string

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

RevisionTarget string

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

RotateEncryptionKey bool

A boolean indicating if we want to rotate Encryption Keys.

SnapshotClusterIdentifier string

SnapshotCopyGrantName string

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

SnapshotCopyManual bool

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

SnapshotCopyRetentionPeriod int

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

Default is 7.

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

SnapshotIdentifier string

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

Tags TagArgs

The list of tags for the cluster parameter group.

VpcSecurityGroupIds []string

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

clusterType String

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

dbName String

masterUsername String

The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.

nodeType String

allowVersionUpgrade Boolean

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aquaConfigurationStatus String

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

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

automatedSnapshotRetentionPeriod Integer

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availabilityZone String

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availabilityZoneRelocation Boolean

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

availabilityZoneRelocationStatus String

The availability zone relocation status of the cluster

classic Boolean

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.

clusterIdentifier String

clusterParameterGroupName String

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

clusterSecurityGroups List<String>

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

clusterSubnetGroupName String

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

clusterVersion String

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.

deferMaintenance Boolean

A boolean indicating whether to enable the deferred maintenance window.

deferMaintenanceDuration Integer

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.

deferMaintenanceEndTime String

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

deferMaintenanceStartTime String

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

destinationRegion String

elasticIp String

The Elastic IP (EIP) address for the cluster.

encrypted Boolean

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

endpoint ClusterEndpoint

The connection endpoint.

enhancedVpcRouting Boolean

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

Default: false

hsmClientCertificateIdentifier String

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

hsmConfigurationIdentifier String

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.

iamRoles List<String>

kmsKeyId String

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

loggingProperties ClusterLoggingProperties

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

maintenanceTrackName String

manageMasterPassword Boolean

manualSnapshotRetentionPeriod Integer

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

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

masterPasswordSecretKmsKeyId String

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

masterUserPassword String

multiAz Boolean

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespaceResourcePolicy Object

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

numberOfNodes Integer

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

ownerAccount String

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 Integer

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferredMaintenanceWindow String

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

publiclyAccessible Boolean

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

resourceAction String

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revisionTarget String

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotateEncryptionKey Boolean

A boolean indicating if we want to rotate Encryption Keys.

snapshotClusterIdentifier String

snapshotCopyGrantName String

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshotCopyManual Boolean

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

snapshotCopyRetentionPeriod Integer

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

Default is 7.

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

snapshotIdentifier String

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

tags List<Tag>

The list of tags for the cluster parameter group.

vpcSecurityGroupIds List<String>

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

clusterType string

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

dbName string

masterUsername string

The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.

nodeType string

allowVersionUpgrade boolean

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aquaConfigurationStatus string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

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

automatedSnapshotRetentionPeriod number

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availabilityZone string

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availabilityZoneRelocation boolean

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

availabilityZoneRelocationStatus string

The availability zone relocation status of the cluster

classic boolean

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.

clusterIdentifier string

clusterParameterGroupName string

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

clusterSecurityGroups string[]

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

clusterSubnetGroupName string

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

clusterVersion string

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.

deferMaintenance boolean

A boolean indicating whether to enable the deferred maintenance window.

deferMaintenanceDuration number

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.

deferMaintenanceEndTime string

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

deferMaintenanceStartTime string

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

destinationRegion string

elasticIp string

The Elastic IP (EIP) address for the cluster.

encrypted boolean

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

endpoint ClusterEndpoint

The connection endpoint.

enhancedVpcRouting boolean

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

Default: false

hsmClientCertificateIdentifier string

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

hsmConfigurationIdentifier string

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.

iamRoles string[]

kmsKeyId string

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

loggingProperties ClusterLoggingProperties

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

maintenanceTrackName string

manageMasterPassword boolean

manualSnapshotRetentionPeriod number

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

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

masterPasswordSecretKmsKeyId string

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

masterUserPassword string

multiAz boolean

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespaceResourcePolicy any

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

numberOfNodes number

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

ownerAccount string

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 number

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferredMaintenanceWindow string

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

publiclyAccessible boolean

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

resourceAction string

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revisionTarget string

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotateEncryptionKey boolean

A boolean indicating if we want to rotate Encryption Keys.

snapshotClusterIdentifier string

snapshotCopyGrantName string

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshotCopyManual boolean

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

snapshotCopyRetentionPeriod number

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

Default is 7.

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

snapshotIdentifier string

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

tags Tag[]

The list of tags for the cluster parameter group.

vpcSecurityGroupIds string[]

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

cluster_type str

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

db_name str

master_username str

The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.

node_type str

allow_version_upgrade bool

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aqua_configuration_status str

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

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

automated_snapshot_retention_period int

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availability_zone str

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availability_zone_relocation bool

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

availability_zone_relocation_status str

The availability zone relocation status of the cluster

classic bool

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 str

cluster_parameter_group_name str

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

cluster_security_groups Sequence[str]

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

cluster_subnet_group_name str

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

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

defer_maintenance bool

A boolean indicating whether to enable the deferred maintenance window.

defer_maintenance_duration int

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 str

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

defer_maintenance_start_time str

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

destination_region str

elastic_ip str

The Elastic IP (EIP) address for the cluster.

encrypted bool

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

endpoint ClusterEndpointArgs

The connection endpoint.

enhanced_vpc_routing bool

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

Default: false

hsm_client_certificate_identifier 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 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 Sequence[str]

kms_key_id 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 ClusterLoggingPropertiesArgs

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

maintenance_track_name str

manage_master_password bool

manual_snapshot_retention_period int

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

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

master_password_secret_kms_key_id str

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

master_user_password str

multi_az bool

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespace_resource_policy Any

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

number_of_nodes int

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

owner_account 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 int

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferred_maintenance_window str

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

publicly_accessible bool

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

resource_action str

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revision_target str

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotate_encryption_key bool

A boolean indicating if we want to rotate Encryption Keys.

snapshot_cluster_identifier str

snapshot_copy_grant_name str

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshot_copy_manual bool

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

snapshot_copy_retention_period int

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

Default is 7.

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

snapshot_identifier str

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

tags Sequence[TagArgs]

The list of tags for the cluster parameter group.

vpc_security_group_ids Sequence[str]

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

clusterType String

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

dbName String

masterUsername String

The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.

nodeType String

allowVersionUpgrade Boolean

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aquaConfigurationStatus String

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

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

automatedSnapshotRetentionPeriod Number

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availabilityZone String

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availabilityZoneRelocation Boolean

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

availabilityZoneRelocationStatus String

The availability zone relocation status of the cluster

classic Boolean

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.

clusterIdentifier String

clusterParameterGroupName String

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

clusterSecurityGroups List<String>

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

clusterSubnetGroupName String

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

clusterVersion String

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.

deferMaintenance Boolean

A boolean indicating whether to enable the deferred maintenance window.

deferMaintenanceDuration Number

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.

deferMaintenanceEndTime String

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

deferMaintenanceStartTime String

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

destinationRegion String

elasticIp String

The Elastic IP (EIP) address for the cluster.

encrypted Boolean

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

endpoint Property Map

The connection endpoint.

enhancedVpcRouting Boolean

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

Default: false

hsmClientCertificateIdentifier String

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

hsmConfigurationIdentifier String

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.

iamRoles List<String>

kmsKeyId String

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

loggingProperties Property Map

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

maintenanceTrackName String

manageMasterPassword Boolean

manualSnapshotRetentionPeriod Number

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

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

masterPasswordSecretKmsKeyId String

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

masterUserPassword String

multiAz Boolean

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespaceResourcePolicy Any

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

numberOfNodes Number

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

ownerAccount String

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 Number

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferredMaintenanceWindow String

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

publiclyAccessible Boolean

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

resourceAction String

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revisionTarget String

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotateEncryptionKey Boolean

A boolean indicating if we want to rotate Encryption Keys.

snapshotClusterIdentifier String

snapshotCopyGrantName String

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshotCopyManual Boolean

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

snapshotCopyRetentionPeriod Number

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

Default is 7.

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

snapshotIdentifier String

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

tags List<Property Map>

The list of tags for the cluster parameter group.

vpcSecurityGroupIds List<String>

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

Outputs

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

ClusterNamespaceArn string: The Amazon Resource Name (ARN) of the cluster namespace.
DeferMaintenanceIdentifier string: A unique identifier for the deferred maintenance window.
Id string: The provider-assigned unique ID for this managed resource.
MasterPasswordSecretArn string: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

ClusterNamespaceArn string: The Amazon Resource Name (ARN) of the cluster namespace.
DeferMaintenanceIdentifier string: A unique identifier for the deferred maintenance window.
Id string: The provider-assigned unique ID for this managed resource.
MasterPasswordSecretArn string: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

clusterNamespaceArn String: The Amazon Resource Name (ARN) of the cluster namespace.
deferMaintenanceIdentifier String: A unique identifier for the deferred maintenance window.
id String: The provider-assigned unique ID for this managed resource.
masterPasswordSecretArn String: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

clusterNamespaceArn string: The Amazon Resource Name (ARN) of the cluster namespace.
deferMaintenanceIdentifier string: A unique identifier for the deferred maintenance window.
id string: The provider-assigned unique ID for this managed resource.
masterPasswordSecretArn string: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

cluster_namespace_arn str: The Amazon Resource Name (ARN) of the cluster namespace.
defer_maintenance_identifier str: A unique identifier for the deferred maintenance window.
id str: The provider-assigned unique ID for this managed resource.
master_password_secret_arn str: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

clusterNamespaceArn String: The Amazon Resource Name (ARN) of the cluster namespace.
deferMaintenanceIdentifier String: A unique identifier for the deferred maintenance window.
id String: The provider-assigned unique ID for this managed resource.
masterPasswordSecretArn String: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Supporting Types

ClusterEndpoint, ClusterEndpointArgs

Address string: The DNS address of the cluster. This property is read only.
Port string: The port that the database engine is listening on. This property is read only.

Address string: The DNS address of the cluster. This property is read only.
Port string: The port that the database engine is listening on. This property is read only.

address String: The DNS address of the cluster. This property is read only.
port String: The port that the database engine is listening on. This property is read only.

address string: The DNS address of the cluster. This property is read only.
port string: The port that the database engine is listening on. This property is read only.

address str: The DNS address of the cluster. This property is read only.
port str: The port that the database engine is listening on. This property is read only.

address String: The DNS address of the cluster. This property is read only.
port String: The port that the database engine is listening on. This property is read only.

ClusterLoggingProperties, ClusterLoggingPropertiesArgs

BucketName string

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

LogDestinationType string

The log destination type. An enum with possible values of s3 and cloudwatch .

LogExports List<string>

The collection of exported log types. Possible values are connectionlog , useractivitylog , and userlog .

S3KeyPrefix string

The prefix applied to the log file names.

Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore ( _ ), period ( . ), colon ( : ), slash ( / ), equal ( = ), plus ( + ), backslash ( \ ), hyphen ( - ), at symbol ( @ ).

BucketName string

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

Constraints: