1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. redshift
  5. Cluster
aws-native logo
AWS Native v0.54.0, Mar 21 23

aws-native.redshift.Cluster

An example resource schema demonstrating some basic constructs and validation rules.

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            allow_version_upgrade: Optional[bool] = None,
            aqua_configuration_status: Optional[str] = None,
            automated_snapshot_retention_period: Optional[int] = None,
            availability_zone: Optional[str] = None,
            availability_zone_relocation: Optional[bool] = None,
            availability_zone_relocation_status: Optional[str] = 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,
            cluster_type: Optional[str] = None,
            cluster_version: Optional[str] = None,
            d_b_name: Optional[str] = None,
            defer_maintenance: Optional[bool] = 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,
            kms_key_id: Optional[str] = None,
            logging_properties: Optional[ClusterLoggingPropertiesArgs] = None,
            maintenance_track_name: Optional[str] = None,
            manual_snapshot_retention_period: Optional[int] = None,
            master_user_password: Optional[str] = None,
            master_username: Optional[str] = None,
            node_type: 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[ClusterTagArgs]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = 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.
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

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.

MasterUserPassword string

The password associated with the master user account for the cluster that is being created. 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.

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

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

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.ClusterEndpointArgs
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.ClusterLoggingPropertiesArgs
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.

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.

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
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 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.Redshift.Inputs.ClusterTagArgs>

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

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.

MasterUserPassword string

The password associated with the master user account for the cluster that is being created. 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.

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

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

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 []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 ClusterEndpointArgs
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 []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 ClusterLoggingPropertiesArgs
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.

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.

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
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 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 []ClusterTagArgs

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

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.

masterUserPassword String

The password associated with the master user account for the cluster that is being created. 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.

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

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

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

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

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 Boolean

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

endpoint ClusterEndpointArgs
enhancedVpcRouting Boolean

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

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.

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

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 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<ClusterTagArgs>

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

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.

masterUserPassword string

The password associated with the master user account for the cluster that is being created. 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.

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

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

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

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

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 boolean

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

endpoint ClusterEndpointArgs
enhancedVpcRouting boolean

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

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.

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

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 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 ClusterTagArgs[]

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

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

master_user_password str

The password associated with the master user account for the cluster that is being created. 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.

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

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

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

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

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

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

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
enhanced_vpc_routing 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

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]

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

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
maintenance_track_name str

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.

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.

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

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

snapshot_copy_grant_name 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[ClusterTagArgs]

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

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.

masterUserPassword String

The password associated with the master user account for the cluster that is being created. 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.

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

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

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

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

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 Boolean

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

endpoint Property Map
enhancedVpcRouting Boolean

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 Property Map
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.

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.

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

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 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:

DeferMaintenanceIdentifier string

A unique identifier for the deferred maintenance window.

Id string

The provider-assigned unique ID for this managed resource.

DeferMaintenanceIdentifier string

A unique identifier for the deferred maintenance window.

Id string

The provider-assigned unique ID for this managed resource.

deferMaintenanceIdentifier String

A unique identifier for the deferred maintenance window.

id String

The provider-assigned unique ID for this managed resource.

deferMaintenanceIdentifier string

A unique identifier for the deferred maintenance window.

id string

The provider-assigned unique ID for this managed resource.

defer_maintenance_identifier str

A unique identifier for the deferred maintenance window.

id str

The provider-assigned unique ID for this managed resource.

deferMaintenanceIdentifier String

A unique identifier for the deferred maintenance window.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

ClusterEndpoint

Address string
Port string
Address string
Port string
address String
port String
address string
port string
address str
port str
address String
port String

ClusterLoggingProperties

BucketName string
S3KeyPrefix string
BucketName string
S3KeyPrefix string
bucketName String
s3KeyPrefix String
bucketName string
s3KeyPrefix string
bucketName String
s3KeyPrefix String

ClusterTag

Key string

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0