You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecurityHub::Types::AwsRedshiftClusterDetails

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AwsRedshiftClusterDetails as input to an Aws::Client method, you can use a vanilla 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",
    },
  ],
}

Details about an Amazon Redshift cluster.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allow_version_upgrade ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#automated_snapshot_retention_period ⇒ Integer

The number of days that automatic cluster snapshots are retained.

Returns:

  • (Integer) —

    The number of days that automatic cluster snapshots are retained.

#availability_zone ⇒ String

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

Returns:

  • (String) —

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

#cluster_availability_status ⇒ String

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.

Returns:

  • (String) —

    The availability status of the cluster for queries.

#cluster_create_time ⇒ String

Indicates when the cluster was created.

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

Returns:

  • (String) —

    Indicates when the cluster was created.

#cluster_identifier ⇒ String

The unique identifier of the cluster.

Returns:

  • (String) —

    The unique identifier of the cluster.

#cluster_nodes ⇒ Array<Types::AwsRedshiftClusterClusterNode>

The nodes in the cluster.

Returns:

#cluster_parameter_groups ⇒ Array<Types::AwsRedshiftClusterClusterParameterGroup>

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

Returns:

#cluster_public_key ⇒ String

The public key for the cluster.

Returns:

  • (String) —

    The public key for the cluster.

#cluster_revision_number ⇒ String

The specific revision number of the database in the cluster.

Returns:

  • (String) —

    The specific revision number of the database in the cluster.

#cluster_security_groups ⇒ Array<Types::AwsRedshiftClusterClusterSecurityGroup>

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

Returns:

#cluster_snapshot_copy_status ⇒ Types::AwsRedshiftClusterClusterSnapshotCopyStatus

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

Returns:

#cluster_status ⇒ String

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

Returns:

  • (String) —

    The current status of the cluster.

#cluster_subnet_group_name ⇒ String

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

Returns:

  • (String) —

    The name of the subnet group that is associated with the cluster.

#cluster_version ⇒ String

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

Returns:

  • (String) —

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

#db_name ⇒ String

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.

Returns:

  • (String) —

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

#deferred_maintenance_windows ⇒ Array<Types::AwsRedshiftClusterDeferredMaintenanceWindow>

List of time windows during which maintenance was deferred.

Returns:

#elastic_ip_status ⇒ Types::AwsRedshiftClusterElasticIpStatus

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

Returns:

#elastic_resize_number_of_node_options ⇒ String

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

Returns:

  • (String) —

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

#encrypted ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#endpoint ⇒ Types::AwsRedshiftClusterEndpoint

The connection endpoint.

Returns:

#enhanced_vpc_routing ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#expected_next_snapshot_schedule_time ⇒ String

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. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    Indicates when the next snapshot is expected to be taken.

#expected_next_snapshot_schedule_time_status ⇒ String

The status of the next expected snapshot.

Valid values: OnTrack | Pending

Returns:

  • (String) —

    The status of the next expected snapshot.

#hsm_status ⇒ Types::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.

Returns:

  • (Types::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 ⇒ Array<Types::AwsRedshiftClusterIamRole>

A list of IAM roles that the cluster can use to access other AWS services.

Returns:

#kms_key_id ⇒ String

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

Returns:

  • (String) —

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

#maintenance_track_name ⇒ String

The name of the maintenance track for the cluster.

Returns:

  • (String) —

    The name of the maintenance track for the cluster.

#manual_snapshot_retention_period ⇒ 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

Returns:

  • (Integer) —

    The default number of days to retain a manual snapshot.

#master_username ⇒ String

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.

Returns:

  • (String) —

    The master user name for the cluster.

#next_maintenance_window_start_time ⇒ String

Indicates the start of the next maintenance window.

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

Returns:

  • (String) —

    Indicates the start of the next maintenance window.

#node_type ⇒ String

The node type for the nodes in the cluster.

Returns:

  • (String) —

    The node type for the nodes in the cluster.

#number_of_nodes ⇒ Integer

The number of compute nodes in the cluster.

Returns:

  • (Integer) —

    The number of compute nodes in the cluster.

#pending_actions ⇒ Array<String>

A list of cluster operations that are waiting to start.

Returns:

  • (Array<String>) —

    A list of cluster operations that are waiting to start.

#pending_modified_values ⇒ Types::AwsRedshiftClusterPendingModifiedValues

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

Returns:

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) —

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

#publicly_accessible ⇒ Boolean

Whether the cluster can be accessed from a public network.

Returns:

  • (Boolean) —

    Whether the cluster can be accessed from a public network.

#resize_info ⇒ Types::AwsRedshiftClusterResizeInfo

Information about the resize operation for the cluster.

Returns:

#restore_status ⇒ Types::AwsRedshiftClusterRestoreStatus

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

Returns:

#snapshot_schedule_identifier ⇒ String

A unique identifier for the cluster snapshot schedule.

Returns:

  • (String) —

    A unique identifier for the cluster snapshot schedule.

#snapshot_schedule_state ⇒ String

The current state of the cluster snapshot schedule.

Valid values: MODIFYING | ACTIVE | FAILED

Returns:

  • (String) —

    The current state of the cluster snapshot schedule.

#vpc_id ⇒ String

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

Returns:

  • (String) —

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

#vpc_security_groups ⇒ Array<Types::AwsRedshiftClusterVpcSecurityGroup>

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

Returns: