cluster
Gets an individual cluster resource
Overview
| Name | cluster |
| Type | Resource |
| Description | cluster |
| Id | awscc.redshift.cluster |
Fields
| Name | Datatype | Description |
|---|---|---|
cluster_identifier | 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 |
cluster_namespace_arn | string | The Amazon Resource Name (ARN) of the cluster namespace. |
master_username | 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. |
master_user_password | string | The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. |
node_type | 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 |
allow_version_upgrade | boolean | Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True |
automated_snapshot_retention_period | integer | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 |
availability_zone | 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 |
cluster_parameter_group_name | string | The name of the parameter group to be associated with this cluster. |
cluster_type | 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 |
cluster_version | 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. |
cluster_subnet_group_name | string | The name of a cluster subnet group to be associated with this cluster. |
db_name | 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. |
elastic_ip | string | The Elastic IP (EIP) address for the cluster. |
encrypted | boolean | If true, the data in the cluster is encrypted at rest. |
hsm_client_certificate_identifier | string | 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 | string | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. |
kms_key_id | string | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. |
number_of_nodes | integer | The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. |
port | integer | The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings |
preferred_maintenance_window | string | The weekly time range (in UTC) during which automated cluster maintenance can occur. |
publicly_accessible | boolean | If true, the cluster can be accessed from a public network. |
cluster_security_groups | array | A list of security groups to be associated with this cluster. |
iam_roles | array | 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 |
tags | array | The list of tags for the cluster parameter group. |
vpc_security_group_ids | array | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. |
snapshot_cluster_identifier | string | The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. |
snapshot_identifier | string | The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. |
owner_account | string | |
logging_properties | object | |
endpoint | object | |
destination_region | 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 |
snapshot_copy_retention_period | integer | The number of days to retain automated snapshots in the destination region after they are copied from the source region. <br/><br/> Default is 7. <br/><br/> Constraints: Must be at least 1 and no more than 35. |
snapshot_copy_grant_name | string | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. |
manual_snapshot_retention_period | integer | The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.<br/><br/>The value must be either -1 or an integer between 1 and 3,653. |
snapshot_copy_manual | boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. |
availability_zone_relocation | boolean | The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. |
availability_zone_relocation_status | string | The availability zone relocation status of the cluster |
aqua_configuration_status | string | The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.<br/><br/>enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.<br/>disabled - Don't use AQUA.<br/>auto - Amazon Redshift determines whether to use AQUA.<br/> |
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. |
enhanced_vpc_routing | boolean | An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.<br/><br/>If this option is true , enhanced VPC routing is enabled.<br/><br/>Default: false |
maintenance_track_name | string | The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. |
defer_maintenance | boolean | A boolean indicating whether to enable the deferred maintenance window. |
defer_maintenance_identifier | string | A unique identifier for the deferred maintenance window. |
defer_maintenance_start_time | string | A timestamp indicating the start time for the deferred maintenance window. |
defer_maintenance_end_time | string | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. |
defer_maintenance_duration | integer | An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. |
revision_target | string | The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. |
resource_action | string | The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs |
rotate_encryption_key | boolean | A boolean indicating if we want to rotate Encryption Keys. |
multi_az | 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. |
namespace_resource_policy | object | The namespace resource policy document that will be attached to a Redshift cluster. |
manage_master_password | boolean | A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. |
master_password_secret_kms_key_id | string | The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. |
master_password_secret_arn | string | The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. |
region | string | AWS region. |
Methods
Currently only SELECT is supported for this resource resource.
Example
SELECT
region,
cluster_identifier,
cluster_namespace_arn,
master_username,
master_user_password,
node_type,
allow_version_upgrade,
automated_snapshot_retention_period,
availability_zone,
cluster_parameter_group_name,
cluster_type,
cluster_version,
cluster_subnet_group_name,
db_name,
elastic_ip,
encrypted,
hsm_client_certificate_identifier,
hsm_configuration_identifier,
kms_key_id,
number_of_nodes,
port,
preferred_maintenance_window,
publicly_accessible,
cluster_security_groups,
iam_roles,
tags,
vpc_security_group_ids,
snapshot_cluster_identifier,
snapshot_identifier,
owner_account,
logging_properties,
endpoint,
destination_region,
snapshot_copy_retention_period,
snapshot_copy_grant_name,
manual_snapshot_retention_period,
snapshot_copy_manual,
availability_zone_relocation,
availability_zone_relocation_status,
aqua_configuration_status,
classic,
enhanced_vpc_routing,
maintenance_track_name,
defer_maintenance,
defer_maintenance_identifier,
defer_maintenance_start_time,
defer_maintenance_end_time,
defer_maintenance_duration,
revision_target,
resource_action,
rotate_encryption_key,
multi_az,
namespace_resource_policy,
manage_master_password,
master_password_secret_kms_key_id,
master_password_secret_arn
FROM awscc.redshift.cluster
WHERE data__Identifier = '<ClusterIdentifier>';
Permissions
To operate on the cluster resource, the following permissions are required:
Read
redshift:DescribeClusters,
redshift:DescribeLoggingStatus,
redshift:DescribeSnapshotCopyGrant,
redshift:DescribeClusterDbRevisions,
redshift:DescribeTags,
redshift:GetResourcePolicy
Update
iam:PassRole,
redshift:DescribeClusters,
redshift:ModifyCluster,
redshift:ModifyClusterIamRoles,
redshift:EnableLogging,
redshift:CreateTags,
redshift:DeleteTags,
redshift:DescribeTags,
redshift:DisableLogging,
redshift:DescribeLoggingStatus,
redshift:RebootCluster,
redshift:EnableSnapshotCopy,
redshift:DisableSnapshotCopy,
redshift:ModifySnapshotCopyRetentionPeriod,
redshift:ModifyAquaConfiguration,
redshift:ResizeCluster,
redshift:ModifyClusterMaintenance,
redshift:DescribeClusterDbRevisions,
redshift:ModifyClusterDbRevisions,
redshift:PauseCluster,
redshift:ResumeCluster,
redshift:RotateEncryptionKey,
redshift:FailoverPrimaryCompute,
redshift:PutResourcePolicy,
redshift:GetResourcePolicy,
redshift:DeleteResourcePolicy,
cloudwatch:PutMetricData
Delete
redshift:DescribeTags,
redshift:DescribeClusters,
redshift:DeleteCluster