Skip to content

AwsRedshiftClusterDetails

Source code in docs_src/capo_securityhub/types/aws_redshift_cluster_details.py
class AwsRedshiftClusterDetails(TypedDict, closed=True):
    allow_version_upgrade: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.</p>"""
    automated_snapshot_retention_period: NotRequired[
        "capo_securityhub.types.integer.Integer"
    ]
    """<p>The number of days that automatic cluster snapshots are retained.</p>"""
    availability_zone: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the Availability Zone in which the cluster is located.</p>"""
    cluster_availability_status: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The availability status of the cluster for queries. Possible values are the following:</p> <ul> <li> <p> <code>Available</code> - The cluster is available for queries.</p> </li> <li> <p> <code>Unavailable</code> - The cluster is not available for queries.</p> </li> <li> <p> <code>Maintenance</code> - The cluster is intermittently available for queries due to maintenance activities.</p> </li> <li> <p> <code>Modifying</code> -The cluster is intermittently available for queries due to changes that modify the cluster.</p> </li> <li> <p> <code>Failed</code> - The cluster failed and is not available for queries.</p> </li> </ul>"""
    cluster_create_time: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates when the cluster was created.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    cluster_identifier: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The unique identifier of the cluster.</p>"""
    cluster_nodes: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_cluster_nodes.AwsRedshiftClusterClusterNodes"
    ]
    """<p>The nodes in the cluster.</p>"""
    cluster_parameter_groups: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_cluster_parameter_groups.AwsRedshiftClusterClusterParameterGroups"
    ]
    """<p>The list of cluster parameter groups that are associated with this cluster.</p>"""
    cluster_public_key: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The public key for the cluster.</p>"""
    cluster_revision_number: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The specific revision number of the database in the cluster.</p>"""
    cluster_security_groups: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_cluster_security_groups.AwsRedshiftClusterClusterSecurityGroups"
    ]
    """<p>A list of cluster security groups that are associated with the cluster.</p>"""
    cluster_snapshot_copy_status: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_cluster_snapshot_copy_status.AwsRedshiftClusterClusterSnapshotCopyStatus"
    ]
    """<p>Information about the destination Region and retention period for the cross-Region snapshot copy.</p>"""
    cluster_status: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The current status of the cluster.</p> <p>Valid values: <code>available</code> | <code>available, prep-for-resize</code> | <code>available, resize-cleanup</code> |<code> cancelling-resize</code> | <code>creating</code> | <code>deleting</code> | <code>final-snapshot</code> | <code>hardware-failure</code> | <code>incompatible-hsm</code> |<code> incompatible-network</code> | <code>incompatible-parameters</code> | <code>incompatible-restore</code> | <code>modifying</code> | <code>paused</code> | <code>rebooting</code> | <code>renaming</code> | <code>resizing</code> | <code>rotating-keys</code> | <code>storage-full</code> | <code>updating-hsm</code> </p>"""
    cluster_subnet_group_name: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<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>"""
    cluster_version: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The version ID of the Amazon Redshift engine that runs on the cluster.</p>"""
    db_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the initial database that was created when the cluster was created.</p> <p>The same name is returned for the life of the cluster.</p> <p>If an initial database is not specified, a database named <code>devdev</code> is created by default.</p>"""
    deferred_maintenance_windows: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_deferred_maintenance_windows.AwsRedshiftClusterDeferredMaintenanceWindows"
    ]
    """<p>List of time windows during which maintenance was deferred.</p>"""
    elastic_ip_status: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_elastic_ip_status.AwsRedshiftClusterElasticIpStatus"
    ]
    """<p>Information about the status of the Elastic IP (EIP) address.</p>"""
    elastic_resize_number_of_node_options: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The number of nodes that you can use the elastic resize method to resize the cluster to.</p>"""
    encrypted: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether the data in the cluster is encrypted at rest.</p>"""
    endpoint: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_endpoint.AwsRedshiftClusterEndpoint"
    ]
    """<p>The connection endpoint.</p>"""
    enhanced_vpc_routing: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether to create the cluster with enhanced VPC routing enabled.</p>"""
    expected_next_snapshot_schedule_time: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    expected_next_snapshot_schedule_time_status: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The status of the next expected snapshot.</p> <p>Valid values: <code>OnTrack</code> | <code>Pending</code> </p>"""
    hsm_status: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_hsm_status.AwsRedshiftClusterHsmStatus"
    ]
    """<p>Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.</p>"""
    iam_roles: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_iam_roles.AwsRedshiftClusterIamRoles"
    ]
    """<p>A list of IAM roles that the cluster can use to access other Amazon Web Services services.</p>"""
    kms_key_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The identifier of the KMS encryption key that is used to encrypt data in the cluster.</p>"""
    maintenance_track_name: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the maintenance track for the cluster.</p>"""
    manual_snapshot_retention_period: NotRequired[
        "capo_securityhub.types.integer.Integer"
    ]
    """<p>The default number of days to retain a manual snapshot.</p> <p>If the value is <code>-1</code>, the snapshot is retained indefinitely.</p> <p>This setting doesn't change the retention period of existing snapshots.</p> <p>Valid values: Either <code>-1</code> or an integer between 1 and 3,653</p>"""
    master_username: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The master user name for the cluster. This name is used to connect to the database that is specified in as the value of <code>DBName</code>.</p>"""
    next_maintenance_window_start_time: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates the start of the next maintenance window.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    node_type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The node type for the nodes in the cluster.</p>"""
    number_of_nodes: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The number of compute nodes in the cluster.</p>"""
    pending_actions: NotRequired["capo_securityhub.types.string_list.StringList"]
    """<p>A list of cluster operations that are waiting to start.</p>"""
    pending_modified_values: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_pending_modified_values.AwsRedshiftClusterPendingModifiedValues"
    ]
    """<p>A list of changes to the cluster that are currently pending.</p>"""
    preferred_maintenance_window: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.</p> <p>Format: <code> <i><day></i>:HH:MM-<i><day></i>:HH:MM</code> </p> <p>For the day values, use <code>mon</code> | <code>tue</code> | <code>wed</code> | <code>thu</code> | <code>fri</code> | <code>sat</code> | <code>sun</code> </p> <p>For example, <code>sun:09:32-sun:10:02</code> </p>"""
    publicly_accessible: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the cluster can be accessed from a public network.</p>"""
    resize_info: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_resize_info.AwsRedshiftClusterResizeInfo"
    ]
    """<p>Information about the resize operation for the cluster.</p>"""
    restore_status: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_restore_status.AwsRedshiftClusterRestoreStatus"
    ]
    """<p>Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.</p>"""
    snapshot_schedule_identifier: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>A unique identifier for the cluster snapshot schedule.</p>"""
    snapshot_schedule_state: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The current state of the cluster snapshot schedule.</p> <p>Valid values: <code>MODIFYING</code> | <code>ACTIVE</code> | <code>FAILED</code> </p>"""
    vpc_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The identifier of the VPC that the cluster is in, if the cluster is in a VPC.</p>"""
    vpc_security_groups: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_vpc_security_groups.AwsRedshiftClusterVpcSecurityGroups"
    ]
    """<p>The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.</p>"""
    logging_status: NotRequired[
        "capo_securityhub.types.aws_redshift_cluster_logging_status.AwsRedshiftClusterLoggingStatus"
    ]
    """<p>Information about the logging status of the cluster.</p>"""

allow_version_upgrade instance-attribute

allow_version_upgrade: NotRequired[Boolean]

Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.

automated_snapshot_retention_period instance-attribute

automated_snapshot_retention_period: NotRequired[Integer]

The number of days that automatic cluster snapshots are retained.

availability_zone instance-attribute

availability_zone: NotRequired[NonEmptyString]

The name of the Availability Zone in which the cluster is located.

cluster_availability_status instance-attribute

cluster_availability_status: NotRequired[NonEmptyString]

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 instance-attribute

cluster_create_time: NotRequired[NonEmptyString]

Indicates when the cluster was created.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

cluster_identifier instance-attribute

cluster_identifier: NotRequired[NonEmptyString]

The unique identifier of the cluster.

cluster_nodes instance-attribute

cluster_nodes: NotRequired[AwsRedshiftClusterClusterNodes]

The nodes in the cluster.

cluster_parameter_groups instance-attribute

cluster_parameter_groups: NotRequired[AwsRedshiftClusterClusterParameterGroups]

The list of cluster parameter groups that are associated with this cluster.

cluster_public_key instance-attribute

cluster_public_key: NotRequired[NonEmptyString]

The public key for the cluster.

cluster_revision_number instance-attribute

cluster_revision_number: NotRequired[NonEmptyString]

The specific revision number of the database in the cluster.

cluster_security_groups instance-attribute

cluster_security_groups: NotRequired[AwsRedshiftClusterClusterSecurityGroups]

A list of cluster security groups that are associated with the cluster.

cluster_snapshot_copy_status instance-attribute

cluster_snapshot_copy_status: NotRequired[AwsRedshiftClusterClusterSnapshotCopyStatus]

Information about the destination Region and retention period for the cross-Region snapshot copy.

cluster_status instance-attribute

cluster_status: NotRequired[NonEmptyString]

The current status of the cluster.

Valid values: 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 instance-attribute

cluster_subnet_group_name: NotRequired[NonEmptyString]

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 instance-attribute

cluster_version: NotRequired[NonEmptyString]

The version ID of the Amazon Redshift engine that runs on the cluster.

db_name instance-attribute

db_name: NotRequired[NonEmptyString]

The name of the initial database that was created when the cluster was created.

The same name is returned for the life of the cluster.

If an initial database is not specified, a database named devdev is created by default.

deferred_maintenance_windows instance-attribute

deferred_maintenance_windows: NotRequired[AwsRedshiftClusterDeferredMaintenanceWindows]

List of time windows during which maintenance was deferred.

elastic_ip_status instance-attribute

elastic_ip_status: NotRequired[AwsRedshiftClusterElasticIpStatus]

Information about the status of the Elastic IP (EIP) address.

elastic_resize_number_of_node_options instance-attribute

elastic_resize_number_of_node_options: NotRequired[NonEmptyString]

The number of nodes that you can use the elastic resize method to resize the cluster to.

encrypted instance-attribute

encrypted: NotRequired[Boolean]

Indicates whether the data in the cluster is encrypted at rest.

endpoint instance-attribute

endpoint: NotRequired[AwsRedshiftClusterEndpoint]

The connection endpoint.

enhanced_vpc_routing instance-attribute

enhanced_vpc_routing: NotRequired[Boolean]

Indicates whether to create the cluster with enhanced VPC routing enabled.

expected_next_snapshot_schedule_time instance-attribute

expected_next_snapshot_schedule_time: NotRequired[NonEmptyString]

Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

expected_next_snapshot_schedule_time_status instance-attribute

expected_next_snapshot_schedule_time_status: NotRequired[NonEmptyString]

The status of the next expected snapshot.

Valid values: OnTrack | Pending

hsm_status instance-attribute

hsm_status: NotRequired[AwsRedshiftClusterHsmStatus]

Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.

iam_roles instance-attribute

iam_roles: NotRequired[AwsRedshiftClusterIamRoles]

A list of IAM roles that the cluster can use to access other Amazon Web Services services.

kms_key_id instance-attribute

kms_key_id: NotRequired[NonEmptyString]

The identifier of the KMS encryption key that is used to encrypt data in the cluster.

logging_status instance-attribute

logging_status: NotRequired[AwsRedshiftClusterLoggingStatus]

Information about the logging status of the cluster.

maintenance_track_name instance-attribute

maintenance_track_name: NotRequired[NonEmptyString]

The name of the maintenance track for the cluster.

manual_snapshot_retention_period instance-attribute

manual_snapshot_retention_period: NotRequired[Integer]

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.

Valid values: Either -1 or an integer between 1 and 3,653

master_username instance-attribute

master_username: NotRequired[NonEmptyString]

The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.

next_maintenance_window_start_time instance-attribute

next_maintenance_window_start_time: NotRequired[NonEmptyString]

Indicates the start of the next maintenance window.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

node_type instance-attribute

node_type: NotRequired[NonEmptyString]

The node type for the nodes in the cluster.

number_of_nodes instance-attribute

number_of_nodes: NotRequired[Integer]

The number of compute nodes in the cluster.

pending_actions instance-attribute

pending_actions: NotRequired[StringList]

A list of cluster operations that are waiting to start.

pending_modified_values instance-attribute

pending_modified_values: NotRequired[AwsRedshiftClusterPendingModifiedValues]

A list of changes to the cluster that are currently pending.

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[NonEmptyString]

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

Format: :HH:MM-:HH:MM

For the day values, use mon | tue | wed | thu | fri | sat | sun

For example, sun:09:32-sun:10:02

publicly_accessible instance-attribute

publicly_accessible: NotRequired[Boolean]

Whether the cluster can be accessed from a public network.

resize_info instance-attribute

resize_info: NotRequired[AwsRedshiftClusterResizeInfo]

Information about the resize operation for the cluster.

restore_status instance-attribute

restore_status: NotRequired[AwsRedshiftClusterRestoreStatus]

Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.

snapshot_schedule_identifier instance-attribute

snapshot_schedule_identifier: NotRequired[NonEmptyString]

A unique identifier for the cluster snapshot schedule.

snapshot_schedule_state instance-attribute

snapshot_schedule_state: NotRequired[NonEmptyString]

The current state of the cluster snapshot schedule.

Valid values: MODIFYING | ACTIVE | FAILED

vpc_id instance-attribute

vpc_id: NotRequired[NonEmptyString]

The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

vpc_security_groups instance-attribute

vpc_security_groups: NotRequired[AwsRedshiftClusterVpcSecurityGroups]

The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.