This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.awsconnector.getRedshiftCluster
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Get a RedshiftCluster 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>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]func LookupRedshiftCluster(ctx *Context, args *LookupRedshiftClusterArgs, opts ...InvokeOption) (*LookupRedshiftClusterResult, error)
func LookupRedshiftClusterOutput(ctx *Context, args *LookupRedshiftClusterOutputArgs, opts ...InvokeOption) LookupRedshiftClusterResultOutput> 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)
}public static CompletableFuture<GetRedshiftClusterResult> getRedshiftCluster(GetRedshiftClusterArgs args, InvokeOptions options)
public static Output<GetRedshiftClusterResult> getRedshiftCluster(GetRedshiftClusterArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:awsconnector:getRedshiftCluster
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
- Name of RedshiftCluster
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- Name string
- Name of RedshiftCluster
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- name String
- Name of RedshiftCluster
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- name string
- Name of RedshiftCluster
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- name str
- Name of RedshiftCluster
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- name String
- Name of RedshiftCluster
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
getRedshiftCluster Result
The following output properties are available:
- 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.Azure Native. Aws Connector. Outputs. Redshift Cluster Properties Response 
- The resource-specific properties for this resource.
- SystemData Pulumi.Azure Native. Aws Connector. Outputs. System Data Response 
- 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"
- Dictionary<string, string>
- Resource tags.
- 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
RedshiftCluster Properties Response 
- The resource-specific properties for this resource.
- SystemData SystemData Response 
- 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"
- map[string]string
- Resource tags.
- 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
RedshiftCluster Properties Response 
- The resource-specific properties for this resource.
- systemData SystemData Response 
- 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"
- Map<String,String>
- Resource tags.
- 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
RedshiftCluster Properties Response 
- The resource-specific properties for this resource.
- systemData SystemData Response 
- 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"
- {[key: string]: string}
- Resource tags.
- 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
RedshiftCluster Properties Response 
- The resource-specific properties for this resource.
- system_data SystemData Response 
- 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"
- Mapping[str, str]
- Resource tags.
- 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"
- Map<String>
- Resource tags.
Supporting Types
AwsRedshiftClusterPropertiesResponse    
- AllowVersion boolUpgrade 
- 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
- AquaConfiguration stringStatus 
- 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.
- AutomatedSnapshot intRetention Period 
- 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
- AvailabilityZone boolRelocation 
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
- AvailabilityZone stringRelocation Status 
- 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
- ClusterNamespace stringArn 
- The Amazon Resource Name (ARN) of the cluster namespace.
- ClusterParameter stringGroup Name 
- The name of the parameter group to be associated with this cluster.
- ClusterSecurity List<string>Groups 
- A list of security groups to be associated with this cluster.
- ClusterSubnet stringGroup Name 
- 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.
- DeferMaintenance intDuration 
- 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.
- DeferMaintenance stringEnd Time 
- A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
- DeferMaintenance stringIdentifier 
- A unique identifier for the deferred maintenance window.
- DeferMaintenance stringStart Time 
- 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.Azure Native. Aws Connector. Inputs. Redshift Cluster Endpoint Response 
- Property endpoint
- EnhancedVpc boolRouting 
- 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
- HsmClient stringCertificate Identifier 
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
- HsmConfiguration stringIdentifier 
- 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
- KmsKey stringId 
- 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.Azure Native. Aws Connector. Inputs. Logging Properties Response 
- Property loggingProperties
- MaintenanceTrack stringName 
- 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.
- ManageMaster boolPassword 
- 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.
- ManualSnapshot intRetention Period 
- 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.
- MasterPassword stringSecret Arn 
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
- MasterPassword stringSecret Kms Key Id 
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
- MasterUser stringPassword 
- 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.
- NamespaceResource objectPolicy 
- 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
- NumberOf intNodes 
- 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
- PreferredMaintenance stringWindow 
- 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.
- RotateEncryption boolKey 
- A boolean indicating if we want to rotate Encryption Keys.
- SnapshotCluster stringIdentifier 
- 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.
- SnapshotCopy stringGrant Name 
- The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
- SnapshotCopy boolManual 
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
- SnapshotCopy intRetention Period 
- 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.
- 
List<Pulumi.Azure Native. Aws Connector. Inputs. Tag Response> 
- The list of tags for the cluster parameter group.
- VpcSecurity List<string>Group Ids 
- A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- AllowVersion boolUpgrade 
- 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
- AquaConfiguration stringStatus 
- 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.
- AutomatedSnapshot intRetention Period 
- 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
- AvailabilityZone boolRelocation 
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
- AvailabilityZone stringRelocation Status 
- 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
- ClusterNamespace stringArn 
- The Amazon Resource Name (ARN) of the cluster namespace.
- ClusterParameter stringGroup Name 
- The name of the parameter group to be associated with this cluster.
- ClusterSecurity []stringGroups 
- A list of security groups to be associated with this cluster.
- ClusterSubnet stringGroup Name 
- 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.
- DeferMaintenance intDuration 
- 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.
- DeferMaintenance stringEnd Time 
- A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
- DeferMaintenance stringIdentifier 
- A unique identifier for the deferred maintenance window.
- DeferMaintenance stringStart Time 
- 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
RedshiftCluster Endpoint Response 
- Property endpoint
- EnhancedVpc boolRouting 
- 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
- HsmClient stringCertificate Identifier 
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
- HsmConfiguration stringIdentifier 
- 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
- KmsKey stringId 
- The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
- LoggingProperties LoggingProperties Response 
- Property loggingProperties
- MaintenanceTrack stringName 
- 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.
- ManageMaster boolPassword 
- 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.
- ManualSnapshot intRetention Period 
- 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.
- MasterPassword stringSecret Arn 
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
- MasterPassword stringSecret Kms Key Id 
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
- MasterUser stringPassword 
- 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.
- NamespaceResource interface{}Policy 
- 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
- NumberOf intNodes 
- 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
- PreferredMaintenance stringWindow 
- 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.
- RotateEncryption boolKey 
- A boolean indicating if we want to rotate Encryption Keys.
- SnapshotCluster stringIdentifier 
- 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.
- SnapshotCopy stringGrant Name 
- The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
- SnapshotCopy boolManual 
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
- SnapshotCopy intRetention Period 
- 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.
- 
[]TagResponse 
- The list of tags for the cluster parameter group.
- VpcSecurity []stringGroup Ids 
- A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allowVersion BooleanUpgrade 
- 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
- aquaConfiguration StringStatus 
- 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.
- automatedSnapshot IntegerRetention Period 
- 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
- availabilityZone BooleanRelocation 
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
- availabilityZone StringRelocation Status 
- 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
- clusterNamespace StringArn 
- The Amazon Resource Name (ARN) of the cluster namespace.
- clusterParameter StringGroup Name 
- The name of the parameter group to be associated with this cluster.
- clusterSecurity List<String>Groups 
- A list of security groups to be associated with this cluster.
- clusterSubnet StringGroup Name 
- 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.
- deferMaintenance IntegerDuration 
- 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.
- deferMaintenance StringEnd Time 
- A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
- deferMaintenance StringIdentifier 
- A unique identifier for the deferred maintenance window.
- deferMaintenance StringStart Time 
- 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
RedshiftCluster Endpoint Response 
- Property endpoint
- enhancedVpc BooleanRouting 
- 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
- hsmClient StringCertificate Identifier 
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
- hsmConfiguration StringIdentifier 
- 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
- kmsKey StringId 
- The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
- loggingProperties LoggingProperties Response 
- Property loggingProperties
- maintenanceTrack StringName 
- 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.
- manageMaster BooleanPassword 
- 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.
- manualSnapshot IntegerRetention Period 
- 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.
- masterPassword StringSecret Arn 
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
- masterPassword StringSecret Kms Key Id 
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
- masterUser StringPassword 
- 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.
- namespaceResource ObjectPolicy 
- 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
- numberOf IntegerNodes 
- 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
- preferredMaintenance StringWindow 
- 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.
- rotateEncryption BooleanKey 
- A boolean indicating if we want to rotate Encryption Keys.
- snapshotCluster StringIdentifier 
- 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.
- snapshotCopy StringGrant Name 
- The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
- snapshotCopy BooleanManual 
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
- snapshotCopy IntegerRetention Period 
- 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.
- 
List<TagResponse> 
- The list of tags for the cluster parameter group.
- vpcSecurity List<String>Group Ids 
- A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allowVersion booleanUpgrade 
- 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
- aquaConfiguration stringStatus 
- 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.
- automatedSnapshot numberRetention Period 
- 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
- availabilityZone booleanRelocation 
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
- availabilityZone stringRelocation Status 
- 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
- clusterNamespace stringArn 
- The Amazon Resource Name (ARN) of the cluster namespace.
- clusterParameter stringGroup Name 
- The name of the parameter group to be associated with this cluster.
- clusterSecurity string[]Groups 
- A list of security groups to be associated with this cluster.
- clusterSubnet stringGroup Name 
- 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.
- deferMaintenance numberDuration 
- 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.
- deferMaintenance stringEnd Time 
- A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
- deferMaintenance stringIdentifier 
- A unique identifier for the deferred maintenance window.
- deferMaintenance stringStart Time 
- 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
RedshiftCluster Endpoint Response 
- Property endpoint
- enhancedVpc booleanRouting 
- 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
- hsmClient stringCertificate Identifier 
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
- hsmConfiguration stringIdentifier 
- 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
- kmsKey stringId 
- The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
- loggingProperties LoggingProperties Response 
- Property loggingProperties
- maintenanceTrack stringName 
- 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.
- manageMaster booleanPassword 
- 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.
- manualSnapshot numberRetention Period 
- 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.
- masterPassword stringSecret Arn 
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
- masterPassword stringSecret Kms Key Id 
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
- masterUser stringPassword 
- 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.
- namespaceResource anyPolicy 
- 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
- numberOf numberNodes 
- 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
- preferredMaintenance stringWindow 
- 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.
- rotateEncryption booleanKey 
- A boolean indicating if we want to rotate Encryption Keys.
- snapshotCluster stringIdentifier 
- 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.
- snapshotCopy stringGrant Name 
- The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
- snapshotCopy booleanManual 
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
- snapshotCopy numberRetention Period 
- 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.
- 
TagResponse[] 
- The list of tags for the cluster parameter group.
- vpcSecurity string[]Group Ids 
- A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allow_version_ boolupgrade 
- 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_ strstatus 
- 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_ intretention_ period 
- 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_ boolrelocation 
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
- availability_zone_ strrelocation_ status 
- 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_ strarn 
- The Amazon Resource Name (ARN) of the cluster namespace.
- cluster_parameter_ strgroup_ name 
- The name of the parameter group to be associated with this cluster.
- cluster_security_ Sequence[str]groups 
- A list of security groups to be associated with this cluster.
- cluster_subnet_ strgroup_ name 
- 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_ intduration 
- 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_ strend_ time 
- A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
- defer_maintenance_ stridentifier 
- A unique identifier for the deferred maintenance window.
- defer_maintenance_ strstart_ time 
- 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
RedshiftCluster Endpoint Response 
- Property endpoint
- enhanced_vpc_ boolrouting 
- 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_ strcertificate_ identifier 
- 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_ stridentifier 
- 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_ strid 
- 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 LoggingProperties Response 
- Property loggingProperties
- maintenance_track_ strname 
- 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_ boolpassword 
- 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_ intretention_ period 
- 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_ strsecret_ arn 
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
- master_password_ strsecret_ kms_ key_ id 
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
- master_user_ strpassword 
- 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_ Anypolicy 
- 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_ intnodes 
- 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_ strwindow 
- 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_ boolkey 
- A boolean indicating if we want to rotate Encryption Keys.
- snapshot_cluster_ stridentifier 
- 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_ strgrant_ name 
- 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_ boolmanual 
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
- snapshot_copy_ intretention_ period 
- 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.
- 
Sequence[TagResponse] 
- The list of tags for the cluster parameter group.
- vpc_security_ Sequence[str]group_ ids 
- A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allowVersion BooleanUpgrade 
- 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
- aquaConfiguration StringStatus 
- 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.
- automatedSnapshot NumberRetention Period 
- 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
- availabilityZone BooleanRelocation 
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
- availabilityZone StringRelocation Status 
- 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
- clusterNamespace StringArn 
- The Amazon Resource Name (ARN) of the cluster namespace.
- clusterParameter StringGroup Name 
- The name of the parameter group to be associated with this cluster.
- clusterSecurity List<String>Groups 
- A list of security groups to be associated with this cluster.
- clusterSubnet StringGroup Name 
- 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.
- deferMaintenance NumberDuration 
- 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.
- deferMaintenance StringEnd Time 
- A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
- deferMaintenance StringIdentifier 
- A unique identifier for the deferred maintenance window.
- deferMaintenance StringStart Time 
- 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
- enhancedVpc BooleanRouting 
- 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
- hsmClient StringCertificate Identifier 
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
- hsmConfiguration StringIdentifier 
- 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
- kmsKey StringId 
- 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
- maintenanceTrack StringName 
- 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.
- manageMaster BooleanPassword 
- 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.
- manualSnapshot NumberRetention Period 
- 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.
- masterPassword StringSecret Arn 
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
- masterPassword StringSecret Kms Key Id 
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
- masterUser StringPassword 
- 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.
- namespaceResource AnyPolicy 
- 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
- numberOf NumberNodes 
- 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
- preferredMaintenance StringWindow 
- 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.
- rotateEncryption BooleanKey 
- A boolean indicating if we want to rotate Encryption Keys.
- snapshotCluster StringIdentifier 
- 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.
- snapshotCopy StringGrant Name 
- The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
- snapshotCopy BooleanManual 
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
- snapshotCopy NumberRetention Period 
- 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.
- List<Property Map>
- The list of tags for the cluster parameter group.
- vpcSecurity List<String>Group Ids 
- 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_ strprefix 
- Property s3KeyPrefix
- bucketName String
- Property bucketName
- s3KeyPrefix String
- Property s3KeyPrefix
RedshiftClusterEndpointResponse   
RedshiftClusterPropertiesResponse   
- ProvisioningState string
- The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties Pulumi.Azure Native. Aws Connector. Inputs. Aws Redshift Cluster Properties Response 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- ProvisioningState string
- The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties AwsRedshift Cluster Properties Response 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- map[string]string
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- provisioningState String
- The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties AwsRedshift Cluster Properties Response 
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String,String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
- provisioningState string
- The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- awsAccount stringId 
- AWS Account ID
- awsProperties AwsRedshift Cluster Properties Response 
- AWS Properties
- awsRegion string
- AWS Region
- awsSource stringSchema 
- AWS Source Schema
- {[key: string]: string}
- AWS Tags
- publicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud stringResource Name 
- Public Cloud Resource Name
- provisioning_state str
- The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_account_ strid 
- AWS Account ID
- aws_properties AwsRedshift Cluster Properties Response 
- AWS Properties
- aws_region str
- AWS Region
- aws_source_ strschema 
- AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_cloud_ strconnectors_ resource_ id 
- Public Cloud Connectors Resource ID
- public_cloud_ strresource_ name 
- Public Cloud Resource Name
- provisioningState String
- The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties Property Map
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
SystemDataResponse  
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi