class Aws::SecurityHub::Types::AwsRedshiftClusterDetails

Details about an Amazon Redshift cluster.

@note When making an API call, you may pass AwsRedshiftClusterDetails

data as a hash:

    {
      allow_version_upgrade: false,
      automated_snapshot_retention_period: 1,
      availability_zone: "NonEmptyString",
      cluster_availability_status: "NonEmptyString",
      cluster_create_time: "NonEmptyString",
      cluster_identifier: "NonEmptyString",
      cluster_nodes: [
        {
          node_role: "NonEmptyString",
          private_ip_address: "NonEmptyString",
          public_ip_address: "NonEmptyString",
        },
      ],
      cluster_parameter_groups: [
        {
          cluster_parameter_status_list: [
            {
              parameter_name: "NonEmptyString",
              parameter_apply_status: "NonEmptyString",
              parameter_apply_error_description: "NonEmptyString",
            },
          ],
          parameter_apply_status: "NonEmptyString",
          parameter_group_name: "NonEmptyString",
        },
      ],
      cluster_public_key: "NonEmptyString",
      cluster_revision_number: "NonEmptyString",
      cluster_security_groups: [
        {
          cluster_security_group_name: "NonEmptyString",
          status: "NonEmptyString",
        },
      ],
      cluster_snapshot_copy_status: {
        destination_region: "NonEmptyString",
        manual_snapshot_retention_period: 1,
        retention_period: 1,
        snapshot_copy_grant_name: "NonEmptyString",
      },
      cluster_status: "NonEmptyString",
      cluster_subnet_group_name: "NonEmptyString",
      cluster_version: "NonEmptyString",
      db_name: "NonEmptyString",
      deferred_maintenance_windows: [
        {
          defer_maintenance_end_time: "NonEmptyString",
          defer_maintenance_identifier: "NonEmptyString",
          defer_maintenance_start_time: "NonEmptyString",
        },
      ],
      elastic_ip_status: {
        elastic_ip: "NonEmptyString",
        status: "NonEmptyString",
      },
      elastic_resize_number_of_node_options: "NonEmptyString",
      encrypted: false,
      endpoint: {
        address: "NonEmptyString",
        port: 1,
      },
      enhanced_vpc_routing: false,
      expected_next_snapshot_schedule_time: "NonEmptyString",
      expected_next_snapshot_schedule_time_status: "NonEmptyString",
      hsm_status: {
        hsm_client_certificate_identifier: "NonEmptyString",
        hsm_configuration_identifier: "NonEmptyString",
        status: "NonEmptyString",
      },
      iam_roles: [
        {
          apply_status: "NonEmptyString",
          iam_role_arn: "NonEmptyString",
        },
      ],
      kms_key_id: "NonEmptyString",
      maintenance_track_name: "NonEmptyString",
      manual_snapshot_retention_period: 1,
      master_username: "NonEmptyString",
      next_maintenance_window_start_time: "NonEmptyString",
      node_type: "NonEmptyString",
      number_of_nodes: 1,
      pending_actions: ["NonEmptyString"],
      pending_modified_values: {
        automated_snapshot_retention_period: 1,
        cluster_identifier: "NonEmptyString",
        cluster_type: "NonEmptyString",
        cluster_version: "NonEmptyString",
        encryption_type: "NonEmptyString",
        enhanced_vpc_routing: false,
        maintenance_track_name: "NonEmptyString",
        master_user_password: "NonEmptyString",
        node_type: "NonEmptyString",
        number_of_nodes: 1,
        publicly_accessible: false,
      },
      preferred_maintenance_window: "NonEmptyString",
      publicly_accessible: false,
      resize_info: {
        allow_cancel_resize: false,
        resize_type: "NonEmptyString",
      },
      restore_status: {
        current_restore_rate_in_mega_bytes_per_second: 1.0,
        elapsed_time_in_seconds: 1,
        estimated_time_to_completion_in_seconds: 1,
        progress_in_mega_bytes: 1,
        snapshot_size_in_mega_bytes: 1,
        status: "NonEmptyString",
      },
      snapshot_schedule_identifier: "NonEmptyString",
      snapshot_schedule_state: "NonEmptyString",
      vpc_id: "NonEmptyString",
      vpc_security_groups: [
        {
          status: "NonEmptyString",
          vpc_security_group_id: "NonEmptyString",
        },
      ],
    }

@!attribute [rw] allow_version_upgrade

Indicates whether major version upgrades are applied automatically
to the cluster during the maintenance window.
@return [Boolean]

@!attribute [rw] automated_snapshot_retention_period

The number of days that automatic cluster snapshots are retained.
@return [Integer]

@!attribute [rw] availability_zone

The name of the Availability Zone in which the cluster is located.
@return [String]

@!attribute [rw] cluster_availability_status

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.
@return [String]

@!attribute [rw] cluster_create_time

Indicates when the cluster was created.

Uses the `date-time` format specified in [RFC 3339 section 5.6,
Internet Date/Time Format][1]. The value cannot contain spaces. For
example, `2020-03-22T13:22:13.933Z`.

[1]: https://tools.ietf.org/html/rfc3339#section-5.6
@return [String]

@!attribute [rw] cluster_identifier

The unique identifier of the cluster.
@return [String]

@!attribute [rw] cluster_nodes

The nodes in the cluster.
@return [Array<Types::AwsRedshiftClusterClusterNode>]

@!attribute [rw] cluster_parameter_groups

The list of cluster parameter groups that are associated with this
cluster.
@return [Array<Types::AwsRedshiftClusterClusterParameterGroup>]

@!attribute [rw] cluster_public_key

The public key for the cluster.
@return [String]

@!attribute [rw] cluster_revision_number

The specific revision number of the database in the cluster.
@return [String]

@!attribute [rw] cluster_security_groups

A list of cluster security groups that are associated with the
cluster.
@return [Array<Types::AwsRedshiftClusterClusterSecurityGroup>]

@!attribute [rw] cluster_snapshot_copy_status

Information about the destination Region and retention period for
the cross-Region snapshot copy.
@return [Types::AwsRedshiftClusterClusterSnapshotCopyStatus]

@!attribute [rw] cluster_status

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`
@return [String]

@!attribute [rw] cluster_subnet_group_name

The name of the subnet group that is associated with the cluster.
This parameter is valid only when the cluster is in a VPC.
@return [String]

@!attribute [rw] cluster_version

The version ID of the Amazon Redshift engine that runs on the
cluster.
@return [String]

@!attribute [rw] db_name

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.
@return [String]

@!attribute [rw] deferred_maintenance_windows

List of time windows during which maintenance was deferred.
@return [Array<Types::AwsRedshiftClusterDeferredMaintenanceWindow>]

@!attribute [rw] elastic_ip_status

Information about the status of the Elastic IP (EIP) address.
@return [Types::AwsRedshiftClusterElasticIpStatus]

@!attribute [rw] elastic_resize_number_of_node_options

The number of nodes that you can use the elastic resize method to
resize the cluster to.
@return [String]

@!attribute [rw] encrypted

Indicates whether the data in the cluster is encrypted at rest.
@return [Boolean]

@!attribute [rw] endpoint

The connection endpoint.
@return [Types::AwsRedshiftClusterEndpoint]

@!attribute [rw] enhanced_vpc_routing

Indicates whether to create the cluster with enhanced VPC routing
enabled.
@return [Boolean]

@!attribute [rw] expected_next_snapshot_schedule_time

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

Uses the `date-time` format specified in [RFC 3339 section 5.6,
Internet Date/Time Format][1]. The value cannot contain spaces. For
example, `2020-03-22T13:22:13.933Z`.

[1]: https://tools.ietf.org/html/rfc3339#section-5.6
@return [String]

@!attribute [rw] expected_next_snapshot_schedule_time_status

The status of the next expected snapshot.

Valid values: `OnTrack` \| `Pending`
@return [String]

@!attribute [rw] hsm_status

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.
@return [Types::AwsRedshiftClusterHsmStatus]

@!attribute [rw] iam_roles

A list of IAM roles that the cluster can use to access other Amazon
Web Services services.
@return [Array<Types::AwsRedshiftClusterIamRole>]

@!attribute [rw] kms_key_id

The identifier of the KMS encryption key that is used to encrypt
data in the cluster.
@return [String]

@!attribute [rw] maintenance_track_name

The name of the maintenance track for the cluster.
@return [String]

@!attribute [rw] manual_snapshot_retention_period

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
@return [Integer]

@!attribute [rw] master_username

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`.
@return [String]

@!attribute [rw] next_maintenance_window_start_time

Indicates the start of the next maintenance window.

Uses the `date-time` format specified in [RFC 3339 section 5.6,
Internet Date/Time Format][1]. The value cannot contain spaces. For
example, `2020-03-22T13:22:13.933Z`.

[1]: https://tools.ietf.org/html/rfc3339#section-5.6
@return [String]

@!attribute [rw] node_type

The node type for the nodes in the cluster.
@return [String]

@!attribute [rw] number_of_nodes

The number of compute nodes in the cluster.
@return [Integer]

@!attribute [rw] pending_actions

A list of cluster operations that are waiting to start.
@return [Array<String>]

@!attribute [rw] pending_modified_values

A list of changes to the cluster that are currently pending.
@return [Types::AwsRedshiftClusterPendingModifiedValues]

@!attribute [rw] preferred_maintenance_window

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

Format: ` <day>:HH:MM-<day>:HH:MM`

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

For example, `sun:09:32-sun:10:02`
@return [String]

@!attribute [rw] publicly_accessible

Whether the cluster can be accessed from a public network.
@return [Boolean]

@!attribute [rw] resize_info

Information about the resize operation for the cluster.
@return [Types::AwsRedshiftClusterResizeInfo]

@!attribute [rw] restore_status

Information about the status of a cluster restore action. Only
applies to a cluster that was created by restoring a snapshot.
@return [Types::AwsRedshiftClusterRestoreStatus]

@!attribute [rw] snapshot_schedule_identifier

A unique identifier for the cluster snapshot schedule.
@return [String]

@!attribute [rw] snapshot_schedule_state

The current state of the cluster snapshot schedule.

Valid values: `MODIFYING` \| `ACTIVE` \| `FAILED`
@return [String]

@!attribute [rw] vpc_id

The identifier of the VPC that the cluster is in, if the cluster is
in a VPC.
@return [String]

@!attribute [rw] vpc_security_groups

The list of VPC security groups that the cluster belongs to, if the
cluster is in a VPC.
@return [Array<Types::AwsRedshiftClusterVpcSecurityGroup>]

@see docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsRedshiftClusterDetails AWS API Documentation

Constants

SENSITIVE