Cluster ¶

class Cluster(TypedDict, closed=True):
    cluster_identifier: NotRequired["capo_redshift.types.string.String"]
    """<p>The unique identifier of the cluster.</p>"""
    node_type: NotRequired["capo_redshift.types.string.String"]
    """<p>The node type for the nodes in the cluster.</p>"""
    cluster_status: NotRequired["capo_redshift.types.string.String"]
    """<p> The current state of the cluster. Possible values are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>available, prep-for-resize</code> </p> </li> <li> <p> <code>available, resize-cleanup</code> </p> </li> <li> <p> <code>cancelling-resize</code> </p> </li> <li> <p> <code>creating</code> </p> </li> <li> <p> <code>deleting</code> </p> </li> <li> <p> <code>final-snapshot</code> </p> </li> <li> <p> <code>hardware-failure</code> </p> </li> <li> <p> <code>incompatible-hsm</code> </p> </li> <li> <p> <code>incompatible-network</code> </p> </li> <li> <p> <code>incompatible-parameters</code> </p> </li> <li> <p> <code>incompatible-restore</code> </p> </li> <li> <p> <code>modifying</code> </p> </li> <li> <p> <code>paused</code> </p> </li> <li> <p> <code>rebooting</code> </p> </li> <li> <p> <code>renaming</code> </p> </li> <li> <p> <code>resizing</code> </p> </li> <li> <p> <code>rotating-keys</code> </p> </li> <li> <p> <code>storage-full</code> </p> </li> <li> <p> <code>updating-hsm</code> </p> </li> </ul>"""
    cluster_availability_status: NotRequired["capo_redshift.types.string.String"]
    """<p>The availability status of the cluster for queries. Possible values are the following:</p> <ul> <li> <p>Available - The cluster is available for queries. </p> </li> <li> <p>Unavailable - The cluster is not available for queries.</p> </li> <li> <p>Maintenance - The cluster is intermittently available for queries due to maintenance activities.</p> </li> <li> <p>Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.</p> </li> <li> <p>Failed - The cluster failed and is not available for queries.</p> </li> </ul>"""
    modify_status: NotRequired["capo_redshift.types.string.String"]
    """<p>The status of a modify operation, if any, initiated for the cluster.</p>"""
    master_username: NotRequired["capo_redshift.types.string.String"]
    """<p>The admin user name for the cluster. This name is used to connect to the database that is specified in the <b>DBName</b> parameter. </p>"""
    db_name: NotRequired["capo_redshift.types.string.String"]
    """<p>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 <code>dev</code>dev was created by default. </p>"""
    endpoint: NotRequired["capo_redshift.types.endpoint.Endpoint"]
    """<p>The connection endpoint.</p>"""
    cluster_create_time: NotRequired["capo_redshift.types.t_stamp.TStamp"]
    """<p>The date and time that the cluster was created.</p>"""
    automated_snapshot_retention_period: NotRequired[
        "capo_redshift.types.integer.Integer"
    ]
    """<p>The number of days that automatic cluster snapshots are retained.</p>"""
    manual_snapshot_retention_period: NotRequired["capo_redshift.types.integer.Integer"]
    """<p>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.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p>"""
    cluster_security_groups: NotRequired[
        "capo_redshift.types.cluster_security_group_membership_list.ClusterSecurityGroupMembershipList"
    ]
    """<p>A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains <code>ClusterSecurityGroup.Name</code> and <code>ClusterSecurityGroup.Status</code> subelements. </p> <p>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 <b>VpcSecurityGroups</b> parameter. </p>"""
    vpc_security_groups: NotRequired[
        "capo_redshift.types.vpc_security_group_membership_list.VpcSecurityGroupMembershipList"
    ]
    """<p>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.</p>"""
    cluster_parameter_groups: NotRequired[
        "capo_redshift.types.cluster_parameter_group_status_list.ClusterParameterGroupStatusList"
    ]
    """<p>The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.</p>"""
    cluster_subnet_group_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.</p>"""
    vpc_id: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of the VPC the cluster is in, if the cluster is in a VPC.</p>"""
    availability_zone: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the Availability Zone in which the cluster is located.</p>"""
    preferred_maintenance_window: NotRequired["capo_redshift.types.string.String"]
    """<p>The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.</p>"""
    pending_modified_values: NotRequired[
        "capo_redshift.types.pending_modified_values.PendingModifiedValues"
    ]
    """<p>A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.</p>"""
    cluster_version: NotRequired["capo_redshift.types.string.String"]
    """<p>The version ID of the Amazon Redshift engine that is running on the cluster.</p>"""
    allow_version_upgrade: NotRequired["capo_redshift.types.boolean.Boolean"]
    """<p>A boolean value that, if <code>true</code>, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. </p>"""
    number_of_nodes: NotRequired["capo_redshift.types.integer.Integer"]
    """<p>The number of compute nodes in the cluster.</p>"""
    publicly_accessible: NotRequired["capo_redshift.types.boolean.Boolean"]
    """<p>A boolean value that, if <code>true</code>, indicates that the cluster can be accessed from a public network.</p> <p>Default: false</p>"""
    encrypted: NotRequired["capo_redshift.types.boolean.Boolean"]
    """<p>A boolean value that, if <code>true</code>, indicates that data in the cluster is encrypted at rest.</p>"""
    restore_status: NotRequired["capo_redshift.types.restore_status.RestoreStatus"]
    """<p>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.</p>"""
    data_transfer_progress: NotRequired[
        "capo_redshift.types.data_transfer_progress.DataTransferProgress"
    ]
    """<p></p>"""
    hsm_status: NotRequired["capo_redshift.types.hsm_status.HsmStatus"]
    """<p>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.</p> <p>Values: active, applying</p>"""
    cluster_snapshot_copy_status: NotRequired[
        "capo_redshift.types.cluster_snapshot_copy_status.ClusterSnapshotCopyStatus"
    ]
    """<p>A value that returns the destination region and retention period that are configured for cross-region snapshot copy.</p>"""
    cluster_public_key: NotRequired["capo_redshift.types.string.String"]
    """<p>The public key for the cluster.</p>"""
    cluster_nodes: NotRequired[
        "capo_redshift.types.cluster_nodes_list.ClusterNodesList"
    ]
    """<p>The nodes in the cluster.</p>"""
    elastic_ip_status: NotRequired[
        "capo_redshift.types.elastic_ip_status.ElasticIpStatus"
    ]
    """<p>The status of the elastic IP (EIP) address.</p>"""
    cluster_revision_number: NotRequired["capo_redshift.types.string.String"]
    """<p>The specific revision number of the database in the cluster.</p>"""
    tags: NotRequired["capo_redshift.types.tag_list.TagList"]
    """<p>The list of tags for the cluster.</p>"""
    kms_key_id: NotRequired["capo_redshift.types.string.String"]
    """<p>The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.</p>"""
    enhanced_vpc_routing: NotRequired["capo_redshift.types.boolean.Boolean"]
    """<p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>"""
    iam_roles: NotRequired[
        "capo_redshift.types.cluster_iam_role_list.ClusterIamRoleList"
    ]
    """<p>A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.</p>"""
    pending_actions: NotRequired[
        "capo_redshift.types.pending_actions_list.PendingActionsList"
    ]
    """<p>Cluster operations that are waiting to be started.</p>"""
    maintenance_track_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the maintenance track for the cluster.</p>"""
    elastic_resize_number_of_node_options: NotRequired[
        "capo_redshift.types.string.String"
    ]
    """<p>The number of nodes that you can resize the cluster to with the elastic resize method. </p>"""
    deferred_maintenance_windows: NotRequired[
        "capo_redshift.types.deferred_maintenance_windows_list.DeferredMaintenanceWindowsList"
    ]
    """<p>Describes a group of <code>DeferredMaintenanceWindow</code> objects.</p>"""
    snapshot_schedule_identifier: NotRequired["capo_redshift.types.string.String"]
    """<p>A unique identifier for the cluster snapshot schedule.</p>"""
    snapshot_schedule_state: NotRequired[
        "capo_redshift.types.schedule_state.ScheduleState"
    ]
    """<p>The current state of the cluster snapshot schedule.</p>"""
    expected_next_snapshot_schedule_time: NotRequired[
        "capo_redshift.types.t_stamp.TStamp"
    ]
    """<p>The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. </p>"""
    expected_next_snapshot_schedule_time_status: NotRequired[
        "capo_redshift.types.string.String"
    ]
    """<p> The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:</p> <ul> <li> <p>OnTrack - The next snapshot is expected to be taken on time. </p> </li> <li> <p>Pending - The next snapshot is pending to be taken. </p> </li> </ul>"""
    next_maintenance_window_start_time: NotRequired[
        "capo_redshift.types.t_stamp.TStamp"
    ]
    """<p>The date and time in UTC when system maintenance can begin.</p>"""
    resize_info: NotRequired["capo_redshift.types.resize_info.ResizeInfo"]
    """<p>Returns the following:</p> <ul> <li> <p>AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.</p> </li> <li> <p>ResizeType: Returns ClassicResize</p> </li> </ul>"""
    availability_zone_relocation_status: NotRequired[
        "capo_redshift.types.string.String"
    ]
    """<p>Describes the status of the Availability Zone relocation operation.</p>"""
    cluster_namespace_arn: NotRequired["capo_redshift.types.string.String"]
    """<p>The namespace Amazon Resource Name (ARN) of the cluster.</p>"""
    total_storage_capacity_in_mega_bytes: NotRequired[
        "capo_redshift.types.long_optional.LongOptional"
    ]
    """<p>The total storage capacity of the cluster in megabytes. </p>"""
    aqua_configuration: NotRequired[
        "capo_redshift.types.aqua_configuration.AquaConfiguration"
    ]
    """<p>This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>"""
    default_iam_role_arn: NotRequired["capo_redshift.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.</p>"""
    reserved_node_exchange_status: NotRequired[
        "capo_redshift.types.reserved_node_exchange_status.ReservedNodeExchangeStatus"
    ]
    """<p>The status of the reserved-node exchange request. Statuses include in-progress and requested.</p>"""
    custom_domain_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The custom domain name associated with the cluster.</p>"""
    custom_domain_certificate_arn: NotRequired["capo_redshift.types.string.String"]
    """<p>The certificate Amazon Resource Name (ARN) for the custom domain name.</p>"""
    custom_domain_certificate_expiry_date: NotRequired[
        "capo_redshift.types.t_stamp.TStamp"
    ]
    """<p>The expiration date for the certificate associated with the custom domain name.</p>"""
    master_password_secret_arn: NotRequired["capo_redshift.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.</p>"""
    master_password_secret_kms_key_id: NotRequired["capo_redshift.types.string.String"]
    """<p>The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.</p>"""
    ip_address_type: NotRequired["capo_redshift.types.string.String"]
    """<p>The IP address type for the cluster. Possible values are <code>ipv4</code> and <code>dualstack</code>.</p>"""
    multi_az: NotRequired["capo_redshift.types.string.String"]
    """<p>A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.</p>"""
    multi_az_secondary: NotRequired[
        "capo_redshift.types.secondary_cluster_info.SecondaryClusterInfo"
    ]
    """<p>The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.</p>"""
    lakehouse_registration_status: NotRequired["capo_redshift.types.string.String"]
    """<p>The status of the lakehouse registration for the cluster. Indicates whether the cluster is successfully registered with Amazon Redshift federated permissions.</p>"""
    catalog_arn: NotRequired["capo_redshift.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Glue data catalog associated with the cluster enabled with Amazon Redshift federated permissions.</p>"""
    extra_compute_for_automatic_optimization: NotRequired[
        "capo_redshift.types.string.String"
    ]
    """<p>A boolean value that, if <code>true</code>, indicates that the cluster allocates additional compute resources to run automatic optimization operations.</p> <p>Default: false</p>"""
    logging_publish_status: NotRequired[
        "capo_redshift.types.logging_publish_status.LoggingPublishStatus"
    ]
    """<p>The status of system table publishing for the cluster. This field is present only when system table publishing is configured.</p>"""