--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_redshift_cluster{% #aws_redshift_cluster %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `allow_version_upgrade`{% #allow_version_upgrade %} **Type**: `BOOLEAN`**Provider name**: `AllowVersionUpgrade`**Description**: A boolean value that, if `true`, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. ## `aqua_configuration`{% #aqua_configuration %} **Type**: `STRUCT`**Provider name**: `AquaConfiguration`**Description**: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). - `aqua_configuration_status`**Type**: `STRING`**Provider name**: `AquaConfigurationStatus`**Description**: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). - `aqua_status`**Type**: `STRING`**Provider name**: `AquaStatus`**Description**: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). ## `automated_snapshot_retention_period`{% #automated_snapshot_retention_period %} **Type**: `INT32`**Provider name**: `AutomatedSnapshotRetentionPeriod`**Description**: The number of days that automatic cluster snapshots are retained. ## `availability_zone`{% #availability_zone %} **Type**: `STRING`**Provider name**: `AvailabilityZone`**Description**: The name of the Availability Zone in which the cluster is located. ## `availability_zone_relocation_status`{% #availability_zone_relocation_status %} **Type**: `STRING`**Provider name**: `AvailabilityZoneRelocationStatus`**Description**: Describes the status of the Availability Zone relocation operation. ## `cluster_availability_status`{% #cluster_availability_status %} **Type**: `STRING`**Provider name**: `ClusterAvailabilityStatus`**Description**: The availability status of the cluster for queries. Possible values are the following: - Available - The cluster is available for queries. - Unavailable - The cluster is not available for queries. - Maintenance - The cluster is intermittently available for queries due to maintenance activities. - Modifying - The cluster is intermittently available for queries due to changes that modify the cluster. - Failed - The cluster failed and is not available for queries. ## `cluster_create_time`{% #cluster_create_time %} **Type**: `TIMESTAMP`**Provider name**: `ClusterCreateTime`**Description**: The date and time that the cluster was created. ## `cluster_identifier`{% #cluster_identifier %} **Type**: `STRING`**Provider name**: `ClusterIdentifier`**Description**: The unique identifier of the cluster. ## `cluster_logging`{% #cluster_logging %} **Type**: `STRUCT`**Provider name**: `LoggingStatus` - `bucket_name`**Type**: `STRING`**Provider name**: `BucketName`**Description**: The name of the S3 bucket where the log files are stored. - `last_failure_message`**Type**: `STRING`**Provider name**: `LastFailureMessage`**Description**: The message indicating that logs failed to be delivered. - `last_failure_time`**Type**: `TIMESTAMP`**Provider name**: `LastFailureTime`**Description**: The last time when logs failed to be delivered. - `last_successful_delivery_time`**Type**: `TIMESTAMP`**Provider name**: `LastSuccessfulDeliveryTime`**Description**: The last time that logs were delivered. - `log_destination_type`**Type**: `STRING`**Provider name**: `LogDestinationType`**Description**: The log destination type. An enum with possible values of `s3` and `cloudwatch`. - `log_exports`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `LogExports`**Description**: The collection of exported log types. Possible values are `connectionlog`, `useractivitylog`, and `userlog`. - `logging_enabled`**Type**: `BOOLEAN`**Provider name**: `LoggingEnabled`**Description**: `true` if logging is on, `false` if logging is off. - `s3_key_prefix`**Type**: `STRING`**Provider name**: `S3KeyPrefix`**Description**: The prefix applied to the log file names. ## `cluster_namespace_arn`{% #cluster_namespace_arn %} **Type**: `STRING`**Provider name**: `ClusterNamespaceArn`**Description**: The namespace Amazon Resource Name (ARN) of the cluster. ## `cluster_nodes`{% #cluster_nodes %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ClusterNodes`**Description**: The nodes in the cluster. - `node_role`**Type**: `STRING`**Provider name**: `NodeRole`**Description**: Whether the node is a leader node or a compute node. - `private_ip_address`**Type**: `STRING`**Provider name**: `PrivateIPAddress`**Description**: The private IP address of a node within a cluster. - `public_ip_address`**Type**: `STRING`**Provider name**: `PublicIPAddress`**Description**: The public IP address of a node within a cluster. ## `cluster_parameter_groups`{% #cluster_parameter_groups %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ClusterParameterGroups`**Description**: The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status. - `cluster_parameter_status_list`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ClusterParameterStatusList`**Description**: The list of parameter statuses. For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide. - `parameter_apply_error_description`**Type**: `STRING`**Provider name**: `ParameterApplyErrorDescription`**Description**: The error that prevented the parameter from being applied to the database. - `parameter_apply_status`**Type**: `STRING`**Provider name**: `ParameterApplyStatus`**Description**: The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied. The following are possible statuses and descriptions. - `in-sync`: The parameter value is in sync with the database. - `pending-reboot`: The parameter value will be applied after the cluster reboots. - `applying`: The parameter value is being applied to the database. - `invalid-parameter`: Cannot apply the parameter value because it has an invalid value or syntax. - `apply-deferred`: The parameter contains static property changes. The changes are deferred until the cluster reboots. - `apply-error`: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots. - `unknown-error`: Cannot apply the parameter change right now. The change will be applied after the cluster reboots. - `parameter_name`**Type**: `STRING`**Provider name**: `ParameterName`**Description**: The name of the parameter. - `parameter_apply_status`**Type**: `STRING`**Provider name**: `ParameterApplyStatus`**Description**: The status of parameter updates. - `parameter_group_name`**Type**: `STRING`**Provider name**: `ParameterGroupName`**Description**: The name of the cluster parameter group. ## `cluster_public_key`{% #cluster_public_key %} **Type**: `STRING`**Provider name**: `ClusterPublicKey`**Description**: The public key for the cluster. ## `cluster_revision_number`{% #cluster_revision_number %} **Type**: `STRING`**Provider name**: `ClusterRevisionNumber`**Description**: The specific revision number of the database in the cluster. ## `cluster_security_groups`{% #cluster_security_groups %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ClusterSecurityGroups`**Description**: A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains `ClusterSecurityGroup.Name` and `ClusterSecurityGroup.Status` subelements. Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter. - `cluster_security_group_name`**Type**: `STRING`**Provider name**: `ClusterSecurityGroupName`**Description**: The name of the cluster security group. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The status of the cluster security group. ## `cluster_snapshot_copy_status`{% #cluster_snapshot_copy_status %} **Type**: `STRUCT`**Provider name**: `ClusterSnapshotCopyStatus`**Description**: A value that returns the destination region and retention period that are configured for cross-region snapshot copy. - `destination_region`**Type**: `STRING`**Provider name**: `DestinationRegion`**Description**: The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. - `manual_snapshot_retention_period`**Type**: `INT32`**Provider name**: `ManualSnapshotRetentionPeriod`**Description**: The number of days that automated snapshots are retained in the destination region after they are copied from a source 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. - `retention_period`**Type**: `INT64`**Provider name**: `RetentionPeriod`**Description**: The number of days that automated snapshots are retained in the destination region after they are copied from a source region. - `snapshot_copy_grant_name`**Type**: `STRING`**Provider name**: `SnapshotCopyGrantName`**Description**: The name of the snapshot copy grant. ## `cluster_status`{% #cluster_status %} **Type**: `STRING`**Provider name**: `ClusterStatus`**Description**: The current state of the cluster. Possible values are the following: - `available` - `available, prep-for-resize` - `available, resize-cleanup` - `cancelling-resize` - `creating` - `deleting` - `final-snapshot` - `hardware-failure` - `incompatible-hsm` - `incompatible-network` - `incompatible-parameters` - `incompatible-restore` - `modifying` - `paused` - `rebooting` - `renaming` - `resizing` - `rotating-keys` - `storage-full` - `updating-hsm` ## `cluster_subnet_group_name`{% #cluster_subnet_group_name %} **Type**: `STRING`**Provider name**: `ClusterSubnetGroupName`**Description**: The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC. ## `cluster_version`{% #cluster_version %} **Type**: `STRING`**Provider name**: `ClusterVersion`**Description**: The version ID of the Amazon Redshift engine that is running on the cluster. ## `custom_domain_certificate_arn`{% #custom_domain_certificate_arn %} **Type**: `STRING`**Provider name**: `CustomDomainCertificateArn`**Description**: The certificate Amazon Resource Name (ARN) for the custom domain name. ## `custom_domain_certificate_expiry_date`{% #custom_domain_certificate_expiry_date %} **Type**: `TIMESTAMP`**Provider name**: `CustomDomainCertificateExpiryDate`**Description**: The expiration date for the certificate associated with the custom domain name. ## `custom_domain_name`{% #custom_domain_name %} **Type**: `STRING`**Provider name**: `CustomDomainName`**Description**: The custom domain name associated with the cluster. ## `data_transfer_progress`{% #data_transfer_progress %} **Type**: `STRUCT`**Provider name**: `DataTransferProgress`**Description**: - `current_rate_in_mega_bytes_per_second`**Type**: `DOUBLE`**Provider name**: `CurrentRateInMegaBytesPerSecond`**Description**: Describes the data transfer rate in MB's per second. - `data_transferred_in_mega_bytes`**Type**: `INT64`**Provider name**: `DataTransferredInMegaBytes`**Description**: Describes the total amount of data that has been transfered in MB's. - `elapsed_time_in_seconds`**Type**: `INT64`**Provider name**: `ElapsedTimeInSeconds`**Description**: Describes the number of seconds that have elapsed during the data transfer. - `estimated_time_to_completion_in_seconds`**Type**: `INT64`**Provider name**: `EstimatedTimeToCompletionInSeconds`**Description**: Describes the estimated number of seconds remaining to complete the transfer. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: Describes the status of the cluster. While the transfer is in progress the status is `transferringdata`. - `total_data_in_mega_bytes`**Type**: `INT64`**Provider name**: `TotalDataInMegaBytes`**Description**: Describes the total amount of data to be transfered in megabytes. ## `db_name`{% #db_name %} **Type**: `STRING`**Provider name**: `DBName`**Description**: The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named `dev`dev was created by default. ## `default_iam_role_arn`{% #default_iam_role_arn %} **Type**: `STRING`**Provider name**: `DefaultIamRoleArn`**Description**: The Amazon Resource Name (ARN) for the IAM role set as default for the cluster. ## `deferred_maintenance_windows`{% #deferred_maintenance_windows %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `DeferredMaintenanceWindows`**Description**: Describes a group of `DeferredMaintenanceWindow` objects. - `defer_maintenance_end_time`**Type**: `TIMESTAMP`**Provider name**: `DeferMaintenanceEndTime`**Description**: A timestamp for the end of the time period when we defer maintenance. - `defer_maintenance_identifier`**Type**: `STRING`**Provider name**: `DeferMaintenanceIdentifier`**Description**: A unique identifier for the maintenance window. - `defer_maintenance_start_time`**Type**: `TIMESTAMP`**Provider name**: `DeferMaintenanceStartTime`**Description**: A timestamp for the beginning of the time period when we defer maintenance. ## `elastic_ip_status`{% #elastic_ip_status %} **Type**: `STRUCT`**Provider name**: `ElasticIpStatus`**Description**: The status of the elastic IP (EIP) address. - `elastic_ip`**Type**: `STRING`**Provider name**: `ElasticIp`**Description**: The elastic IP (EIP) address for the cluster. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The status of the elastic IP (EIP) address. ## `elastic_resize_number_of_node_options`{% #elastic_resize_number_of_node_options %} **Type**: `STRING`**Provider name**: `ElasticResizeNumberOfNodeOptions`**Description**: The number of nodes that you can resize the cluster to with the elastic resize method. ## `encrypted`{% #encrypted %} **Type**: `BOOLEAN`**Provider name**: `Encrypted`**Description**: A boolean value that, if `true`, indicates that data in the cluster is encrypted at rest. ## `endpoint`{% #endpoint %} **Type**: `STRUCT`**Provider name**: `Endpoint`**Description**: The connection endpoint. - `address`**Type**: `STRING`**Provider name**: `Address`**Description**: The DNS address of the Cluster. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: The port that the database engine is listening on. - `vpc_endpoints`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `VpcEndpoints`**Description**: Describes a connection endpoint. - `network_interfaces`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `NetworkInterfaces`**Description**: One or more network interfaces of the endpoint. Also known as an interface endpoint. - `availability_zone`**Type**: `STRING`**Provider name**: `AvailabilityZone`**Description**: The Availability Zone. - `ipv6_address`**Type**: `STRING`**Provider name**: `Ipv6Address`**Description**: The IPv6 address of the network interface within the subnet. - `network_interface_id`**Type**: `STRING`**Provider name**: `NetworkInterfaceId`**Description**: The network interface identifier. - `private_ip_address`**Type**: `STRING`**Provider name**: `PrivateIpAddress`**Description**: The IPv4 address of the network interface within the subnet. - `subnet_id`**Type**: `STRING`**Provider name**: `SubnetId`**Description**: The subnet identifier. - `vpc_endpoint_id`**Type**: `STRING`**Provider name**: `VpcEndpointId`**Description**: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. - `vpc_id`**Type**: `STRING`**Provider name**: `VpcId`**Description**: The VPC identifier that the endpoint is associated. ## `endpoint_access_list`{% #endpoint_access_list %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `EndpointAccessList`**Description**: The list of endpoints with access to the cluster. - `address`**Type**: `STRING`**Provider name**: `Address`**Description**: The DNS address of the endpoint. - `cluster_identifier`**Type**: `STRING`**Provider name**: `ClusterIdentifier`**Description**: The cluster identifier of the cluster associated with the endpoint. - `endpoint_create_time`**Type**: `TIMESTAMP`**Provider name**: `EndpointCreateTime`**Description**: The time (UTC) that the endpoint was created. - `endpoint_name`**Type**: `STRING`**Provider name**: `EndpointName`**Description**: The name of the endpoint. - `endpoint_status`**Type**: `STRING`**Provider name**: `EndpointStatus`**Description**: The status of the endpoint. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: The port number on which the cluster accepts incoming connections. - `resource_owner`**Type**: `STRING`**Provider name**: `ResourceOwner`**Description**: The Amazon Web Services account ID of the owner of the cluster. - `subnet_group_name`**Type**: `STRING`**Provider name**: `SubnetGroupName`**Description**: The subnet group name where Amazon Redshift chooses to deploy the endpoint. - `vpc_endpoint`**Type**: `STRUCT`**Provider name**: `VpcEndpoint` - `network_interfaces`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `NetworkInterfaces`**Description**: One or more network interfaces of the endpoint. Also known as an interface endpoint. - `availability_zone`**Type**: `STRING`**Provider name**: `AvailabilityZone`**Description**: The Availability Zone. - `ipv6_address`**Type**: `STRING`**Provider name**: `Ipv6Address`**Description**: The IPv6 address of the network interface within the subnet. - `network_interface_id`**Type**: `STRING`**Provider name**: `NetworkInterfaceId`**Description**: The network interface identifier. - `private_ip_address`**Type**: `STRING`**Provider name**: `PrivateIpAddress`**Description**: The IPv4 address of the network interface within the subnet. - `subnet_id`**Type**: `STRING`**Provider name**: `SubnetId`**Description**: The subnet identifier. - `vpc_endpoint_id`**Type**: `STRING`**Provider name**: `VpcEndpointId`**Description**: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. - `vpc_id`**Type**: `STRING`**Provider name**: `VpcId`**Description**: The VPC identifier that the endpoint is associated. - `vpc_security_groups`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `VpcSecurityGroups`**Description**: The security groups associated with the endpoint. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The status of the VPC security group. - `vpc_security_group_id`**Type**: `STRING`**Provider name**: `VpcSecurityGroupId`**Description**: The identifier of the VPC security group. ## `enhanced_vpc_routing`{% #enhanced_vpc_routing %} **Type**: `BOOLEAN`**Provider name**: `EnhancedVpcRouting`**Description**: 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](https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide. If this option is `true`, enhanced VPC routing is enabled.**Default**: false ## `expected_next_snapshot_schedule_time`{% #expected_next_snapshot_schedule_time %} **Type**: `TIMESTAMP`**Provider name**: `ExpectedNextSnapshotScheduleTime`**Description**: The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. ## `expected_next_snapshot_schedule_time_status`{% #expected_next_snapshot_schedule_time_status %} **Type**: `STRING`**Provider name**: `ExpectedNextSnapshotScheduleTimeStatus`**Description**: The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following: - OnTrack - The next snapshot is expected to be taken on time. - Pending - The next snapshot is pending to be taken. ## `hsm_status`{% #hsm_status %} **Type**: `STRUCT`**Provider name**: `HsmStatus`**Description**: A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command. Values: active, applying - `hsm_client_certificate_identifier`**Type**: `STRING`**Provider name**: `HsmClientCertificateIdentifier`**Description**: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. - `hsm_configuration_identifier`**Type**: `STRING`**Provider name**: `HsmConfigurationIdentifier`**Description**: 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. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Values: active, applying ## `iam_roles`{% #iam_roles %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `IamRoles`**Description**: A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. - `apply_status`**Type**: `STRING`**Provider name**: `ApplyStatus`**Description**: A value that describes the status of the IAM role's association with an Amazon Redshift cluster. The following are possible statuses and descriptions. - `in-sync`: The role is available for use by the cluster. - `adding`: The role is in the process of being associated with the cluster. - `removing`: The role is in the process of being disassociated with the cluster. - `iam_role_arn`**Type**: `STRING`**Provider name**: `IamRoleArn`**Description**: The Amazon Resource Name (ARN) of the IAM role, for example, `arn:aws:iam::123456789012:role/RedshiftCopyUnload`. ## `ip_address_type`{% #ip_address_type %} **Type**: `STRING`**Provider name**: `IpAddressType`**Description**: The IP address type for the cluster. Possible values are `ipv4` and `dualstack`. ## `kms_key_id`{% #kms_key_id %} **Type**: `STRING`**Provider name**: `KmsKeyId`**Description**: The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster. ## `maintenance_track_name`{% #maintenance_track_name %} **Type**: `STRING`**Provider name**: `MaintenanceTrackName`**Description**: The name of the maintenance track for the cluster. ## `manual_snapshot_retention_period`{% #manual_snapshot_retention_period %} **Type**: `INT32`**Provider name**: `ManualSnapshotRetentionPeriod`**Description**: The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653. ## `master_password_secret_arn`{% #master_password_secret_arn %} **Type**: `STRING`**Provider name**: `MasterPasswordSecretArn`**Description**: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. ## `master_password_secret_kms_key_id`{% #master_password_secret_kms_key_id %} **Type**: `STRING`**Provider name**: `MasterPasswordSecretKmsKeyId`**Description**: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. ## `master_username`{% #master_username %} **Type**: `STRING`**Provider name**: `MasterUsername`**Description**: The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter. ## `modify_status`{% #modify_status %} **Type**: `STRING`**Provider name**: `ModifyStatus`**Description**: The status of a modify operation, if any, initiated for the cluster. ## `multi_az`{% #multi_az %} **Type**: `STRING`**Provider name**: `MultiAZ`**Description**: A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones. ## `multi_az_secondary`{% #multi_az_secondary %} **Type**: `STRUCT`**Provider name**: `MultiAZSecondary`**Description**: The secondary compute unit of a cluster, if Multi-AZ deployment is turned on. - `availability_zone`**Type**: `STRING`**Provider name**: `AvailabilityZone`**Description**: The name of the Availability Zone in which the secondary compute unit of the cluster is located. - `cluster_nodes`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ClusterNodes`**Description**: The nodes in the secondary compute unit. - `node_role`**Type**: `STRING`**Provider name**: `NodeRole`**Description**: Whether the node is a leader node or a compute node. - `private_ip_address`**Type**: `STRING`**Provider name**: `PrivateIPAddress`**Description**: The private IP address of a node within a cluster. - `public_ip_address`**Type**: `STRING`**Provider name**: `PublicIPAddress`**Description**: The public IP address of a node within a cluster. ## `next_maintenance_window_start_time`{% #next_maintenance_window_start_time %} **Type**: `TIMESTAMP`**Provider name**: `NextMaintenanceWindowStartTime`**Description**: The date and time in UTC when system maintenance can begin. ## `node_type`{% #node_type %} **Type**: `STRING`**Provider name**: `NodeType`**Description**: The node type for the nodes in the cluster. ## `number_of_nodes`{% #number_of_nodes %} **Type**: `INT32`**Provider name**: `NumberOfNodes`**Description**: The number of compute nodes in the cluster. ## `parameters`{% #parameters %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Parameters`**Description**: A list of Parameter instances. Each instance lists the parameters of one cluster parameter group. - `allowed_values`**Type**: `STRING`**Provider name**: `AllowedValues`**Description**: The valid range of values for the parameter. - `apply_type`**Type**: `STRING`**Provider name**: `ApplyType`**Description**: Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide. - `data_type`**Type**: `STRING`**Provider name**: `DataType`**Description**: The data type of the parameter. - `description`**Type**: `STRING`**Provider name**: `Description`**Description**: A description of the parameter. - `is_modifiable`**Type**: `BOOLEAN`**Provider name**: `IsModifiable`**Description**: If `true`, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. - `minimum_engine_version`**Type**: `STRING`**Provider name**: `MinimumEngineVersion`**Description**: The earliest engine version to which the parameter can apply. - `parameter_name`**Type**: `STRING`**Provider name**: `ParameterName`**Description**: The name of the parameter. - `parameter_value`**Type**: `STRING`**Provider name**: `ParameterValue`**Description**: The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters. - `source`**Type**: `STRING`**Provider name**: `Source`**Description**: The source of the parameter value, such as "engine-default" or "user". ## `pending_actions`{% #pending_actions %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `PendingActions`**Description**: Cluster operations that are waiting to be started. ## `pending_modified_values`{% #pending_modified_values %} **Type**: `STRUCT`**Provider name**: `PendingModifiedValues`**Description**: A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements. - `automated_snapshot_retention_period`**Type**: `INT32`**Provider name**: `AutomatedSnapshotRetentionPeriod`**Description**: The pending or in-progress change of the automated snapshot retention period. - `cluster_identifier`**Type**: `STRING`**Provider name**: `ClusterIdentifier`**Description**: The pending or in-progress change of the new identifier for the cluster. - `cluster_type`**Type**: `STRING`**Provider name**: `ClusterType`**Description**: The pending or in-progress change of the cluster type. - `cluster_version`**Type**: `STRING`**Provider name**: `ClusterVersion`**Description**: The pending or in-progress change of the service version. - `encryption_type`**Type**: `STRING`**Provider name**: `EncryptionType`**Description**: The encryption type for a cluster. Possible values are: KMS and None. - `enhanced_vpc_routing`**Type**: `BOOLEAN`**Provider name**: `EnhancedVpcRouting`**Description**: 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](https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide. If this option is `true`, enhanced VPC routing is enabled.**Default**: false - `maintenance_track_name`**Type**: `STRING`**Provider name**: `MaintenanceTrackName`**Description**: The name of the maintenance track that the cluster will change to during the next maintenance window. - `master_user_password`**Type**: `STRING`**Provider name**: `MasterUserPassword`**Description**: The pending or in-progress change of the admin user password for the cluster. - `node_type`**Type**: `STRING`**Provider name**: `NodeType`**Description**: The pending or in-progress change of the cluster's node type. - `number_of_nodes`**Type**: `INT32`**Provider name**: `NumberOfNodes`**Description**: The pending or in-progress change of the number of nodes in the cluster. - `publicly_accessible`**Type**: `BOOLEAN`**Provider name**: `PubliclyAccessible`**Description**: The pending or in-progress change of the ability to connect to the cluster from the public network. ## `preferred_maintenance_window`{% #preferred_maintenance_window %} **Type**: `STRING`**Provider name**: `PreferredMaintenanceWindow`**Description**: The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. ## `publicly_accessible`{% #publicly_accessible %} **Type**: `BOOLEAN`**Provider name**: `PubliclyAccessible`**Description**: A boolean value that, if `true`, indicates that the cluster can be accessed from a public network. ## `redshift_cluster_arn`{% #redshift_cluster_arn %} **Type**: `STRING` ## `reserved_node_exchange_status`{% #reserved_node_exchange_status %} **Type**: `STRUCT`**Provider name**: `ReservedNodeExchangeStatus`**Description**: The status of the reserved-node exchange request. Statuses include in-progress and requested. - `request_time`**Type**: `TIMESTAMP`**Provider name**: `RequestTime`**Description**: A date and time that indicate when the reserved-node exchange was requested. - `reserved_node_exchange_request_id`**Type**: `STRING`**Provider name**: `ReservedNodeExchangeRequestId`**Description**: The identifier of the reserved-node exchange request. - `source_reserved_node_count`**Type**: `INT32`**Provider name**: `SourceReservedNodeCount`**Description**: The source reserved-node count in the cluster. - `source_reserved_node_id`**Type**: `STRING`**Provider name**: `SourceReservedNodeId`**Description**: The identifier of the source reserved node. - `source_reserved_node_type`**Type**: `STRING`**Provider name**: `SourceReservedNodeType`**Description**: The source reserved-node type, for example ds2.xlarge. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The status of the reserved-node exchange request. Statuses include in-progress and requested. - `target_reserved_node_count`**Type**: `INT32`**Provider name**: `TargetReservedNodeCount`**Description**: The count of target reserved nodes in the cluster. - `target_reserved_node_offering_id`**Type**: `STRING`**Provider name**: `TargetReservedNodeOfferingId`**Description**: The identifier of the target reserved node offering. - `target_reserved_node_type`**Type**: `STRING`**Provider name**: `TargetReservedNodeType`**Description**: The node type of the target reserved node, for example ra3.4xlarge. ## `resize_info`{% #resize_info %} **Type**: `STRUCT`**Provider name**: `ResizeInfo`**Description**: Returns the following: - AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. - ResizeType: Returns ClassicResize - `allow_cancel_resize`**Type**: `BOOLEAN`**Provider name**: `AllowCancelResize`**Description**: A boolean value indicating if the resize operation can be cancelled. - `resize_type`**Type**: `STRING`**Provider name**: `ResizeType`**Description**: Returns the value `ClassicResize`. ## `restore_status`{% #restore_status %} **Type**: `STRUCT`**Provider name**: `RestoreStatus`**Description**: A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot. - `current_restore_rate_in_mega_bytes_per_second`**Type**: `DOUBLE`**Provider name**: `CurrentRestoreRateInMegaBytesPerSecond`**Description**: The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types. - `elapsed_time_in_seconds`**Type**: `INT64`**Provider name**: `ElapsedTimeInSeconds`**Description**: The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types. - `estimated_time_to_completion_in_seconds`**Type**: `INT64`**Provider name**: `EstimatedTimeToCompletionInSeconds`**Description**: The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types. - `progress_in_mega_bytes`**Type**: `INT64`**Provider name**: `ProgressInMegaBytes`**Description**: The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types. - `snapshot_size_in_mega_bytes`**Type**: `INT64`**Provider name**: `SnapshotSizeInMegaBytes`**Description**: The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The status of the restore action. Returns starting, restoring, completed, or failed. ## `snapshot_schedule_identifier`{% #snapshot_schedule_identifier %} **Type**: `STRING`**Provider name**: `SnapshotScheduleIdentifier`**Description**: A unique identifier for the cluster snapshot schedule. ## `snapshot_schedule_state`{% #snapshot_schedule_state %} **Type**: `STRING`**Provider name**: `SnapshotScheduleState`**Description**: The current state of the cluster snapshot schedule. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `total_storage_capacity_in_mega_bytes`{% #total_storage_capacity_in_mega_bytes %} **Type**: `INT64`**Provider name**: `TotalStorageCapacityInMegaBytes`**Description**: The total storage capacity of the cluster in megabytes. ## `vpc_id`{% #vpc_id %} **Type**: `STRING`**Provider name**: `VpcId`**Description**: The identifier of the VPC the cluster is in, if the cluster is in a VPC. ## `vpc_security_groups`{% #vpc_security_groups %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `VpcSecurityGroups`**Description**: A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The status of the VPC security group. - `vpc_security_group_id`**Type**: `STRING`**Provider name**: `VpcSecurityGroupId`**Description**: The identifier of the VPC security group.