Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. awsconnector
  5. getRedshiftCluster
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.awsconnector.getRedshiftCluster

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a RedshiftCluster

Uses Azure REST API version 2024-12-01.

Using getRedshiftCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRedshiftCluster(args: GetRedshiftClusterArgs, opts?: InvokeOptions): Promise<GetRedshiftClusterResult>
function getRedshiftClusterOutput(args: GetRedshiftClusterOutputArgs, opts?: InvokeOptions): Output<GetRedshiftClusterResult>
Copy
def get_redshift_cluster(name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRedshiftClusterResult
def get_redshift_cluster_output(name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRedshiftClusterResult]
Copy
func LookupRedshiftCluster(ctx *Context, args *LookupRedshiftClusterArgs, opts ...InvokeOption) (*LookupRedshiftClusterResult, error)
func LookupRedshiftClusterOutput(ctx *Context, args *LookupRedshiftClusterOutputArgs, opts ...InvokeOption) LookupRedshiftClusterResultOutput
Copy

> Note: This function is named LookupRedshiftCluster in the Go SDK.

public static class GetRedshiftCluster 
{
    public static Task<GetRedshiftClusterResult> InvokeAsync(GetRedshiftClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetRedshiftClusterResult> Invoke(GetRedshiftClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRedshiftClusterResult> getRedshiftCluster(GetRedshiftClusterArgs args, InvokeOptions options)
public static Output<GetRedshiftClusterResult> getRedshiftCluster(GetRedshiftClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:awsconnector:getRedshiftCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of RedshiftCluster
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of RedshiftCluster
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of RedshiftCluster
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of RedshiftCluster
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of RedshiftCluster
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of RedshiftCluster
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getRedshiftCluster Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.AwsConnector.Outputs.RedshiftClusterPropertiesResponse
The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.AwsConnector.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties RedshiftClusterPropertiesResponse
The resource-specific properties for this resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties RedshiftClusterPropertiesResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
properties RedshiftClusterPropertiesResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
properties RedshiftClusterPropertiesResponse
The resource-specific properties for this resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
The resource-specific properties for this resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

AwsRedshiftClusterPropertiesResponse

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
ClusterNamespaceArn string
The Amazon Resource Name (ARN) of the cluster namespace.
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.
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
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.
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.
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.
DeferMaintenanceIdentifier string
A unique identifier for the deferred maintenance window.
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.AzureNative.AwsConnector.Inputs.RedshiftClusterEndpointResponse
Property 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.AzureNative.AwsConnector.Inputs.LoggingPropertiesResponse
Property loggingProperties
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.
MasterPasswordSecretArn string
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
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.
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.
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.
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
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
Property ownerAccount
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.AzureNative.AwsConnector.Inputs.TagResponse>
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.
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
ClusterNamespaceArn string
The Amazon Resource Name (ARN) of the cluster namespace.
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.
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
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.
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.
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.
DeferMaintenanceIdentifier string
A unique identifier for the deferred maintenance window.
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 RedshiftClusterEndpointResponse
Property 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 []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 LoggingPropertiesResponse
Property loggingProperties
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.
MasterPasswordSecretArn string
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
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.
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.
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.
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
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
Property ownerAccount
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 []TagResponse
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.
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
clusterNamespaceArn String
The Amazon Resource Name (ARN) of the cluster namespace.
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.
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
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.
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.
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.
deferMaintenanceIdentifier String
A unique identifier for the deferred maintenance window.
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 RedshiftClusterEndpointResponse
Property endpoint
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 LoggingPropertiesResponse
Property loggingProperties
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 Boolean
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 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.
masterPasswordSecretArn String
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
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.
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.
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.
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
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
Property ownerAccount
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
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<TagResponse>
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.
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
clusterNamespaceArn string
The Amazon Resource Name (ARN) of the cluster namespace.
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.
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
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.
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.
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.
deferMaintenanceIdentifier string
A unique identifier for the deferred maintenance window.
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 RedshiftClusterEndpointResponse
Property endpoint
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 LoggingPropertiesResponse
Property loggingProperties
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 boolean
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 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.
masterPasswordSecretArn string
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
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.
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.
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.
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
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
Property ownerAccount
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
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 TagResponse[]
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.
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_namespace_arn str
The Amazon Resource Name (ARN) of the cluster namespace.
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_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
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.
db_name str
The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.
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_identifier str
A unique identifier for the deferred maintenance window.
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 RedshiftClusterEndpointResponse
Property endpoint
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 LoggingPropertiesResponse
Property loggingProperties
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.
manage_master_password 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.
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_arn str
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
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
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.
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.
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.
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
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
Property ownerAccount
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
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[TagResponse]
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.
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
clusterNamespaceArn String
The Amazon Resource Name (ARN) of the cluster namespace.
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.
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
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.
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.
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.
deferMaintenanceIdentifier String
A unique identifier for the deferred maintenance window.
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
Property endpoint
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
Property loggingProperties
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 Boolean
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 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.
masterPasswordSecretArn String
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
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.
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.
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.
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
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
Property ownerAccount
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
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.

LoggingPropertiesResponse

BucketName string
Property bucketName
S3KeyPrefix string
Property s3KeyPrefix
BucketName string
Property bucketName
S3KeyPrefix string
Property s3KeyPrefix
bucketName String
Property bucketName
s3KeyPrefix String
Property s3KeyPrefix
bucketName string
Property bucketName
s3KeyPrefix string
Property s3KeyPrefix
bucket_name str
Property bucketName
s3_key_prefix str
Property s3KeyPrefix
bucketName String
Property bucketName
s3KeyPrefix String
Property s3KeyPrefix

RedshiftClusterEndpointResponse

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

RedshiftClusterPropertiesResponse

ProvisioningState This property is required. string
The status of the last operation.
Arn string
Amazon Resource Name (ARN)
AwsAccountId string
AWS Account ID
AwsProperties Pulumi.AzureNative.AwsConnector.Inputs.AwsRedshiftClusterPropertiesResponse
AWS Properties
AwsRegion string
AWS Region
AwsSourceSchema string
AWS Source Schema
AwsTags Dictionary<string, string>
AWS Tags
PublicCloudConnectorsResourceId string
Public Cloud Connectors Resource ID
PublicCloudResourceName string
Public Cloud Resource Name
ProvisioningState This property is required. string
The status of the last operation.
Arn string
Amazon Resource Name (ARN)
AwsAccountId string
AWS Account ID
AwsProperties AwsRedshiftClusterPropertiesResponse
AWS Properties
AwsRegion string
AWS Region
AwsSourceSchema string
AWS Source Schema
AwsTags map[string]string
AWS Tags
PublicCloudConnectorsResourceId string
Public Cloud Connectors Resource ID
PublicCloudResourceName string
Public Cloud Resource Name
provisioningState This property is required. String
The status of the last operation.
arn String
Amazon Resource Name (ARN)
awsAccountId String
AWS Account ID
awsProperties AwsRedshiftClusterPropertiesResponse
AWS Properties
awsRegion String
AWS Region
awsSourceSchema String
AWS Source Schema
awsTags Map<String,String>
AWS Tags
publicCloudConnectorsResourceId String
Public Cloud Connectors Resource ID
publicCloudResourceName String
Public Cloud Resource Name
provisioningState This property is required. string
The status of the last operation.
arn string
Amazon Resource Name (ARN)
awsAccountId string
AWS Account ID
awsProperties AwsRedshiftClusterPropertiesResponse
AWS Properties
awsRegion string
AWS Region
awsSourceSchema string
AWS Source Schema
awsTags {[key: string]: string}
AWS Tags
publicCloudConnectorsResourceId string
Public Cloud Connectors Resource ID
publicCloudResourceName string
Public Cloud Resource Name
provisioning_state This property is required. str
The status of the last operation.
arn str
Amazon Resource Name (ARN)
aws_account_id str
AWS Account ID
aws_properties AwsRedshiftClusterPropertiesResponse
AWS Properties
aws_region str
AWS Region
aws_source_schema str
AWS Source Schema
aws_tags Mapping[str, str]
AWS Tags
public_cloud_connectors_resource_id str
Public Cloud Connectors Resource ID
public_cloud_resource_name str
Public Cloud Resource Name
provisioningState This property is required. String
The status of the last operation.
arn String
Amazon Resource Name (ARN)
awsAccountId String
AWS Account ID
awsProperties Property Map
AWS Properties
awsRegion String
AWS Region
awsSourceSchema String
AWS Source Schema
awsTags Map<String>
AWS Tags
publicCloudConnectorsResourceId String
Public Cloud Connectors Resource ID
publicCloudResourceName String
Public Cloud Resource Name

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

TagResponse

Key string
The key name of the tag. You can specify a value that is 1 to 128 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 0 to 256 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 128 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 0 to 256 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 128 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 0 to 256 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 128 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 0 to 256 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 128 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 0 to 256 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 128 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 0 to 256 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
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native