Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The redshiftClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/redshiftClusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/redshiftClusters@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
allowVersionUpgrade: bool
aquaConfigurationStatus: 'string'
automatedSnapshotRetentionPeriod: int
availabilityZone: 'string'
availabilityZoneRelocation: bool
availabilityZoneRelocationStatus: 'string'
classic: bool
clusterIdentifier: 'string'
clusterNamespaceArn: 'string'
clusterParameterGroupName: 'string'
clusterSecurityGroups: [
'string'
]
clusterSubnetGroupName: 'string'
clusterType: 'string'
clusterVersion: 'string'
dbName: 'string'
deferMaintenance: bool
deferMaintenanceDuration: int
deferMaintenanceEndTime: 'string'
deferMaintenanceIdentifier: 'string'
deferMaintenanceStartTime: 'string'
destinationRegion: 'string'
elasticIp: 'string'
encrypted: bool
endpoint: {
address: 'string'
port: 'string'
}
enhancedVpcRouting: bool
hsmClientCertificateIdentifier: 'string'
hsmConfigurationIdentifier: 'string'
iamRoles: [
'string'
]
kmsKeyId: 'string'
loggingProperties: {
bucketName: 'string'
s3KeyPrefix: 'string'
}
maintenanceTrackName: 'string'
manageMasterPassword: bool
manualSnapshotRetentionPeriod: int
masterPasswordSecretArn: 'string'
masterPasswordSecretKmsKeyId: 'string'
masterUsername: 'string'
masterUserPassword: 'string'
multiAZ: bool
namespaceResourcePolicy: any(...)
nodeType: 'string'
numberOfNodes: int
ownerAccount: 'string'
port: int
preferredMaintenanceWindow: 'string'
publiclyAccessible: bool
resourceAction: 'string'
revisionTarget: 'string'
rotateEncryptionKey: bool
snapshotClusterIdentifier: 'string'
snapshotCopyGrantName: 'string'
snapshotCopyManual: bool
snapshotCopyRetentionPeriod: int
snapshotIdentifier: 'string'
tags: [
{
key: 'string'
value: 'string'
}
]
vpcSecurityGroupIds: [
'string'
]
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/redshiftClusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | RedshiftClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AwsRedshiftClusterProperties
| Name | Description | Value |
|---|---|---|
| allowVersionUpgrade | 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 | bool |
| aquaConfigurationStatus | 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. | string |
| automatedSnapshotRetentionPeriod | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 | int |
| availabilityZone | 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 | string |
| availabilityZoneRelocation | The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. | bool |
| availabilityZoneRelocationStatus | The availability zone relocation status of the cluster | string |
| classic | A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. | bool |
| clusterIdentifier | 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 | string |
| clusterNamespaceArn | The Amazon Resource Name (ARN) of the cluster namespace. | string |
| clusterParameterGroupName | The name of the parameter group to be associated with this cluster. | string |
| clusterSecurityGroups | A list of security groups to be associated with this cluster. | string[] |
| clusterSubnetGroupName | The name of a cluster subnet group to be associated with this cluster. | string |
| clusterType | 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 | string |
| clusterVersion | 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. | string |
| dbName | 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. | string |
| deferMaintenance | A boolean indicating whether to enable the deferred maintenance window. | bool |
| deferMaintenanceDuration | 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. | int |
| deferMaintenanceEndTime | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. | string |
| deferMaintenanceIdentifier | A unique identifier for the deferred maintenance window. | string |
| deferMaintenanceStartTime | A timestamp indicating the start time for the deferred maintenance window. | string |
| destinationRegion | 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 | string |
| elasticIp | The Elastic IP (EIP) address for the cluster. | string |
| encrypted | If true, the data in the cluster is encrypted at rest. | bool |
| endpoint | Property endpoint | EndpointAutoGenerated3 |
| enhancedVpcRouting | 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 | bool |
| hsmClientCertificateIdentifier | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM | string |
| hsmConfigurationIdentifier | 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. | string |
| iamRoles | 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 | string[] |
| kmsKeyId | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. | string |
| loggingProperties | Property loggingProperties | LoggingProperties |
| maintenanceTrackName | 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. | string |
| manageMasterPassword | 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. | bool |
| manualSnapshotRetentionPeriod | 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. | int |
| masterPasswordSecretArn | The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. | string |
| masterPasswordSecretKmsKeyId | The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. | string |
| masterUsername | 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. | string |
| masterUserPassword | 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. | string |
| multiAZ | 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. | bool |
| namespaceResourcePolicy | The namespace resource policy document that will be attached to a Redshift cluster. | any |
| nodeType | 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 | string |
| numberOfNodes | The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. | int |
| ownerAccount | Property ownerAccount | string |
| port | The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings | int |
| preferredMaintenanceWindow | The weekly time range (in UTC) during which automated cluster maintenance can occur. | string |
| publiclyAccessible | If true, the cluster can be accessed from a public network. | bool |
| resourceAction | The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs | string |
| revisionTarget | The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. | string |
| rotateEncryptionKey | A boolean indicating if we want to rotate Encryption Keys. | bool |
| snapshotClusterIdentifier | 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. | string |
| snapshotCopyGrantName | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. | string |
| snapshotCopyManual | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. | bool |
| snapshotCopyRetentionPeriod | 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. | int |
| snapshotIdentifier | The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. | string |
| tags | The list of tags for the cluster parameter group. | Tag[] |
| vpcSecurityGroupIds | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. | string[] |
EndpointAutoGenerated3
| Name | Description | Value |
|---|---|---|
| address | Property address | string |
| port | Property port | string |
LoggingProperties
| Name | Description | Value |
|---|---|---|
| bucketName | Property bucketName | string |
| s3KeyPrefix | Property s3KeyPrefix | string |
RedshiftClusterProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsRedshiftClusterProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | RedshiftClusterPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
RedshiftClusterPropertiesAwsTags
| Name | Description | Value |
|---|
Tag
| Name | Description | Value |
|---|---|---|
| key | The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. | string |
| value | The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The redshiftClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/redshiftClusters resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/redshiftClusters",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"allowVersionUpgrade": "bool",
"aquaConfigurationStatus": "string",
"automatedSnapshotRetentionPeriod": "int",
"availabilityZone": "string",
"availabilityZoneRelocation": "bool",
"availabilityZoneRelocationStatus": "string",
"classic": "bool",
"clusterIdentifier": "string",
"clusterNamespaceArn": "string",
"clusterParameterGroupName": "string",
"clusterSecurityGroups": [ "string" ],
"clusterSubnetGroupName": "string",
"clusterType": "string",
"clusterVersion": "string",
"dbName": "string",
"deferMaintenance": "bool",
"deferMaintenanceDuration": "int",
"deferMaintenanceEndTime": "string",
"deferMaintenanceIdentifier": "string",
"deferMaintenanceStartTime": "string",
"destinationRegion": "string",
"elasticIp": "string",
"encrypted": "bool",
"endpoint": {
"address": "string",
"port": "string"
},
"enhancedVpcRouting": "bool",
"hsmClientCertificateIdentifier": "string",
"hsmConfigurationIdentifier": "string",
"iamRoles": [ "string" ],
"kmsKeyId": "string",
"loggingProperties": {
"bucketName": "string",
"s3KeyPrefix": "string"
},
"maintenanceTrackName": "string",
"manageMasterPassword": "bool",
"manualSnapshotRetentionPeriod": "int",
"masterPasswordSecretArn": "string",
"masterPasswordSecretKmsKeyId": "string",
"masterUsername": "string",
"masterUserPassword": "string",
"multiAZ": "bool",
"namespaceResourcePolicy": {},
"nodeType": "string",
"numberOfNodes": "int",
"ownerAccount": "string",
"port": "int",
"preferredMaintenanceWindow": "string",
"publiclyAccessible": "bool",
"resourceAction": "string",
"revisionTarget": "string",
"rotateEncryptionKey": "bool",
"snapshotClusterIdentifier": "string",
"snapshotCopyGrantName": "string",
"snapshotCopyManual": "bool",
"snapshotCopyRetentionPeriod": "int",
"snapshotIdentifier": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpcSecurityGroupIds": [ "string" ]
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/redshiftClusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | RedshiftClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AwsConnector/redshiftClusters' |
AwsRedshiftClusterProperties
| Name | Description | Value |
|---|---|---|
| allowVersionUpgrade | 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 | bool |
| aquaConfigurationStatus | 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. | string |
| automatedSnapshotRetentionPeriod | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 | int |
| availabilityZone | 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 | string |
| availabilityZoneRelocation | The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. | bool |
| availabilityZoneRelocationStatus | The availability zone relocation status of the cluster | string |
| classic | A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. | bool |
| clusterIdentifier | 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 | string |
| clusterNamespaceArn | The Amazon Resource Name (ARN) of the cluster namespace. | string |
| clusterParameterGroupName | The name of the parameter group to be associated with this cluster. | string |
| clusterSecurityGroups | A list of security groups to be associated with this cluster. | string[] |
| clusterSubnetGroupName | The name of a cluster subnet group to be associated with this cluster. | string |
| clusterType | 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 | string |
| clusterVersion | 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. | string |
| dbName | 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. | string |
| deferMaintenance | A boolean indicating whether to enable the deferred maintenance window. | bool |
| deferMaintenanceDuration | 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. | int |
| deferMaintenanceEndTime | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. | string |
| deferMaintenanceIdentifier | A unique identifier for the deferred maintenance window. | string |
| deferMaintenanceStartTime | A timestamp indicating the start time for the deferred maintenance window. | string |
| destinationRegion | 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 | string |
| elasticIp | The Elastic IP (EIP) address for the cluster. | string |
| encrypted | If true, the data in the cluster is encrypted at rest. | bool |
| endpoint | Property endpoint | EndpointAutoGenerated3 |
| enhancedVpcRouting | 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 | bool |
| hsmClientCertificateIdentifier | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM | string |
| hsmConfigurationIdentifier | 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. | string |
| iamRoles | 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 | string[] |
| kmsKeyId | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. | string |
| loggingProperties | Property loggingProperties | LoggingProperties |
| maintenanceTrackName | 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. | string |
| manageMasterPassword | 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. | bool |
| manualSnapshotRetentionPeriod | 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. | int |
| masterPasswordSecretArn | The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. | string |
| masterPasswordSecretKmsKeyId | The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. | string |
| masterUsername | 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. | string |
| masterUserPassword | 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. | string |
| multiAZ | 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. | bool |
| namespaceResourcePolicy | The namespace resource policy document that will be attached to a Redshift cluster. | any |
| nodeType | 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 | string |
| numberOfNodes | The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. | int |
| ownerAccount | Property ownerAccount | string |
| port | The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings | int |
| preferredMaintenanceWindow | The weekly time range (in UTC) during which automated cluster maintenance can occur. | string |
| publiclyAccessible | If true, the cluster can be accessed from a public network. | bool |
| resourceAction | The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs | string |
| revisionTarget | The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. | string |
| rotateEncryptionKey | A boolean indicating if we want to rotate Encryption Keys. | bool |
| snapshotClusterIdentifier | 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. | string |
| snapshotCopyGrantName | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. | string |
| snapshotCopyManual | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. | bool |
| snapshotCopyRetentionPeriod | 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. | int |
| snapshotIdentifier | The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. | string |
| tags | The list of tags for the cluster parameter group. | Tag[] |
| vpcSecurityGroupIds | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. | string[] |
EndpointAutoGenerated3
| Name | Description | Value |
|---|---|---|
| address | Property address | string |
| port | Property port | string |
LoggingProperties
| Name | Description | Value |
|---|---|---|
| bucketName | Property bucketName | string |
| s3KeyPrefix | Property s3KeyPrefix | string |
RedshiftClusterProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsRedshiftClusterProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | RedshiftClusterPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
RedshiftClusterPropertiesAwsTags
| Name | Description | Value |
|---|
Tag
| Name | Description | Value |
|---|---|---|
| key | The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. | string |
| value | The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The redshiftClusters resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/redshiftClusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/redshiftClusters@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
allowVersionUpgrade = bool
aquaConfigurationStatus = "string"
automatedSnapshotRetentionPeriod = int
availabilityZone = "string"
availabilityZoneRelocation = bool
availabilityZoneRelocationStatus = "string"
classic = bool
clusterIdentifier = "string"
clusterNamespaceArn = "string"
clusterParameterGroupName = "string"
clusterSecurityGroups = [
"string"
]
clusterSubnetGroupName = "string"
clusterType = "string"
clusterVersion = "string"
dbName = "string"
deferMaintenance = bool
deferMaintenanceDuration = int
deferMaintenanceEndTime = "string"
deferMaintenanceIdentifier = "string"
deferMaintenanceStartTime = "string"
destinationRegion = "string"
elasticIp = "string"
encrypted = bool
endpoint = {
address = "string"
port = "string"
}
enhancedVpcRouting = bool
hsmClientCertificateIdentifier = "string"
hsmConfigurationIdentifier = "string"
iamRoles = [
"string"
]
kmsKeyId = "string"
loggingProperties = {
bucketName = "string"
s3KeyPrefix = "string"
}
maintenanceTrackName = "string"
manageMasterPassword = bool
manualSnapshotRetentionPeriod = int
masterPasswordSecretArn = "string"
masterPasswordSecretKmsKeyId = "string"
masterUsername = "string"
masterUserPassword = "string"
multiAZ = bool
namespaceResourcePolicy = ?
nodeType = "string"
numberOfNodes = int
ownerAccount = "string"
port = int
preferredMaintenanceWindow = "string"
publiclyAccessible = bool
resourceAction = "string"
revisionTarget = "string"
rotateEncryptionKey = bool
snapshotClusterIdentifier = "string"
snapshotCopyGrantName = "string"
snapshotCopyManual = bool
snapshotCopyRetentionPeriod = int
snapshotIdentifier = "string"
tags = [
{
key = "string"
value = "string"
}
]
vpcSecurityGroupIds = [
"string"
]
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/redshiftClusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | RedshiftClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AwsConnector/redshiftClusters@2024-12-01" |
AwsRedshiftClusterProperties
| Name | Description | Value |
|---|---|---|
| allowVersionUpgrade | 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 | bool |
| aquaConfigurationStatus | 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. | string |
| automatedSnapshotRetentionPeriod | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 | int |
| availabilityZone | 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 | string |
| availabilityZoneRelocation | The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. | bool |
| availabilityZoneRelocationStatus | The availability zone relocation status of the cluster | string |
| classic | A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. | bool |
| clusterIdentifier | 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 | string |
| clusterNamespaceArn | The Amazon Resource Name (ARN) of the cluster namespace. | string |
| clusterParameterGroupName | The name of the parameter group to be associated with this cluster. | string |
| clusterSecurityGroups | A list of security groups to be associated with this cluster. | string[] |
| clusterSubnetGroupName | The name of a cluster subnet group to be associated with this cluster. | string |
| clusterType | 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 | string |
| clusterVersion | 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. | string |
| dbName | 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. | string |
| deferMaintenance | A boolean indicating whether to enable the deferred maintenance window. | bool |
| deferMaintenanceDuration | 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. | int |
| deferMaintenanceEndTime | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. | string |
| deferMaintenanceIdentifier | A unique identifier for the deferred maintenance window. | string |
| deferMaintenanceStartTime | A timestamp indicating the start time for the deferred maintenance window. | string |
| destinationRegion | 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 | string |
| elasticIp | The Elastic IP (EIP) address for the cluster. | string |
| encrypted | If true, the data in the cluster is encrypted at rest. | bool |
| endpoint | Property endpoint | EndpointAutoGenerated3 |
| enhancedVpcRouting | 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 | bool |
| hsmClientCertificateIdentifier | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM | string |
| hsmConfigurationIdentifier | 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. | string |
| iamRoles | 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 | string[] |
| kmsKeyId | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. | string |
| loggingProperties | Property loggingProperties | LoggingProperties |
| maintenanceTrackName | 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. | string |
| manageMasterPassword | 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. | bool |
| manualSnapshotRetentionPeriod | 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. | int |
| masterPasswordSecretArn | The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. | string |
| masterPasswordSecretKmsKeyId | The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. | string |
| masterUsername | 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. | string |
| masterUserPassword | 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. | string |
| multiAZ | 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. | bool |
| namespaceResourcePolicy | The namespace resource policy document that will be attached to a Redshift cluster. | any |
| nodeType | 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 | string |
| numberOfNodes | The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. | int |
| ownerAccount | Property ownerAccount | string |
| port | The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings | int |
| preferredMaintenanceWindow | The weekly time range (in UTC) during which automated cluster maintenance can occur. | string |
| publiclyAccessible | If true, the cluster can be accessed from a public network. | bool |
| resourceAction | The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs | string |
| revisionTarget | The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. | string |
| rotateEncryptionKey | A boolean indicating if we want to rotate Encryption Keys. | bool |
| snapshotClusterIdentifier | 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. | string |
| snapshotCopyGrantName | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. | string |
| snapshotCopyManual | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. | bool |
| snapshotCopyRetentionPeriod | 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. | int |
| snapshotIdentifier | The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. | string |
| tags | The list of tags for the cluster parameter group. | Tag[] |
| vpcSecurityGroupIds | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. | string[] |
EndpointAutoGenerated3
| Name | Description | Value |
|---|---|---|
| address | Property address | string |
| port | Property port | string |
LoggingProperties
| Name | Description | Value |
|---|---|---|
| bucketName | Property bucketName | string |
| s3KeyPrefix | Property s3KeyPrefix | string |
RedshiftClusterProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsRedshiftClusterProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | RedshiftClusterPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
RedshiftClusterPropertiesAwsTags
| Name | Description | Value |
|---|
Tag
| Name | Description | Value |
|---|---|---|
| key | The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. | string |
| value | The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. | string |
TrackedResourceTags
| Name | Description | Value |
|---|